A type alias for a general area config.
A type alias for the layout fit policy.
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.
Some layout implementations may ignore the fit policy.
A type alias for the horizontal alignment of a widget.
A type alias for the supported insertion modes.
An insert mode is used to specify how a widget should be added to the dock layout relative to a reference widget.
A type alias for the vertical alignment of a widget.
Construct a new dock layout.
The options for initializing the layout.
The renderer used by the dock layout.
Get the fit policy for the layout.
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.
Some layout implementations may ignore the fit policy.
Set the fit policy for the layout.
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.
Some layout implementations may ignore the fit policy.
Changing the fit policy will clear the current size constraint for the parent widget and then re-fit the parent.
The method for hiding child widgets.
If there is only one child widget, Display
hiding mode will be used
regardless of this setting.
The method for hiding child widgets.
If there is only one child widget, Display
hiding mode will be used
regardless of this setting.
Test whether the layout is disposed.
Whether the dock layout is empty.
Get the parent widget of the layout.
This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.
Set the parent widget of the layout.
This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.
Get the inter-element spacing for the dock layout.
Set the inter-element spacing for the dock layout.
Create a new handle for the dock layout.
The handle will be attached to the parent if it exists.
Fit the layout to the total size required by the widgets.
Ensure the root is a split node with the given orientation.
Update the layout position and size of the widgets.
The parent offset dimensions should be -1
if unknown.
Add a widget to the dock layout.
The widget to add to the dock layout.
The additional options for adding the widget.
The widget will be moved if it is already contained in the layout.
An error will be thrown if the reference widget is invalid.
Attach the widget to the layout parent widget.
Detach the widget from the layout parent widget.
Dispose of the resources held by the layout.
This will clear and dispose all widgets in the layout.
Create an iterator over the handles in the layout.
A new iterator over the handles in the layout.
Find the tab area which contains the given client position.
The client X position of interest.
The client Y position of interest.
The geometry of the tab area at the given position, or
null
if there is no tab area at the given position.
Perform layout initialization which requires the parent widget.
Move a handle to the given offset position.
The handle to move.
The desired offset X position of the handle.
The desired offset Y position of the handle.
If the given handle is not contained in the layout, this is no-op.
The handle will be moved as close as possible to the desired position without violating any of the layout constraints.
Only one of the coordinates is used depending on the orientation of the handle. This method accepts both coordinates to make it easy to invoke from a mouse move event without needing to know the handle orientation.
A message handler invoked on an 'after-attach'
message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-detach'
message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-hide'
message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-show'
message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-attach'
message.
A message handler invoked on a 'before-detach'
message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-hide'
message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-show'
message.
A message handler invoked on a 'child-hidden'
message.
A message handler invoked on a 'child-removed'
message.
This will remove the child widget from the layout.
Subclasses should not typically reimplement this method.
A message handler invoked on a 'child-shown'
message.
A message handler invoked on a 'fit-request'
message.
A message handler invoked on a 'resize'
message.
A message handler invoked on an 'update-request'
message.
Process a message sent to the parent widget.
The message sent to the parent widget.
This method is called by the parent widget to process a message.
Subclasses may reimplement this method as needed.
Remove a widget from the layout.
The widget to remove from the layout.
A widget is automatically removed from the layout when its parent
is set to null
. This method should only be invoked directly when
removing a widget from a layout which has yet to be installed on a
parent widget.
This method does not modify the widget's parent
.
Restore the layout to a previously saved configuration.
The layout configuration to restore.
Widgets which currently belong to the layout but which are not contained in the config will be unparented.
Save the current configuration of the dock layout.
A new config object for the current layout state.
The return value can be provided to the restoreLayout
method
in order to restore the layout to its current configuration.
Get the horizontal alignment for a widget.
The widget of interest.
The horizontal alignment for the widget.
If the layout width allocated to a widget is larger than its max width, the horizontal alignment controls how the widget is placed within the extra horizontal space.
If the allocated width is less than the widget's max width, the horizontal alignment has no effect.
Some layout implementations may ignore horizontal alignment.
Get the vertical alignment for a widget.
The widget of interest.
The vertical alignment for the widget.
If the layout height allocated to a widget is larger than its max height, the vertical alignment controls how the widget is placed within the extra vertical space.
If the allocated height is less than the widget's max height, the vertical alignment has no effect.
Some layout implementations may ignore vertical alignment.
Set the horizontal alignment for a widget.
The widget of interest.
The value for the horizontal alignment.
If the layout width allocated to a widget is larger than its max width, the horizontal alignment controls how the widget is placed within the extra horizontal space.
If the allocated width is less than the widget's max width, the horizontal alignment has no effect.
Some layout implementations may ignore horizontal alignment.
Changing the horizontal alignment will post an update-request
message to widget's parent, provided the parent has a layout
installed.
Set the vertical alignment for a widget.
The widget of interest.
The value for the vertical alignment.
If the layout height allocated to a widget is larger than its max height, the vertical alignment controls how the widget is placed within the extra vertical space.
If the allocated height is less than the widget's max height, the vertical alignment has no effect.
Some layout implementations may ignore vertical alignment.
Changing the horizontal alignment will post an update-request
message to widget's parent, provided the parent has a layout
installed.
Generated using TypeDoc
A layout which provides a flexible docking arrangement. The namespace for the
DockLayout
class statics.Notes
The consumer of this layout is responsible for handling all signals from the generated tab bars and managing the visibility of widgets and tab bars as needed.