WindowSplitter Xojo Plugin

DesktopWindowSplitter Control

WindowSplitter control to create split views on windows.

This version of the control is for new style Xojo DesktopWindow class.

DesktopUIControl
   DesktopWindowSplitter

control DesktopWindowSplitter

Properties

CursorSmoothingTurns on or off CursorSmoothing
DebugGetDataSizeUsed for internal quality control of the plugin.
DockAfterSetting this property to true will make the WindowSplitter dock after the splitter (dock to bottom or right depending on if its a horizontal or vertical splitter).
DockAfterSizeSetting this property will define where docking bellow or after the splitter shall happen.
DockBeforeSetting this property to true will make the WindowSplitter dock before the splitter (dock to top or left depending on if its a horizontal or vertical splitter).
DockBeforeSizeSetting this property will define where docking over or before the splitter shall happen.
DoubleClickActionUse this property to set action for double click.
Enabled (Inherited) Determines if the control should be enabled when the owning window is opened.
Handle (Inherited) Returns a handle to the control.
Height (Inherited) The height (in points) of the control.
Index (Inherited) If the control is used in a control set, this specifies the control's index in the set.
IsDockedUse this property to query if the Splitter is docked.
Left (Inherited) The left side of the control in local coordinates (relative to the window)
LinuxStyleThis property is used to specify the style of the marker on the WindowSplitter on Linux systems.
MacStyleThis property is used to specify the style of the marker on the WindowSplitter on MacOS systems.
MinAfterAreaThis property is used to specify the minimum size of the view that comes after the WindowSplitter.
MinBeforeAreaThis property is used to specify the minimum size of the view that comes before the WindowSplitter.
PositionThis property is used to save and restore the location of the WindowSplitter.
Top (Inherited) The top of the control in local coordinates (relative to the window).
Visible (Inherited) Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
Width (Inherited) The width (in points) of the control.
WinLiveMoveSetting this property to true will make the WindowSplitter go in LiveMove mode on Windows systems.
WinStyleThis property is used to specify the style of the marker on the WindowSplitter on Windows systems.
Window (Inherited) The control's parent window.

Methods

AddControlUse this method to add container controls to a list of controls that the WindowSplitter will internally manage. Once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves.
AddControlUse this method to add container controls to a list of controls that the WindowSplitter will internally manage. Once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves.
AddControlUse this method to add controls to a list of controls that the WindowSplitter will internally manage. Once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves.
AddControlUse this method to add controls to a list of controls that the WindowSplitter will internally manage. Once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves.
AddControlNoResizeThis method does the same as AddControl, except this method does not let the WindowSplitter manage resize for the control you assign to it. That is it will only move controls around. This variation of the AddControlNoResize is for container controls.
AddControlNoResizeThis method does the same as AddControl, except this method does not let the WindowSplitter manage resize for the control you assign to it. That is it will only move controls around. This variation of the AddControlNoResize is for container controls.
AddControlNoResizeThis method does the same as AddControl, except this method does not let the WindowSplitter manage resize for the control you assign to it. That is it will only move controls around.
AddControlNoResizeThis method does the same as AddControl, except this method does not let the WindowSplitter manage resize for the control you assign to it. That is it will only move controls around.
AddUnmanagedControlUse this method to add controls to a list of controls that the WindowSplitter will internally manage. That is once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves. (This method is intended for TabPanels and PagePanels, use the AddControl method for other controls).
AddUnmanagedControlUse this method to add controls to a list of controls that the WindowSplitter will internally manage. That is once you have told the WindowSplitter about controls that should be affected by the splitter movement then the WindowSplitter will take care of resizing and moving them when the WindowSplitter moves. (This method is intended for TabPanels and PagePanels, use the AddControl method for other controls).
Close (Inherited) Closes a control.
DockUse this method to dock the Splitter from a code.
GetNextUse this function to access the internal control vector of the WindowSplitter.
HasNextUse this function to access the internal control vector of the WindowSplitter.
MoveFirstThis function resets the iterator to its initial position.
NextIsBeforeThis function returns true if the next control in the iterator is placed before the WindowSplitter. (above if its a Horizontal splitter and to the left if its a Vertical splitter).
PeekNextUse this function to access the internal control vector of the WindowSplitter without causing iteration.
RemoveControlRemoves a container control from the splitter.
RemoveControlRemoves a container control from the splitter.
RemoveControlRemoves a control from the splitter.
RemoveControlRemoves a control from the splitter.
SetFocus (Inherited) If applicable, sets the focus to the DesktopUIControl. KeyDown events are directed to the control.
UndockUse this method to dock to undock the splitter.

Events

ChangeMouseCursorUse this event to use customized Mouse Cursors.
Closing (Inherited) The control is about to close.
ConstructContextualMenu (Inherited) This event is called when it is appropriate to display a contextual menu for the control.
ContextualMenuItemSelected (Inherited) Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the DesktopMenuItem did not handle the menu selection.
DockedThis event is fired when the window splitter docks.
DragEnter (Inherited) Fires when the passed DragItem enters the DesktopUIControl.
DragExit (Inherited) Fires when the passed DragItem exits the DesktopUIControl.
DragOver (Inherited) Fires when the DragItem is over the DesktopUIControl.
DropObject (Inherited) The item represented by Obj has been dropped on the control.
HitTestIf you want to alter the behaviour of the "hot point" where the Window Splitter responds to Mouse Click then put code in this event and return true when your code has determined that the mouse is in correct position for the splitter to take action and return false if not.
InitialPositionIf you are restoring the position of the WindowSplitter from a preference file then here is the place to do it, by using the position property within this event.
KeyDown (Inherited) The user has pressed the Key passed while the control has the focus.
KeyUp (Inherited) Fires when the passed Key is released in the control that has the focus.
MouseDownThis event is fired when the mouse is pressed on the WindowSplitter.
MouseDrag (Inherited) The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y. The user has moved the mouse inside the control while the mouse button is held down. This event handler receives parameters that indicate where the mouse is in coordinates local to the control.
MouseEnter (Inherited) The mouse has entered the area of the control.
MouseExit (Inherited) The mouse has left the area of the control.
MouseUpThis event is fired when the mouse is released on the WindowSplitter.
MouseWheel (Inherited) The mouse wheel has been moved.
OpeningThe window is about to open. Use this event to initialize a control.
PaintThis event is fired when the splitter is painting it self. To Custom render the splitter then use this event. To Make the splitter not do default rendering before throwing the paint event then set the DrawMarker property to false.
SplitterMovedThis event is fired when a splitter has moved.
UndockedThis event is fired when the window splitter undocks.

Constants

Version = 13.0

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit