Property | Type | Description | |
---|---|---|---|
m_InnerPanel | Control |
Property | Type | Description | |
---|---|---|---|
DefaultAcceleratorHandler | void | ||
DoRender | void | ||
HandleAccelerator | bool | ||
InputChar | bool | ||
InputCopy | void | ||
InputCut | void | ||
InputKeyPressed | bool | ||
InputMouseClickedLeft | void | ||
InputMouseClickedRight | void | ||
InputMouseDoubleClickedLeft | void | ||
InputMouseDoubleClickedRight | void | ||
InputMouseEntered | void | ||
InputMouseLeft | void | ||
InputMouseMoved | void | ||
InputMouseWheeled | bool | ||
InputPaste | void | ||
InputSelectAll | void |
Method | Description | |
---|---|---|
AddAccelerator ( String accelerator ) : void |
Adds keyboard accelerator with a default handler.
|
|
AddAccelerator ( String accelerator, GwenEventHandler handler ) : void |
Adds keyboard accelerator.
|
|
AddChild ( Control child ) : void |
Attaches specified control as a child of this one. If InnerPanel is not null, it will become the parent. |
|
Anim_HeightIn ( float length, float delay, float ease ) : void | ||
Anim_HeightOut ( float length, bool hide, float delay, float ease ) : void | ||
Anim_WidthIn ( float length, float delay = 0.0f, float ease = 1.0f ) : void | ||
Anim_WidthOut ( float length, bool hide, float delay, float ease ) : void | ||
Blur ( ) : void |
Unfocuses the control.
|
|
BringNextToControl ( Control child, bool behind ) : void | ||
BringToFront ( ) : void |
Brings the control to the top of paren't visibility stack.
|
|
CanvasPosToLocal ( Vector2i pnt ) : Vector2i |
Converts canvas coordinates to local coordinates.
|
|
CloseMenus ( ) : void |
Closes all menus recursively.
|
|
Control ( Control parent ) : System |
Initializes a new instance of the Control class.
|
|
DelayedDelete ( ) : void |
Detaches the control from canvas and adds to the deletion queue (processed in Canvas.DoThink).
|
|
DeleteAllChildren ( ) : void |
Removes all children (and disposes them).
|
|
Disable ( ) : void |
Disables the control.
|
|
Dispose ( ) : void |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
DragAndDrop_CanAcceptPackage ( DragDrop p ) : bool | ||
DragAndDrop_Draggable ( ) : bool | ||
DragAndDrop_EndDragging ( bool success, int x, int y ) : void | ||
DragAndDrop_GetPackage ( int x, int y ) : DragDrop.Package | ||
DragAndDrop_HandleDrop ( DragDrop p, int x, int y ) : bool | ||
DragAndDrop_Hover ( DragDrop p, int x, int y ) : void | ||
DragAndDrop_HoverEnter ( DragDrop p, int x, int y ) : void | ||
DragAndDrop_HoverLeave ( DragDrop p ) : void | ||
DragAndDrop_SetPackage ( bool draggable, String name = "", object userData = null ) : void | ||
DragAndDrop_ShouldStartDrag ( ) : bool | ||
DragAndDrop_StartDragging ( DragDrop package, int x, int y ) : void | ||
Enable ( ) : void |
Enables the control.
|
|
FindChildByName ( String name, bool recursive = false ) : Control |
Finds a child by name.
|
|
Focus ( ) : void |
Focuses the control.
|
|
GetCanvas ( ) : |
Gets the canvas (root parent) of the control.
|
|
GetChildrenSize ( ) : Vector2i |
Returns the total width and height of all children. Default implementation returns maximum size of children since the layout is unknown. Implement this in derived compound controls to properly return their size. |
|
GetControlAt ( int x, int y ) : Control |
Gets a child by its coordinates.
|
|
Hide ( ) : void |
Hides the control.
|
|
Invalidate ( ) : void |
Invalidates the control. Causes layout, repaint, invalidates cached texture. |
|
InvalidateParent ( ) : void |
Invalidates control's parent.
|
|
IsChild ( Control child ) : bool |
Checks if the given control is a child of this instance.
|
|
LocalPosToCanvas ( Vector2i pnt ) : Vector2i |
Converts local coordinates to canvas coordinates.
|
|
MoveBy ( int x, int y ) : void |
Moves the control by a specific amount.
|
|
MoveTo ( float x, float y ) : void |
Moves the control to a specific point.
|
|
MoveTo ( int x, int y ) : void |
Moves the control to a specific point, clamping on paren't bounds if RestrictToParent is set.
|
|
Position ( Pos pos, int xpadding, int ypadding ) : void |
Positions the control inside its parent.
|
|
Redraw ( ) : void |
Re-renders the control, invalidates cached texture.
|
|
RemoveChild ( Control child, bool dispose ) : void |
Detaches specified control from this one.
|
|
SendToBack ( ) : void |
Sends the control to the bottom of paren't visibility stack.
|
|
SetBounds ( Rectangle bounds ) : bool |
Sets the control bounds.
|
|
SetBounds ( float x, float y, float width, float height ) : bool |
Sets the control bounds.
|
|
SetBounds ( int x, int y, int width, int height ) : bool |
Sets the control bounds.
|
|
SetPosition ( float x, float y ) : void |
Sets the control position.
|
|
SetPosition ( int x, int y ) : void |
Sets the control position.
|
|
SetSize ( int width, int height ) : bool |
Sets the control size.
|
|
SetSkin ( Skins skin, bool doChildren = false ) : void |
Sets the control's skin.
|
|
SetToolTipText ( String text ) : void |
Creates a tooltip for the control.
|
|
Show ( ) : void |
Shows the control.
|
|
SizeToChildren ( bool width = true, bool height = true ) : bool |
Resizes the control to fit its children.
|
|
Think ( ) : void |
Called during rendering.
|
|
ToString ( ) : string | ||
Touch ( ) : void |
Control has been clicked - invoked by input system. Windows use it to propagate activation.
|
|
UpdateColors ( ) : void |
Updates control colors. Used in composite controls like lists to differentiate row colors etc. |
|
UpdateCursor ( ) : void |
Sets mouse cursor to current cursor.
|
Method | Description | |
---|---|---|
DoCacheRender ( Skins skin, Control master ) : void |
Renders the control to a cache using specified skin.
|
|
InvalidateChildren ( bool recursive = false ) : void |
Invalidates the control's children (relayout/repaint).
|
|
Layout ( Skins skin ) : void |
Lays out the control's interior according to alignment, padding, dock etc.
|
|
OnAccelerator ( ) : void |
Default accelerator handler.
|
|
OnBoundsChanged ( |
Handler invoked when control's bounds change.
|
|
OnChar ( Char chr ) : bool |
Handler for character input event.
|
|
OnChildAdded ( Control child ) : void |
Handler invoked when a child is added.
|
|
OnChildBoundsChanged ( |
Handler invoked when control children's bounds change.
|
|
OnChildRemoved ( Control child ) : void |
Handler invoked when a child is removed.
|
|
OnChildTouched ( Control control ) : void | ||
OnCopy ( Control from ) : void |
Handler for Copy event.
|
|
OnCut ( Control from ) : void |
Handler for Cut event.
|
|
OnKeyBackspace ( bool down ) : bool |
Handler for Backspace keyboard event.
|
|
OnKeyDelete ( bool down ) : bool |
Handler for Delete keyboard event.
|
|
OnKeyDown ( bool down ) : bool |
Handler for Down Arrow keyboard event.
|
|
OnKeyEnd ( bool down ) : bool |
Handler for End keyboard event.
|
|
OnKeyEscape ( bool down ) : bool |
Handler for Escape keyboard event.
|
|
OnKeyHome ( bool down ) : bool |
Handler for Home keyboard event.
|
|
OnKeyLeft ( bool down ) : bool |
Handler for Left Arrow keyboard event.
|
|
OnKeyPressed ( Keys key, bool down = true ) : bool |
Handler for keyboard events.
|
|
OnKeyReleaseed ( Keys key ) : bool |
Handler for keyboard events.
|
|
OnKeyReturn ( bool down ) : bool |
Handler for Return keyboard event.
|
|
OnKeyRight ( bool down ) : bool |
Handler for Right Arrow keyboard event.
|
|
OnKeySpace ( bool down ) : bool |
Handler for Space keyboard event.
|
|
OnKeyTab ( bool down ) : bool |
Handler for Tab keyboard event.
|
|
OnKeyUp ( bool down ) : bool |
Handler for Up Arrow keyboard event.
|
|
OnKeyboardFocus ( ) : void |
Handler for gaining keyboard focus.
|
|
OnLostKeyboardFocus ( ) : void |
Handler for losing keyboard focus.
|
|
OnMouseClickedLeft ( int x, int y, bool down ) : void |
Handler invoked on mouse click (left) event.
|
|
OnMouseClickedRight ( int x, int y, bool down ) : void |
Handler invoked on mouse click (right) event.
|
|
OnMouseDoubleClickedLeft ( int x, int y ) : void |
Handler invoked on mouse double click (left) event.
|
|
OnMouseDoubleClickedRight ( int x, int y ) : void |
Handler invoked on mouse double click (right) event.
|
|
OnMouseEntered ( ) : void |
Handler invoked on mouse cursor entering control's bounds.
|
|
OnMouseLeft ( ) : void |
Handler invoked on mouse cursor leaving control's bounds.
|
|
OnMouseMoved ( int x, int y, int dx, int dy ) : void |
Handler invoked on mouse moved event.
|
|
OnMouseWheeled ( int delta ) : bool |
Handler invoked on mouse wheel event.
|
|
OnPaste ( Control from ) : void |
Handler for Paste event.
|
|
OnScaleChanged ( ) : void |
Handler invoked when control's scale changes.
|
|
OnSelectAll ( Control from ) : void |
Handler for Select All event.
|
|
OnSkinChanged ( Skins newSkin ) : void |
Handler invoked when control's skin changes.
|
|
PostLayout ( Skins skin ) : void |
Function invoked after layout.
|
|
RecurseLayout ( Skins skin ) : void |
Recursively lays out the control's interior according to alignment, margin, padding, dock etc.
|
|
Render ( Skins skin ) : void |
Renders the control using specified skin.
|
|
RenderFocus ( Skins skin ) : void |
Renders the focus overlay.
|
|
RenderOver ( Skins skin ) : void |
Renders over the actual control (overlays).
|
|
RenderRecursive ( Skins skin, Rectangle clipRect ) : void |
Recursive rendering logic.
|
|
RenderUnder ( Skins skin ) : void |
Renders under the actual control (shadows etc).
|
|
UpdateRenderBounds ( ) : void |
Copies Bounds to RenderBounds.
|
Method | Description | |
---|---|---|
DefaultAcceleratorHandler ( Control control ) : void |
Default accelerator handler.
|
|
DoRender ( Skins skin ) : void |
Rendering logic implementation.
|
|
HandleAccelerator ( String accelerator ) : bool |
Handles keyboard accelerator.
|
|
InputChar ( Char chr ) : bool | ||
InputCopy ( Control from ) : void | ||
InputCut ( Control from ) : void | ||
InputKeyPressed ( Keys key, bool down = true ) : bool |
Invokes key press event (used by input system).
|
|
InputMouseClickedLeft ( int x, int y, bool down ) : void |
Invokes left mouse click event (used by input system).
|
|
InputMouseClickedRight ( int x, int y, bool down ) : void |
Invokes right mouse click event (used by input system).
|
|
InputMouseDoubleClickedLeft ( int x, int y ) : void |
Invokes left double mouse click event (used by input system).
|
|
InputMouseDoubleClickedRight ( int x, int y ) : void |
Invokes right double mouse click event (used by input system).
|
|
InputMouseEntered ( ) : void |
Invokes mouse enter event (used by input system).
|
|
InputMouseLeft ( ) : void |
Invokes mouse leave event (used by input system).
|
|
InputMouseMoved ( int x, int y, int dx, int dy ) : void |
Invokes mouse moved event (used by input system).
|
|
InputMouseWheeled ( int delta ) : bool |
Invokes mouse wheeled event (used by input system).
|
|
InputPaste ( Control from ) : void | ||
InputSelectAll ( Control from ) : void |
public AddAccelerator ( String accelerator ) : void | ||
accelerator | String | Accelerator text. |
return | void |
public AddAccelerator ( String accelerator, GwenEventHandler handler ) : void | ||
accelerator | String | Accelerator text. |
handler | GwenEventHandler | Handler. |
return | void |
public AddChild ( Control child ) : void | ||
child | Control | Control to be added as a child. |
return | void |
public Anim_HeightIn ( float length, float delay, float ease ) : void | ||
length | float | |
delay | float | |
ease | float | |
return | void |
public Anim_HeightOut ( float length, bool hide, float delay, float ease ) : void | ||
length | float | |
hide | bool | |
delay | float | |
ease | float | |
return | void |
public Anim_WidthIn ( float length, float delay = 0.0f, float ease = 1.0f ) : void | ||
length | float | |
delay | float | |
ease | float | |
return | void |
public Anim_WidthOut ( float length, bool hide, float delay, float ease ) : void | ||
length | float | |
hide | bool | |
delay | float | |
ease | float | |
return | void |
public BringNextToControl ( Control child, bool behind ) : void | ||
child | Control | |
behind | bool | |
return | void |
public CanvasPosToLocal ( Vector2i pnt ) : Vector2i | ||
pnt | Vector2i | Canvas coordinates. |
return | Vector2i |
public Control ( Control parent ) : System | ||
parent | Control | Parent control. |
return | System |
protected DoCacheRender ( Skins skin, Control master ) : void | ||
skin | Skins | Skin to use. |
master | Control | Root parent. |
return | void |
public DragAndDrop_CanAcceptPackage ( DragDrop p ) : bool | ||
p | DragDrop | |
return | bool |
public DragAndDrop_EndDragging ( bool success, int x, int y ) : void | ||
success | bool | |
x | int | |
y | int | |
return | void |
public DragAndDrop_GetPackage ( int x, int y ) : DragDrop.Package | ||
x | int | |
y | int | |
return | DragDrop.Package |
public DragAndDrop_HandleDrop ( DragDrop p, int x, int y ) : bool | ||
p | DragDrop | |
x | int | |
y | int | |
return | bool |
public DragAndDrop_Hover ( DragDrop p, int x, int y ) : void | ||
p | DragDrop | |
x | int | |
y | int | |
return | void |
public DragAndDrop_HoverEnter ( DragDrop p, int x, int y ) : void | ||
p | DragDrop | |
x | int | |
y | int | |
return | void |
public DragAndDrop_HoverLeave ( DragDrop p ) : void | ||
p | DragDrop | |
return | void |
public DragAndDrop_SetPackage ( bool draggable, String name = "", object userData = null ) : void | ||
draggable | bool | |
name | String | |
userData | object | |
return | void |
public DragAndDrop_ShouldStartDrag ( ) : bool | ||
return | bool |
public DragAndDrop_StartDragging ( DragDrop package, int x, int y ) : void | ||
package | DragDrop | |
x | int | |
y | int | |
return | void |
public FindChildByName ( String name, bool recursive = false ) : Control | ||
name | String | Child name. |
recursive | bool | Determines whether the search should be recursive. |
return | Control |
public GetControlAt ( int x, int y ) : Control | ||
x | int | Child X. |
y | int | Child Y. |
return | Control |
protected InvalidateChildren ( bool recursive = false ) : void | ||
recursive | bool | Determines whether the operation should be carried recursively. |
return | void |
public IsChild ( Control child ) : bool | ||
child | Control | Control to examine. |
return | bool |
protected Layout ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
public LocalPosToCanvas ( Vector2i pnt ) : Vector2i | ||
pnt | Vector2i | Local coordinates. |
return | Vector2i |
public MoveBy ( int x, int y ) : void | ||
x | int | X-axis movement. |
y | int | Y-axis movement. |
return | void |
public MoveTo ( float x, float y ) : void | ||
x | float | Target x coordinate. |
y | float | Target y coordinate. |
return | void |
public MoveTo ( int x, int y ) : void | ||
x | int | Target x coordinate. |
y | int | Target y coordinate. |
return | void |
protected OnBoundsChanged ( |
||
oldBounds | Old bounds. | |
return | void |
protected OnChar ( Char chr ) : bool | ||
chr | Char | Character typed. |
return | bool |
protected OnChildAdded ( Control child ) : void | ||
child | Control | Child added. |
return | void |
protected OnChildBoundsChanged ( |
||
oldChildBounds | ||
child | Control | |
return | void |
protected OnChildRemoved ( Control child ) : void | ||
child | Control | Child removed. |
return | void |
protected OnChildTouched ( Control control ) : void | ||
control | Control | |
return | void |
protected OnCopy ( Control from ) : void | ||
from | Control | Source control. |
return | void |
protected OnCut ( Control from ) : void | ||
from | Control | Source control. |
return | void |
protected OnKeyBackspace ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyDelete ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyDown ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyEnd ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyEscape ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyHome ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyLeft ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyPressed ( Keys key, bool down = true ) : bool | ||
key | Keys | Key pressed. |
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyReleaseed ( Keys key ) : bool | ||
key | Keys | Key pressed. |
return | bool |
protected OnKeyReturn ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyRight ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeySpace ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyTab ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnKeyUp ( bool down ) : bool | ||
down | bool | Indicates whether the key was pressed or released. |
return | bool |
protected OnMouseClickedLeft ( int x, int y, bool down ) : void | ||
x | int | X coordinate. |
y | int | Y coordinate. |
down | bool | If set to |
return | void |
protected OnMouseClickedRight ( int x, int y, bool down ) : void | ||
x | int | X coordinate. |
y | int | Y coordinate. |
down | bool | If set to |
return | void |
protected OnMouseDoubleClickedLeft ( int x, int y ) : void | ||
x | int | X coordinate. |
y | int | Y coordinate. |
return | void |
protected OnMouseDoubleClickedRight ( int x, int y ) : void | ||
x | int | X coordinate. |
y | int | Y coordinate. |
return | void |
protected OnMouseMoved ( int x, int y, int dx, int dy ) : void | ||
x | int | X coordinate. |
y | int | Y coordinate. |
dx | int | X change. |
dy | int | Y change. |
return | void |
protected OnMouseWheeled ( int delta ) : bool | ||
delta | int | Scroll delta. |
return | bool |
protected OnPaste ( Control from ) : void | ||
from | Control | Source control. |
return | void |
protected OnSelectAll ( Control from ) : void | ||
from | Control | Source control. |
return | void |
protected OnSkinChanged ( Skins newSkin ) : void | ||
newSkin | Skins | New skin. |
return | void |
public Position ( Pos pos, int xpadding, int ypadding ) : void | ||
pos | Pos | Target position. |
xpadding | int | X padding. |
ypadding | int | Y padding. |
return | void |
protected PostLayout ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
protected RecurseLayout ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
public RemoveChild ( Control child, bool dispose ) : void | ||
child | Control | Child to be removed. |
dispose | bool | Determines whether the child should be disposed (added to delayed delete queue). |
return | void |
protected Render ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
protected RenderFocus ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
protected RenderOver ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
protected RenderRecursive ( Skins skin, Rectangle clipRect ) : void | ||
skin | Skins | Skin to use. |
clipRect | Rectangle | Clipping rectangle. |
return | void |
protected RenderUnder ( Skins skin ) : void | ||
skin | Skins | Skin to use. |
return | void |
public SetBounds ( Rectangle bounds ) : bool | ||
bounds | Rectangle | New bounds. |
return | bool |
public SetBounds ( float x, float y, float width, float height ) : bool | ||
x | float | X. |
y | float | Y. |
width | float | Width. |
height | float | Height. |
return | bool |
public SetBounds ( int x, int y, int width, int height ) : bool | ||
x | int | X position. |
y | int | Y position. |
width | int | Width. |
height | int | Height. |
return | bool |
public SetPosition ( float x, float y ) : void | ||
x | float | Target x coordinate. |
y | float | Target y coordinate. |
return | void |
public SetPosition ( int x, int y ) : void | ||
x | int | Target x coordinate. |
y | int | Target y coordinate. |
return | void |
public SetSize ( int width, int height ) : bool | ||
width | int | New width. |
height | int | New height. |
return | bool |
public SetSkin ( Skins skin, bool doChildren = false ) : void | ||
skin | Skins | New skin. |
doChildren | bool | Deterines whether to change children skin. |
return | void |
public SetToolTipText ( String text ) : void | ||
text | String | Tooltip text. |
return | void |
public SizeToChildren ( bool width = true, bool height = true ) : bool | ||
width | bool | Determines whether to change control's width. |
height | bool | Determines whether to change control's height. |
return | bool |