IC8 Python API:RLPy RIDockWidget

From Reallusion Wiki!
Jump to: navigation, search

Description

Provides dock widget related functions such as creating dock widgets and dock-able window related properties. It also allows the registration and unregistration of dock widget callback events.

Constructor & Destructor

__init__ (self, *args, **kwargs)

Initializes a new ri dock widget instance.

Parameters

  • args
  • kwargs

Member Functions

Close (self)

Close this dock widget and release it from system memory. See Also: Show, Hide

Features (self)

Get all of the feature flags applied to this dock widget. See also: SetFeatures

GetTitle (self)

Get the QWidget address of this dock widget's title-bar, which can be used to deploy PySide operations.

GetWindow (self)

Get the QWidget address of this dock widget, which can be used to create a PySide representation and later accomodate a Qt ui or qml file.

GetWindowTitle (self)

Get this dock widget's title-bar label text. See Also: SetWindowTitle

Hide (self)

Hide this dock widget, but keep it in system memory. See Also: Show, Close

IsAreaAllowed (self, eArea)

Check if this dock widget can be docked into a certain region of the application. See Also: SetAllowedAreas

Parameters

  • eArea

IsFloating (self)

Check if this dock widget is floating (not docked to the application's main window). See also: SetFloating

IsVisible (self)

Check whether if this dock widget is visible or not. See Also: Show, Hide, Close

RegisterEventCallback (self, pfCallback)

Register a RDialogCallback to this dock widget and return its ID. See Also: UnregisterEventCallback, UnregisterEventCallbacks

Parameters

  • pfCallback

RegisterNativeEventCallback (self, pfCallback)

Register a RWinMessageCallback with this dock widget and returns its ID. See Also: UnregisterNativeEventCallback, UnregisterNativeEventCallbacks

Parameters

  • pfCallback

SetAllowedAreas (self, eArea)

Set the dockable areas for this dock widget. Bit-wise operations can be used to combine and exclude different dock-able areas See Also: IsAreaAllowed

Parameters

  • eArea

SetFeatures (self, eFeatures)

Allow this dock widget to be movable, closable, and floatable. The feature parameter can be treated with bit-wise operations. The available RLPy.EDockWidgetFeatures match those inside PySide2.QtCore.Qt. See Also: Features

Parameters

  • eFeatures

SetFloating (self, bFloating)

Set the floating state of this dock widget. Currently, only a value of True takes effect. See Also: IsFloating

Parameters

  • bFloating

SetParent (self, pWidget)

Set the parent widget for this dock widget according to its window address. Currently, the main window is the only viable option as the parent widget.

Parameters

  • pWidget

SetWidget (self, pWidget)

Insert another widget into this dock widget, by way of its window address, into this dock widget.

Parameters

  • pWidget

SetWindowTitle (self, strTitleName)

Set the label text for this dock widget's title-bar.

Parameters

  • strTitleName

Show (self)

Make this dock widget visible. See Also: Hide, Close

UnregisterAllEventCallbacks (self)

Unregister all RDialogCallback on this dock widget See Also: RegisterEventCallback, UnregisterEventCallback, UnregisterEventCallbacks

UnregisterEventCallback (self, uId)

Unregister a RDialogCallback from this dock widget. See Also: RegisterEventCallback, UnregisterEventCallbacks

Parameters

  • uId

UnregisterEventCallbacks (self, kIds)

Unregister a collection of RDialogCallback from this dock widget. If unregistration of one of the callbacks fails, it will still attempt to unregister the rest. See Also: RegisterEventCallback, UnregisterEventCallback, UnregisterEventCallbacks

Parameters

  • kIds

UnregisterNativeEventCallback (self, uId)

Unregister a RWinMessageCallback from this dock widget. See Also: RegisterNativeEventCallback, UnregisterNativeEventCallbacks

Parameters

  • uId

UnregisterNativeEventCallbacks (self, kIds)

Unregister a collection of RWinMessageCallback from this dock widget. If unregistration of one of the callbacks fails, it will still attempt to unregister the rest. See Also: RegisterNativeEventCallback, UnregisterNativeEventCallback

Parameters

  • kIds

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RIDockWidget&oldid=6160"