Panel

Panel widget is the container for other widgets with scrolling, resizing, allow change placement by drag and drop.

}

Constructors

this this(string style): Undocumented in source.

Members

Enums

Background enum Background: Undocumented in source.

Functions

borderScrollToWidget void borderScrollToWidget(Widget widget): Undocumented in source. Be warned that the author may not have intended to support it.
close void close(): Undocumented in source. Be warned that the author may not have intended to support it.
handleResize void handleResize(): Undocumented in source. Be warned that the author may not have intended to support it.
headerOnProgress void headerOnProgress(): Undocumented in source. Be warned that the author may not have intended to support it.
onCreate void onCreate(): Undocumented in source. Be warned that the author may not have intended to support it.
onCursor void onCursor(): Change system cursor when mouse entering split.
onMouseDown void onMouseDown(MouseDownEvent event): Handle mouse down event - avoid it if UI is forzen.
onMouseUp void onMouseUp(MouseUpEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onMouseWheelHandle void onMouseWheelHandle(int dx, int dy): Undocumented in source. Be warned that the author may not have intended to support it.
onProgress void onProgress(ProgressEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onRender void onRender(): Undocumented in source. Be warned that the author may not have intended to support it.
onResize void onResize(): Undocumented in source. Be warned that the author may not have intended to support it.
open void open(): Undocumented in source. Be warned that the author may not have intended to support it.
renderChildren void renderChildren(): Undocumented in source. Be warned that the author may not have intended to support it.
scrollByPx void scrollByPx(float dx, float dy): Add value to scroll in px.
scrollToPercent void scrollToPercent(float x, float y): Set scroll value in percent.
scrollToPx void scrollToPx(float x, float y): Set scroll value in px.
scrollToWidget void scrollToWidget(Widget widget): Undocumented in source. Be warned that the author may not have intended to support it.
toggle void toggle(): Toggle visibility of panel. If isOpen then method will close panel else open.
updateInnerOffset void updateInnerOffset(): Add extra inner offset depends of which elements are visible.
updateSize void updateSize(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

headerState inout(State) headerState [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
splitRegionAlign inout(RegionAlign) splitRegionAlign [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Structs

Header struct Header: Undocumented in source.
Measure struct Measure: Undocumented in source.
Split struct Split: Undocumented in source.

Variables

background Background background;: Background color of panel.
caption utf32string caption;: Undocumented in source.
darkSplit bool darkSplit;: If true, then panel split will be dark.
header Header header;: Undocumented in source.
horizontalScrollButton ScrollButton horizontalScrollButton;: Undocumented in source.
isOpen bool isOpen;: If true, then panel is open and will be rendered all content else only header.
maxSize float maxSize;: Maximum size of panel.
measure Measure measure;: Undocumented in source.
minSize float minSize;: Minimum size of panel.
showHorizontalScrollButton bool showHorizontalScrollButton;: Undocumented in source.
showSplit bool showSplit;: If true, render panel split else no.
showVerticalScrollButton bool showVerticalScrollButton;: Undocumented in source.
split Split split;: Undocumented in source.
splitAlign RegionAlign splitAlign;: Undocumented in source.
themeLoader PanelThemeLoader themeLoader;: Undocumented in source.
userCanDrag bool userCanDrag;: Undocumented in source.
userCanHide bool userCanHide;: Undocumented in source.
userCanResize bool userCanResize;: Undocumented in source.
verticalScrollButton ScrollButton verticalScrollButton;: Undocumented in source.

Inherited Members

SizeType enum SizeType: Type of sizing for width and height.
field struct field: Field attribute need to tell RPDL which fields are fill when reading layout file.
isVisible bool isVisible;: Undocumented in source.
isEnabled bool isEnabled;: Undocumented in source.
focusable bool focusable;: Undocumented in source.
finalFocus bool finalFocus;: If true, then focus navigation by children will be limited inside this widget.
cursor CursorIcon cursor;: Specifies the type of cursor to be displayed when pointing on an element.
name string name;: Undocumented in source.
hint utf32string hint;: Some help information about widget, need to display tooltip.
locationAlign Align locationAlign;: How to place a widget horizontally.
verticalLocationAlign VerticalAlign verticalLocationAlign;: How to place a widget vertically.
regionAlign RegionAlign regionAlign;: If set this option then widget will be pinned to one of the side declared in the basic_types.RegionAlign.
margin FrameRect margin;: Used to create space around elements, outside of any defined borders.
padding FrameRect padding;: Used to generate space around an element's content, inside of any defined borders.
position vec2 position;: Undocumented in source.
size vec2 size;: Undocumented in source.
widthType SizeType widthType;: Determine how to set width for widget.
heightType SizeType heightType;: Determine how to set height for widget.
width float width [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
width float width [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
height float height [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
height float height [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
left float left [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
left float left [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
top float top [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
top float top [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
id size_t id [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
style string style;: Widget root rpdl node from where the data will be extracted.
parent Widget parent [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
p_parent Widget p_parent;: Undocumented in source.
owner Widget owner;: Undocumented in source.
isFocused inout(bool) isFocused [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
p_isFocused bool p_isFocused;: Undocumented in source.
nextWidget Widget nextWidget [@property getter]: Next widget in parent children after this.
p_nextWidget Widget p_nextWidget;: Undocumented in source.
prevWidget Widget prevWidget [@property getter]: Previous widget in parent children before this.
p_prevWidget Widget p_prevWidget;: Undocumented in source.
lastWidget Widget lastWidget [@property getter]: Last widget in parent children.
p_lastWidget Widget p_lastWidget;: Undocumented in source.
firstWidget Widget firstWidget [@property getter]: First widget in parent children.
p_firstWidget Widget p_firstWidget;: Undocumented in source.
children WidgetsContainer children [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
depth uint depth [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
p_depth uint p_depth;: Undocumented in source.
resolver WidgetResolver resolver [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
focusNavigator FocusNavigator focusNavigator [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
events WidgetEventsObserver events [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
visibleRules Array!(bool delegate()) visibleRules;: Additional rules appart from isVisible to set widget visible or not.
enableRules Array!(bool delegate()) enableRules;: Additional rules appart from enabled to set widget enabled or not.
PartDraws enum PartDraws: Which part of widget need to render, e.g. if it is a button then PartDraws.left tell that only left side and center will be rendered, this need for grouping rendering of widgets.
partDraws PartDraws partDraws;: Undocumented in source.
view View view [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
view_ View view_;: Undocumented in source.
skipFocus bool skipFocus;: Don't focus this element.
drawChildren bool drawChildren;: Undocumented in source.
extraInnerOffset FrameRect extraInnerOffset;: Extra inner offset besides padding.
extraOuterOffset FrameRect extraOuterOffset;: Extra outer offset besides margin.
overlay bool overlay;: Undocumented in source.
overSize vec2 overSize;: Undocumented in source.
overlayRect Rect overlayRect;: Undocumented in source.
focusOnMousUp bool focusOnMousUp;: Undocumented in source.
isEnter bool isEnter;: True if pointed on widget.
overrideIsEnter bool overrideIsEnter;: Override isEnter state i.e. ignore isEnter value and use overrided value.
isClick bool isClick;: Undocumented in source.
isMouseDown bool isMouseDown;: Undocumented in source.
locator WidgetLocator locator;: Undocumented in source.
renderer Renderer renderer;: Undocumented in source.
isOver bool isOver;: When in rect of element but if another element over this isOver will still be true.
absolutePosition inout(vec2) absolutePosition [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
absolutePosition_ vec2 absolutePosition_;: Undocumented in source.
innerBoundarySizeClamped vec2 innerBoundarySizeClamped;: Size of boundary over childern clamped to size of widget as minimum boundary size.
innerBoundarySize vec2 innerBoundarySize;: Size of boundary over childern.
contentOffset vec2 contentOffset;: Children offset relative their absolute positions.
outerBoundarySize vec2 outerBoundarySize;: Full region size including inner offsets.
associatedWidget Widget associatedWidget;: Undocumented in source.
state inout(State) state [@property getter]: Returns string of state declared in theme.
innerSize vec2 innerSize [@property getter]: Inner size considering the extra innter offsets and paddings.
innerOffsetSize vec2 innerOffsetSize [@property getter]: Total inner offset size (width and height) considering the extra inner offsets and paddings.
innerOffset FrameRect innerOffset [@property getter]: Inner padding plus and extra inner offsets.
extraInnerOffsetSize vec2 extraInnerOffsetSize [@property getter]: Total size of extra inner offset (width and height).
extraInnerOffsetStart vec2 extraInnerOffsetStart [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
extraInnerOffsetEnd vec2 extraInnerOffsetEnd [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
innerOffsetStart vec2 innerOffsetStart [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
innerOffsetEnd vec2 innerOffsetEnd [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
outerSize vec2 outerSize [@property getter]: Outer size considering the extra outer offsets and margins.
outerOffsetSize vec2 outerOffsetSize [@property getter]: Total outer offset size (width and height) considering the extra outer offsets and margins.
outerOffset FrameRect outerOffset [@property getter]: Total outer offset - margins plus extra outer offsets.
outerOffsetStart vec2 outerOffsetStart [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
outerOffsetEnd vec2 outerOffsetEnd [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onProgress void onProgress(ProgressEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
updateBoundary void updateBoundary(): Update widget inner bounary and clamped boundary.
checkRules void checkRules(): Undocumented in source. Be warned that the author may not have intended to support it.
reset void reset(): Undocumented in source. Be warned that the author may not have intended to support it.
getNonDecoratorParent Widget getNonDecoratorParent(): Undocumented in source. Be warned that the author may not have intended to support it.
resetChildren void resetChildren(): Undocumented in source. Be warned that the author may not have intended to support it.
collectOnProgressQueries void collectOnProgressQueries(): Undocumented in source. Be warned that the author may not have intended to support it.
processPorgress bool processPorgress(): Undocumented in source. Be warned that the author may not have intended to support it.
onRender void onRender(): Render widget in camera view.
renderChildren void renderChildren(): Undocumented in source. Be warned that the author may not have intended to support it.
focus void focus(): Make focus for widget, and clear focus from focused widget.
blur void blur(): Clear focus from widget
onCreate void onCreate(): Undocumented in source. Be warned that the author may not have intended to support it.
onPostCreate void onPostCreate(): Undocumented in source. Be warned that the author may not have intended to support it.
onMouseMove void onMouseMove(MouseMoveEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onMouseUp void onMouseUp(MouseUpEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onFocus void onFocus(FocusEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onBlur void onBlur(BlurEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onCursor void onCursor(): Override this method if need change behaviour when system cursor have to be changed.
onResize void onResize(): Undocumented in source. Be warned that the author may not have intended to support it.
onClickActionInvoked void onClickActionInvoked(): Undocumented in source. Be warned that the author may not have intended to support it.
pointIsEnter bool pointIsEnter(vec2i point): Determine if point is inside widget area.
updateSize void updateSize(): This method invokes when widget size is updated.
updateAll void updateAll(): Recalculate size and position of widget and children widgets.
freezeUI void freezeUI(bool isNestedFreeze): Undocumented in source. Be warned that the author may not have intended to support it.
unfreezeUI void unfreezeUI(): Undocumented in source. Be warned that the author may not have intended to support it.
isFrozen bool isFrozen(): Undocumented in source. Be warned that the author may not have intended to support it.
isFreezingSource bool isFreezingSource(): Undocumented in source. Be warned that the author may not have intended to support it.

borderScrollToWidget void borderScrollToWidget(Widget widget): Scroll to widget if it out of visible region. Scroll on top border if widget above and bottom if below visible region.

Panel

Constructors

Members

Enums

Functions

Properties

Structs

Variables

Inherited Members

From Widget

From FocusScrollNavigation

Meta

Source