Reference for .Net version of SpaceVIL  0.3.5.8
SpaceVIL (Space of Visual Items Layout) is a cross-platform and multilingual framework for creating GUI client applications for .NET Standard, .NET Core and JVM. SpaceVIL is based on OpenGL graphic technology and GLFW. Using this framework in conjunction with .Net Core or with a JVM, you can work and create graphical client applications on Linux, Mac OS X and Windows.
SpaceVIL.Prototype Class Reference

The Prototype is an abstract implementation of IBaseItem for complex interactive items. Contains all the necessary methods for rendering objects and interacting with them. Examples of subclasses: SpaceVIL.ButtonCore, SpaceVIL.TextEdit, SpaceVIL.ListBox and etc. More...

Inherits SpaceVIL.Core.IBaseItem.

Inherited by SpaceVIL.BlankItem, SpaceVIL.ButtonCore, SpaceVIL.ButtonToggle, SpaceVIL.CheckBox, SpaceVIL.ComboBox, SpaceVIL.ComboBoxDropDown, SpaceVIL.ContextMenu, SpaceVIL.DialogItem, SpaceVIL.FileSystemEntry, SpaceVIL.FloatItem, SpaceVIL.Frame, SpaceVIL.FreeArea, SpaceVIL.Graph, SpaceVIL.Grid, SpaceVIL.HorizontalSlider, SpaceVIL.HorizontalSplitArea, SpaceVIL.HorizontalStack, SpaceVIL.ImageItem, SpaceVIL.Indicator, SpaceVIL.Label, SpaceVIL.ListArea, SpaceVIL.ListBox, SpaceVIL.LoadingScreen, SpaceVIL.MenuItem, SpaceVIL.PopUpMessage, SpaceVIL.ProgressBar, SpaceVIL.RadioButton, SpaceVIL.ResizableItem, SpaceVIL.ScrollHandler, SpaceVIL.SelectionItem, SpaceVIL.SideArea, SpaceVIL.SpinItem, SpaceVIL.SplitHolder, SpaceVIL.Tab, SpaceVIL.TextArea, SpaceVIL.TextEdit, SpaceVIL.TextView, SpaceVIL.ToolTipItem, SpaceVIL.TreeItem, SpaceVIL.VerticalSlider, SpaceVIL.VerticalSplitArea, SpaceVIL.VerticalStack, SpaceVIL.WindowAnchor, SpaceVIL.WrapArea, and SpaceVIL.WrapGrid.

Public Member Functions

 Prototype ()
 Default constructor of Prototype class. More...
 
virtual void Release ()
 Method to describe disposing item's resources if the item was removed. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
void SetHandler (CoreWindow handler)
 Setting the window to which the item will belong. More...
 
CoreWindow GetHandler ()
 Getting the window to which the item belongs. More...
 
String GetToolTip ()
 Getting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough. More...
 
void SetToolTip (String text)
 Setting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough. More...
 
Prototype GetParent ()
 Getting the parent of the item. More...
 
void SetParent (Prototype parent)
 Setting the parent of the item. More...
 
Spacing GetSpacing ()
 Getting indents between children of a container type item. More...
 
void SetSpacing (Spacing spacing)
 Setting indents between children of a container type item. More...
 
void SetSpacing (int horizontal=0, int vertical=0)
 Setting indents between children of a container type item. More...
 
Indents GetPadding ()
 Getting indents of an item for offset its children. More...
 
void SetPadding (Indents padding)
 Setting indents of an item to offset its children. More...
 
void SetPadding (int left=0, int top=0, int right=0, int bottom=0)
 Setting indents of an item to offset its children. More...
 
Indents GetMargin ()
 Getting the indents of an item to offset itself relative to its container. More...
 
void SetMargin (Indents margin)
 Setting the indents of an item to offset itself relative to its container. More...
 
void SetMargin (int left=0, int top=0, int right=0, int bottom=0)
 Setting the indents of an item to offset itself relative to its container. More...
 
void SetBorder (Border border)
 Setting border of an item's shape. Border consist of corner radiuses, thickness and color. More...
 
void SetBorderFill (Color fill)
 Setting the border color of an item's shape. More...
 
Color GetBorderFill ()
 Getting the border color oa an item's shape. More...
 
void SetBorderFill (int r, int g, int b, int a=255)
 Setting the border color of an item's shape in byte RGBA format. More...
 
void SetBorderFill (float r, float g, float b, float a=1.0f)
 Setting the border color of an item's shape in float RGBA format. More...
 
void SetBorderRadius (CornerRadius radius)
 Setting radius of the border's corners. More...
 
void SetBorderRadius (int radius)
 Setting border radius with the same values for each corner of the rectangle object. More...
 
CornerRadius GetBorderRadius ()
 Getting border radiuses. More...
 
void SetBorderThickness (int thickness)
 Setting border thickness of an item's shape. More...
 
int GetBorderThickness ()
 Getting border thickness of an item's shape. More...
 
virtual void InitElements ()
 Initializing children and their attributes. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
List< float[]> GetTriangles ()
 Getting triangles of item's shape. More...
 
virtual void SetTriangles (List< float[]> triangles)
 Setting triangles as item's shape. More...
 
virtual void MakeShape ()
 Making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
virtual void SetBackground (Color color)
 Setting background color of an item's shape. More...
 
virtual void SetBackground (int r, int g, int b)
 Setting background color of an item's shape in byte RGB format. More...
 
virtual void SetBackground (int r, int g, int b, int a)
 Setting background color of an item in byte RGBA format. More...
 
virtual void SetBackground (float r, float g, float b)
 Setting background color of an item in float RGB format. More...
 
virtual void SetBackground (float r, float g, float b, float a)
 Setting background color of an item in float RGBA format. More...
 
virtual Color GetBackground ()
 Getting background color of an item. More...
 
void SetItemName (string name)
 Setting the name of the item. More...
 
string GetItemName ()
 Getting the name of the item. More...
 
void SetMinWidth (int width)
 Setting the minimum width limit. Actual width cannot be less than this limit. More...
 
int GetMinWidth ()
 Getting the minimum width limit. More...
 
virtual void SetWidth (int width)
 Setting item width. If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value. More...
 
virtual int GetWidth ()
 Getting item width. More...
 
void SetMaxWidth (int width)
 Setting the maximum width limit. Actual width cannot be greater than this limit. More...
 
int GetMaxWidth ()
 Getting the maximum width limit. More...
 
void SetMinHeight (int height)
 Setting the minimum height limit. Actual height cannot be less than this limit. More...
 
int GetMinHeight ()
 Getting the minimum height limit. More...
 
virtual void SetHeight (int height)
 Setting item height. If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value. More...
 
virtual int GetHeight ()
 Getting item height. More...
 
void SetMaxHeight (int height)
 Setting the maximum height limit. Actual height cannot be greater than this limit. More...
 
int GetMaxHeight ()
 Getting the maximum height limit. More...
 
virtual void SetSize (int width, int height)
 Setting item size (width and height). More...
 
Core.Size GetSize ()
 Getting current item size. More...
 
void SetMinSize (int width, int height)
 Setting minimum item size limit (width and height limits). More...
 
Core.Size GetMinSize ()
 Getting current item minimum size limit. More...
 
void SetMaxSize (int width, int height)
 Setting maximum item size limit (width and height limits). More...
 
Core.Size GetMaxSize ()
 Getting current item maximum size limit. More...
 
void SetAlignment (ItemAlignment alignment)
 Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right). More...
 
void SetAlignment (params ItemAlignment[] alignment)
 Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right). More...
 
ItemAlignment GetAlignment ()
 Getting an alignment of an item's shape relative to its container. More...
 
void SetSizePolicy (SizePolicy width, SizePolicy height)
 Setting the size policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
void SetWidthPolicy (SizePolicy policy)
 Setting width policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetWidthPolicy ()
 Getting width policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
void SetHeightPolicy (SizePolicy policy)
 Setting height policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetHeightPolicy ()
 Getting height policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
virtual void SetPosition (int x, int y)
 Setting item position. More...
 
virtual void SetX (int x)
 Setting X coordinate of the left-top corner of a shape. More...
 
virtual int GetX ()
 Getting X coordinate of the left-top corner of a shape. More...
 
virtual void SetY (int y)
 Setting Y coordinate of the left-top corner of a shape. More...
 
virtual int GetY ()
 Getting Y coordinate of the left-top corner of a shape. More...
 
virtual void SetConfines ()
 Setting the confines of the item relative to its parent's size and position. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
virtual void SetConfines (int x0, int x1, int y0, int y1)
 Setting the confines of the item relative to specified bounds. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
virtual void SetStyle (Style style)
 Setting a style that describes the appearance of an item. More...
 
virtual Style GetCoreStyle ()
 Getting the core (only appearance properties without inner styles) style of an item. More...
 
bool IsShadowDrop ()
 Getting the shadow visibility status of an item. More...
 
void SetShadowDrop (bool value)
 Setting the shadow visibility status of an item. More...
 
void SetShadowRadius (int radius)
 Setting the specified blur radius of the shadow. Default: 0. More...
 
int GetShadowRadius ()
 Getting the shadow blur raduis. More...
 
Color GetShadowColor ()
 Getting shadow color. More...
 
void SetShadowColor (Color color)
 Setting shadow color. More...
 
Position GetShadowPos ()
 Getting the offset of the shadow relative to the position of the item. More...
 
int[] GetShadowExtension ()
 Getting the values of shadow extensions in pixels. More...
 
void SetShadowExtension (int wExtension, int hExtension)
 Setting the values of shadow extensions in pixels. More...
 
void SetShadow (int radius, int x, int y, Color color)
 Setting the shadow with specified blur radius, axis shifts, shadow color. More...
 
void AddItemState (ItemStateType type, ItemState state)
 Adding visual state for an item. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
void RemoveItemState (ItemStateType type)
 Removing visual state of an item by type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
void RemoveAllItemStates ()
 Removing all item visual states. More...
 
ItemState GetState (ItemStateType type)
 Getting item visual state by its type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
virtual void InsertItem (IBaseItem item, Int32 index)
 Inserting item to the container (this). If the count of container elements is less than the index, then the element is added to the end of the list. More...
 
virtual void AddItems (params IBaseItem[] items)
 Adding sequence of items into the container (this). More...
 
virtual void AddItem (IBaseItem item)
 Adding item into the container (this). More...
 
void Update (GeometryEventType type, int value=0)
 Updating an item size or/and position. More...
 
virtual bool IsDrawable ()
 Getting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
void SetDrawable (bool value)
 Setting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
virtual bool IsVisible ()
 Getting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
virtual void SetVisible (bool value)
 Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
virtual bool IsPassEvents ()
 Getting boolean value to know if this item can pass further any input events (mouse, keyboard and etc.). Tip: Need for filtering input events. More...
 
bool IsPassEvents (InputEventType e)
 Getting boolean value to know if this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
List< InputEventTypeGetPassEvents ()
 Getting all allowed input events. More...
 
List< InputEventTypeGetBlockedEvents ()
 Getting all blocked input events. More...
 
void SetPassEvents (bool value)
 Setting on or off so that this item can pass further any input events (mouse, keyboard and etc.). More...
 
void SetPassEvents (bool value, InputEventType e)
 Setting on or off so that this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
void SetPassEvents (bool value, params InputEventType[] events)
 Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...
 
virtual bool IsDisabled ()
 Returns True if this item is disabled (non-interactive) otherwise returns False. More...
 
virtual void SetDisabled (bool value)
 Setting this item disabled (become non-interactive) or enabled. More...
 
virtual bool IsMouseHover ()
 Returns True if this item is hovered otherwise returns False. More...
 
virtual void SetMouseHover (bool value)
 Setting this item hovered (mouse cursor located within item's shape). More...
 
virtual bool IsMousePressed ()
 Returns True if mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
virtual void SetMousePressed (bool value)
 Setting True if you want that mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
virtual bool IsFocused ()
 Returns True if this item gets focus otherwise False. More...
 
virtual void SetFocus ()
 Setting focus on this item if it is focusable. More...
 
virtual List< IBaseItemGetItems ()
 Getting list of the Prototype's inner items (children). More...
 
virtual bool RemoveItem (IBaseItem item)
 Removing the specified item from container (this). More...
 
virtual void Clear ()
 Removing all children. More...
 
void SetContent (List< IBaseItem > content)
 Setting content for this item. Note: this method is only for sorting children i.e. Prototype.GetItems() contains equal set of children as input argument: List<SpaceVIL.Core.IBaseItem> content. If content is different this method do nothing. More...
 
Figure IsCustomFigure ()
 Getting the custom shape if it is set. You can set any shape using Prototype.SetCustomFigure(Figure) and it will replace the default rectangle shape. More...
 
void SetCustomFigure (Figure figure)
 Setting the custom shape to replace the default rectangle shape. More...
 
ItemHoverRule GetHoverRule ()
 Getting the hovering rule of this item. Can be ItemHoverRule.Lazy or ItemHoverRule.Strict (see SpaceVIL.Core.ItemHoverRule). More...
 
void SetHoverRule (ItemHoverRule rule)
 Setting the hovering rule for this item. More...
 
CursorImage GetCursor ()
 Getting the mouse cursor image of this item. More...
 
void SetCursor (EmbeddedCursor type)
 Setting mouse cursor image for this item from embedded cursors. More...
 
void SetCursor (CursorImage cursor)
 Setting mouse cursor image for this item. More...
 
void SetCursor (Bitmap bitmap)
 Creating and setting mouse cursor image for this item from specified bitmap image. More...
 
void SetCursor (Bitmap bitmap, int width, int height)
 Creating and setting mouse cursor image for this item from specified scaled bitmap image. More...
 

Public Attributes

EventCommonMethodState EventResize
 Event that is invoked when an item is resizing. More...
 
EventCommonMethodState EventDestroy
 Event that is invoked when an item is destroyed (removed). More...
 
EventMouseMethodState EventMouseHover
 Event that is invoked when mouse cursor enters inside an item area. More...
 
EventMouseMethodState EventMouseLeave
 Event that is invoked when mouse cursor leaves inside an item area. More...
 
EventMouseMethodState EventMouseClick
 Event that is invoked when mouse click (release) on an item. More...
 
EventMouseMethodState EventMouseDoubleClick
 Event that is invoked when mouse double click on an item. More...
 
EventMouseMethodState EventMousePress
 Event that is invoked when mouse press on an item. More...
 
EventMouseMethodState EventMouseDrag
 Event that is invoked when mouse drag on an item. More...
 
EventMouseMethodState EventMouseDrop
 Event that is invoked when mouse drop on an item. More...
 
EventMouseMethodState EventScrollUp
 Event that is invoked when mouse wheel scrolls up on an item. More...
 
EventMouseMethodState EventScrollDown
 Event that is invoked when mouse wheel scrolls down on an item. More...
 
EventKeyMethodState EventKeyPress
 Event that is invoked when key of keyboard is pressed. More...
 
EventKeyMethodState EventKeyRelease
 Event that is invoked when key of keyboard is released. More...
 
EventInputTextMethodState EventTextInput
 Event that is invoked when typing text on the keyboard. More...
 
bool IsFocusable = true
 Item's focusable property. True: this item can get focus. False: this item cannot get focus. More...
 

Protected Member Functions

virtual void UpdateState ()
 Updating Prototype's state according to its ItemStateType. More...
 
void SetState (ItemStateType state)
 

Detailed Description

The Prototype is an abstract implementation of IBaseItem for complex interactive items.

Contains all the necessary methods for rendering objects and interacting with them.

Examples of subclasses: SpaceVIL.ButtonCore, SpaceVIL.TextEdit, SpaceVIL.ListBox and etc.

Constructor & Destructor Documentation

◆ Prototype()

SpaceVIL.Prototype.Prototype ( )

Default constructor of Prototype class.

Member Function Documentation

◆ AddItem()

◆ AddItems()

virtual void SpaceVIL.Prototype.AddItems ( params IBaseItem[]  items)
virtual

Adding sequence of items into the container (this).

Parameters
itemsSequence of items.

Reimplemented in SpaceVIL.ToolTipItem.

◆ AddItemState()

void SpaceVIL.Prototype.AddItemState ( ItemStateType  type,
ItemState  state 
)

Adding visual state for an item. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled.

Parameters
typeType as SpaceVIL.Core.ItemStateType.
stateVisual state as SpaceVIL.Decorations.ItemState.

◆ Clear()

virtual void SpaceVIL.Prototype.Clear ( )
virtual

◆ GetAlignment()

ItemAlignment SpaceVIL.Prototype.GetAlignment ( )

Getting an alignment of an item's shape relative to its container.

Returns
Alignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.IBehavior.

◆ GetBackground()

virtual Color SpaceVIL.Prototype.GetBackground ( )
virtual

Getting background color of an item.

Returns
Background color as System.Drawing.Color.

Implements SpaceVIL.Core.IItem.

Reimplemented in SpaceVIL.SpinItem.

◆ GetBlockedEvents()

List<InputEventType> SpaceVIL.Prototype.GetBlockedEvents ( )

Getting all blocked input events.

Returns
Blocked input events as List<SpaceVIL.Core.InputEventType>

◆ GetBorderFill()

Color SpaceVIL.Prototype.GetBorderFill ( )

Getting the border color oa an item's shape.

Returns
Border color as System.Drawing.Color.

◆ GetBorderRadius()

CornerRadius SpaceVIL.Prototype.GetBorderRadius ( )

Getting border radiuses.

Returns
Border radiuses as SpaceVIL.Decorations.CornerRadius.

◆ GetBorderThickness()

int SpaceVIL.Prototype.GetBorderThickness ( )

Getting border thickness of an item's shape.

Returns
Border thickness.

◆ GetCoreStyle()

virtual Style SpaceVIL.Prototype.GetCoreStyle ( )
virtual

Getting the core (only appearance properties without inner styles) style of an item.

Returns
Style as SpaceVIL.Decorations.Style.

Implements SpaceVIL.Core.IBaseItem.

◆ GetCursor()

CursorImage SpaceVIL.Prototype.GetCursor ( )

Getting the mouse cursor image of this item.

Returns
Mouse cursor image as SpaceVIL.Decorations.CursorImage.

◆ GetHandler()

CoreWindow SpaceVIL.Prototype.GetHandler ( )

Getting the window to which the item belongs.

Returns
Window as SpaceVIL.CoreWindow.

Implements SpaceVIL.Core.IBaseItem.

◆ GetHeight()

virtual int SpaceVIL.Prototype.GetHeight ( )
virtual

Getting item height.

Returns
Height of the item.

Implements SpaceVIL.Core.ISize.

◆ GetHeightPolicy()

SizePolicy SpaceVIL.Prototype.GetHeightPolicy ( )

Getting height policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Returns
Height policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ GetHoverRule()

ItemHoverRule SpaceVIL.Prototype.GetHoverRule ( )

Getting the hovering rule of this item. Can be ItemHoverRule.Lazy or ItemHoverRule.Strict (see SpaceVIL.Core.ItemHoverRule).

Returns
Hovering rule as SpaceVIL.Core.ItemHoverRule.

◆ GetItemName()

string SpaceVIL.Prototype.GetItemName ( )

Getting the name of the item.

Returns
Item name as System.String.

Implements SpaceVIL.Core.IItem.

◆ GetItems()

virtual List<IBaseItem> SpaceVIL.Prototype.GetItems ( )
virtual

Getting list of the Prototype's inner items (children).

Returns
List of children as List<SpaceVIL.Core.IBaseItem>

◆ GetMargin()

Indents SpaceVIL.Prototype.GetMargin ( )

Getting the indents of an item to offset itself relative to its container.

Returns
Margin as SpaceVIL.Decorations.Indents.

Implements SpaceVIL.Core.IBaseItem.

◆ GetMaxHeight()

int SpaceVIL.Prototype.GetMaxHeight ( )

Getting the maximum height limit.

Returns
Maximum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMaxSize()

Core.Size SpaceVIL.Prototype.GetMaxSize ( )

Getting current item maximum size limit.

Returns
Minimum item size limit as SpaceVIL.Core.Size.

◆ GetMaxWidth()

int SpaceVIL.Prototype.GetMaxWidth ( )

Getting the maximum width limit.

Returns
Maximum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMinHeight()

int SpaceVIL.Prototype.GetMinHeight ( )

Getting the minimum height limit.

Returns
Minimum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMinSize()

Core.Size SpaceVIL.Prototype.GetMinSize ( )

Getting current item minimum size limit.

Returns
Minimum item size limit as SpaceVIL.Core.Size.

◆ GetMinWidth()

int SpaceVIL.Prototype.GetMinWidth ( )

Getting the minimum width limit.

Returns
Minimum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetPadding()

Indents SpaceVIL.Prototype.GetPadding ( )

Getting indents of an item for offset its children.

Returns
Padding indents as SpaceVIL.Decorations.Indents.

◆ GetParent()

Prototype SpaceVIL.Prototype.GetParent ( )

Getting the parent of the item.

Returns
Parent as SpaceVIL.Prototype (Prototype is container and can contains children).

Implements SpaceVIL.Core.IBaseItem.

◆ GetPassEvents()

List<InputEventType> SpaceVIL.Prototype.GetPassEvents ( )

Getting all allowed input events.

Returns
Allowed input events as List<SpaceVIL.Core.InputEventType>

◆ GetShadowColor()

Color SpaceVIL.Prototype.GetShadowColor ( )

Getting shadow color.

Returns
Returns the shadow color as System.Drawing.Color.

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowExtension()

int [] SpaceVIL.Prototype.GetShadowExtension ( )

Getting the values of shadow extensions in pixels.

Returns
The values of shadow extensions. 0 - width extension, 1 - height extension.

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowPos()

Position SpaceVIL.Prototype.GetShadowPos ( )

Getting the offset of the shadow relative to the position of the item.

Returns
Shadow offset as SpaceVIL.Core.Position.

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowRadius()

int SpaceVIL.Prototype.GetShadowRadius ( )

Getting the shadow blur raduis.

Returns
The blur radius of the shadow.

Implements SpaceVIL.Core.IBaseItem.

◆ GetSize()

Core.Size SpaceVIL.Prototype.GetSize ( )

Getting current item size.

Returns
Item size as SpaceVIL.Core.Size.

Implements SpaceVIL.Core.ISize.

◆ GetSpacing()

Spacing SpaceVIL.Prototype.GetSpacing ( )

Getting indents between children of a container type item.

Returns
Indents between children as SpaceVIL.Decorations.Spacing.

◆ GetState()

ItemState SpaceVIL.Prototype.GetState ( ItemStateType  type)

Getting item visual state by its type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled.

Parameters
typeType as SpaceVIL.Core.ItemStateType.
Returns
Item visual state as SpaceVIL.Decorations.ItemState.

◆ GetToolTip()

String SpaceVIL.Prototype.GetToolTip ( )

Getting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough.

Returns
Tooltip text.

◆ GetTriangles()

List<float[]> SpaceVIL.Prototype.GetTriangles ( )

Getting triangles of item's shape.

Returns
Points list of the shape as List of float[2] array (2D).

Implements SpaceVIL.Core.IItem.

◆ GetWidth()

virtual int SpaceVIL.Prototype.GetWidth ( )
virtual

Getting item width.

Returns
Width of the item.

Implements SpaceVIL.Core.ISize.

◆ GetWidthPolicy()

SizePolicy SpaceVIL.Prototype.GetWidthPolicy ( )

Getting width policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Returns
Width policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ GetX()

virtual int SpaceVIL.Prototype.GetX ( )
virtual

Getting X coordinate of the left-top corner of a shape.

Returns
X position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ GetY()

virtual int SpaceVIL.Prototype.GetY ( )
virtual

Getting Y coordinate of the left-top corner of a shape.

Returns
Y position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ InitElements()

◆ InsertItem()

virtual void SpaceVIL.Prototype.InsertItem ( IBaseItem  item,
Int32  index 
)
virtual

Inserting item to the container (this). If the count of container elements is less than the index, then the element is added to the end of the list.

Parameters
itemChild as SpaceVIL.Core.IBaseItem.
indexIndex of insertion.

Reimplemented in SpaceVIL.WrapGrid, SpaceVIL.ListBox, and SpaceVIL.ListArea.

◆ IsCustomFigure()

Figure SpaceVIL.Prototype.IsCustomFigure ( )

Getting the custom shape if it is set. You can set any shape using Prototype.SetCustomFigure(Figure) and it will replace the default rectangle shape.

Returns
Custom shape as SpaceVIL.Decorations.Figure.

◆ IsDisabled()

virtual bool SpaceVIL.Prototype.IsDisabled ( )
virtual

Returns True if this item is disabled (non-interactive) otherwise returns False.

Returns
True: this item is disabled. False: this item is enabled.

◆ IsDrawable()

virtual bool SpaceVIL.Prototype.IsDrawable ( )
virtual

Getting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView).

Returns
True: if item is drawable (visible). False: if item is not drawable (invisible).

Implements SpaceVIL.Core.IBaseItem.

◆ IsFocused()

virtual bool SpaceVIL.Prototype.IsFocused ( )
virtual

Returns True if this item gets focus otherwise False.

Returns
True: if this item is focused. False: if this item is not focused.

◆ IsMouseHover()

virtual bool SpaceVIL.Prototype.IsMouseHover ( )
virtual

Returns True if this item is hovered otherwise returns False.

Returns
True: this item is hovered. False: this item is not hovered.

◆ IsMousePressed()

virtual bool SpaceVIL.Prototype.IsMousePressed ( )
virtual

Returns True if mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False.

Returns
True: if mouse is pressed on this item. False: if mouse is not pressed on this item.

◆ IsPassEvents() [1/2]

virtual bool SpaceVIL.Prototype.IsPassEvents ( )
virtual

Getting boolean value to know if this item can pass further any input events (mouse, keyboard and etc.). Tip: Need for filtering input events.

Returns
True: if this item pass on any input events. False: If this item do not pass any input events.

◆ IsPassEvents() [2/2]

bool SpaceVIL.Prototype.IsPassEvents ( InputEventType  e)

Getting boolean value to know if this item can pass further the specified type of input events (mouse, keyboard and etc.).

Parameters
eType of input events as SpaceVIL.Core.InputEventType.
Returns
True: if this item pass on the specified type of input events. False: If this item do not pass the specified type of input events.

◆ IsShadowDrop()

bool SpaceVIL.Prototype.IsShadowDrop ( )

Getting the shadow visibility status of an item.

Returns
True: if shadow is visible. False: if shadow is invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ IsVisible()

virtual bool SpaceVIL.Prototype.IsVisible ( )
virtual

Getting the visibility status of an item. This property may used in conjunction with the IsDrawable() property.

Returns
True: if item is visible. False: if item is invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ MakeShape()

virtual void SpaceVIL.Prototype.MakeShape ( )
virtual

Making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Implements SpaceVIL.Core.IItem.

◆ Release()

virtual void SpaceVIL.Prototype.Release ( )
virtual

Method to describe disposing item's resources if the item was removed. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Implements SpaceVIL.Core.IBaseItem.

Reimplemented in SpaceVIL.ImageItem, SpaceVIL.Tab, SpaceVIL.ButtonToggle, SpaceVIL.DialogItem, SpaceVIL.ResizableItem, SpaceVIL.VerticalSlider, SpaceVIL.HorizontalSlider, SpaceVIL.ComboBox, SpaceVIL.WrapArea, SpaceVIL.ComboBoxDropDown, SpaceVIL.ListArea, and SpaceVIL.TreeView.

◆ RemoveAllItemStates()

void SpaceVIL.Prototype.RemoveAllItemStates ( )

Removing all item visual states.

◆ RemoveItem()

virtual bool SpaceVIL.Prototype.RemoveItem ( IBaseItem  item)
virtual

Removing the specified item from container (this).

Parameters
itemItem as SpaceVIL.Core.IBaseItem.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

Reimplemented in SpaceVIL.WrapGrid, SpaceVIL.ListBox, SpaceVIL.WrapArea, SpaceVIL.ComboBox, SpaceVIL.TreeView, SpaceVIL.ListArea, SpaceVIL.ComboBoxDropDown, SpaceVIL.SideArea, SpaceVIL.ContextMenu, SpaceVIL.TabView, SpaceVIL.Grid, SpaceVIL.SelectionItem, SpaceVIL.FreeArea, SpaceVIL.VerticalStack, and SpaceVIL.HorizontalStack.

◆ RemoveItemState()

void SpaceVIL.Prototype.RemoveItemState ( ItemStateType  type)

Removing visual state of an item by type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled.

Parameters
typeType as SpaceVIL.Core.ItemStateType.

◆ SetAlignment() [1/2]

void SpaceVIL.Prototype.SetAlignment ( ItemAlignment  alignment)

Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right).

Parameters
alignmentAlignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.IBehavior.

◆ SetAlignment() [2/2]

void SpaceVIL.Prototype.SetAlignment ( params ItemAlignment[]  alignment)

Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right).

Parameters
alignmentAlignment as sequence of SpaceVIL.Core.ItemAlignment.

◆ SetBackground() [1/5]

virtual void SpaceVIL.Prototype.SetBackground ( Color  color)
virtual

Setting background color of an item's shape.

Parameters
colorBackground color as System.Drawing.Color.

Implements SpaceVIL.Core.IItem.

Reimplemented in SpaceVIL.SpinItem.

◆ SetBackground() [2/5]

virtual void SpaceVIL.Prototype.SetBackground ( float  r,
float  g,
float  b 
)
virtual

Setting background color of an item in float RGB format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)

Reimplemented in SpaceVIL.SpinItem.

◆ SetBackground() [3/5]

virtual void SpaceVIL.Prototype.SetBackground ( float  r,
float  g,
float  b,
float  a 
)
virtual

Setting background color of an item in float RGBA format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)
aAlpha color component. Range: (0.0f - 1.0f)

Reimplemented in SpaceVIL.SpinItem.

◆ SetBackground() [4/5]

virtual void SpaceVIL.Prototype.SetBackground ( int  r,
int  g,
int  b 
)
virtual

Setting background color of an item's shape in byte RGB format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)

Reimplemented in SpaceVIL.SpinItem.

◆ SetBackground() [5/5]

virtual void SpaceVIL.Prototype.SetBackground ( int  r,
int  g,
int  b,
int  a 
)
virtual

Setting background color of an item in byte RGBA format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)
aAlpha color component. Range: (0 - 255)

Reimplemented in SpaceVIL.SpinItem.

◆ SetBorder()

void SpaceVIL.Prototype.SetBorder ( Border  border)

Setting border of an item's shape. Border consist of corner radiuses, thickness and color.

Parameters
borderBorder as SpaceVIL.Decorations.Border.

◆ SetBorderFill() [1/3]

void SpaceVIL.Prototype.SetBorderFill ( Color  fill)

Setting the border color of an item's shape.

Parameters
fillBorder color as System.Drawing.Color.

◆ SetBorderFill() [2/3]

void SpaceVIL.Prototype.SetBorderFill ( float  r,
float  g,
float  b,
float  a = 1.0f 
)

Setting the border color of an item's shape in float RGBA format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)
aAlpha color component. Range: (0.0f - 1.0f)

◆ SetBorderFill() [3/3]

void SpaceVIL.Prototype.SetBorderFill ( int  r,
int  g,
int  b,
int  a = 255 
)

Setting the border color of an item's shape in byte RGBA format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)
aAlpha color component. Range: (0 - 255)

◆ SetBorderRadius() [1/2]

void SpaceVIL.Prototype.SetBorderRadius ( CornerRadius  radius)

Setting radius of the border's corners.

Parameters
radiusRadiuses of the border's corners as SpaceVIL.Decorations.CornerRadius.

◆ SetBorderRadius() [2/2]

void SpaceVIL.Prototype.SetBorderRadius ( int  radius)

Setting border radius with the same values for each corner of the rectangle object.

Parameters
radiusRadius of the border's corners.

◆ SetBorderThickness()

void SpaceVIL.Prototype.SetBorderThickness ( int  thickness)

Setting border thickness of an item's shape.

Parameters
thicknessBorder thickness.

◆ SetConfines() [1/2]

virtual void SpaceVIL.Prototype.SetConfines ( )
virtual

Setting the confines of the item relative to its parent's size and position. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Implements SpaceVIL.Core.IBaseItem.

Reimplemented in SpaceVIL.ComboBoxDropDown, SpaceVIL.ContextMenu, and SpaceVIL.FloatItem.

◆ SetConfines() [2/2]

virtual void SpaceVIL.Prototype.SetConfines ( int  x0,
int  x1,
int  y0,
int  y1 
)
virtual

Setting the confines of the item relative to specified bounds. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Parameters
x0Left X begin position.
x1Right X end position.
y0Top Y begin position.
y1Bottom Y end position.

Implements SpaceVIL.Core.IBaseItem.

◆ SetContent()

void SpaceVIL.Prototype.SetContent ( List< IBaseItem content)

Setting content for this item. Note: this method is only for sorting children i.e. Prototype.GetItems() contains equal set of children as input argument: List<SpaceVIL.Core.IBaseItem> content. If content is different this method do nothing.

Parameters
contentSorted (in any way) content of this item.

◆ SetCursor() [1/4]

void SpaceVIL.Prototype.SetCursor ( Bitmap  bitmap)

Creating and setting mouse cursor image for this item from specified bitmap image.

Parameters
bitmapBitmap for mouse cursor image as System.Drawing.Bitmap.

◆ SetCursor() [2/4]

void SpaceVIL.Prototype.SetCursor ( Bitmap  bitmap,
int  width,
int  height 
)

Creating and setting mouse cursor image for this item from specified scaled bitmap image.

Parameters
bitmapBitmap for mouse cursor image as System.Drawing.Bitmap.
widthNew width of mouse cursor image.
heightNew height of mouse cursor image.

◆ SetCursor() [3/4]

void SpaceVIL.Prototype.SetCursor ( CursorImage  cursor)

Setting mouse cursor image for this item.

Parameters
cursorMouse cursor image as SpaceVIL.Decorations.CursorImage.

◆ SetCursor() [4/4]

void SpaceVIL.Prototype.SetCursor ( EmbeddedCursor  type)

Setting mouse cursor image for this item from embedded cursors.

Parameters
typeMouse cursor type as SpaceVIL.Core.EmbeddedCursor.

◆ SetCustomFigure()

void SpaceVIL.Prototype.SetCustomFigure ( Figure  figure)

Setting the custom shape to replace the default rectangle shape.

Parameters
figureCustom shape as SpaceVIL.Decorations.Figure.

◆ SetDisabled()

virtual void SpaceVIL.Prototype.SetDisabled ( bool  value)
virtual

Setting this item disabled (become non-interactive) or enabled.

Parameters
valueTrue: if you want to disable this item. False: if you want to enable this item.

◆ SetDrawable()

void SpaceVIL.Prototype.SetDrawable ( bool  value)

Setting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView).

Parameters
valueTrue: if item should be drawable (visible). False: if item should not be drawable (invisible).

Implements SpaceVIL.Core.IBaseItem.

◆ SetFocus()

virtual void SpaceVIL.Prototype.SetFocus ( )
virtual

Setting focus on this item if it is focusable.

Reimplemented in SpaceVIL.TextArea, SpaceVIL.TextEdit, and SpaceVIL.PasswordLine.

◆ SetHandler()

void SpaceVIL.Prototype.SetHandler ( CoreWindow  handler)

Setting the window to which the item will belong.

Parameters
handlerWindow as SpaceVIL.CoreWindow.

Implements SpaceVIL.Core.IBaseItem.

◆ SetHeight()

virtual void SpaceVIL.Prototype.SetHeight ( int  height)
virtual

Setting item height. If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value.

Parameters
heightHeight of the item.

Implements SpaceVIL.Core.ISize.

Reimplemented in SpaceVIL.WrapGrid, SpaceVIL.TextView, SpaceVIL.ListBox, SpaceVIL.TextArea, SpaceVIL.ResizableItem, SpaceVIL.Grid, SpaceVIL.ImageItem, SpaceVIL.SideArea, SpaceVIL.HorizontalSplitArea, and SpaceVIL.VerticalStack.

◆ SetHeightPolicy()

void SpaceVIL.Prototype.SetHeightPolicy ( SizePolicy  policy)

Setting height policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Parameters
policyHeight policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ SetHoverRule()

void SpaceVIL.Prototype.SetHoverRule ( ItemHoverRule  rule)

Setting the hovering rule for this item.

Parameters
ruleHovering rule as SpaceVIL.Core.ItemHoverRule.

◆ SetItemName()

void SpaceVIL.Prototype.SetItemName ( string  name)

Setting the name of the item.

Parameters
nameItem name as System.String.

Implements SpaceVIL.Core.IItem.

◆ SetMargin() [1/2]

void SpaceVIL.Prototype.SetMargin ( Indents  margin)

Setting the indents of an item to offset itself relative to its container.

Parameters
marginMargin as SpaceVIL.Decorations.Indents.

Implements SpaceVIL.Core.IBaseItem.

◆ SetMargin() [2/2]

void SpaceVIL.Prototype.SetMargin ( int  left = 0,
int  top = 0,
int  right = 0,
int  bottom = 0 
)

Setting the indents of an item to offset itself relative to its container.

Parameters
leftIndent on the left.
topIndent on the top.
rightIndent on the right.
bottomIndent on the bottom.

Implements SpaceVIL.Core.IBaseItem.

◆ SetMaxHeight()

void SpaceVIL.Prototype.SetMaxHeight ( int  height)

Setting the maximum height limit. Actual height cannot be greater than this limit.

Parameters
heightMaximum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMaxSize()

void SpaceVIL.Prototype.SetMaxSize ( int  width,
int  height 
)

Setting maximum item size limit (width and height limits).

Parameters
widthMaximum width limit of the item.
heightMaximum height limit of the item.

◆ SetMaxWidth()

void SpaceVIL.Prototype.SetMaxWidth ( int  width)

Setting the maximum width limit. Actual width cannot be greater than this limit.

Parameters
widthMaximum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMinHeight()

void SpaceVIL.Prototype.SetMinHeight ( int  height)

Setting the minimum height limit. Actual height cannot be less than this limit.

Parameters
heightMinimum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMinSize()

void SpaceVIL.Prototype.SetMinSize ( int  width,
int  height 
)

Setting minimum item size limit (width and height limits).

Parameters
widthMinimum width limit of the item.
heightMinimum height limit of the item.

◆ SetMinWidth()

void SpaceVIL.Prototype.SetMinWidth ( int  width)

Setting the minimum width limit. Actual width cannot be less than this limit.

Parameters
widthMinimum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMouseHover()

virtual void SpaceVIL.Prototype.SetMouseHover ( bool  value)
virtual

Setting this item hovered (mouse cursor located within item's shape).

Parameters
valueTrue: if you want this item be hovered. False: if you want this item be not hovered.

Reimplemented in SpaceVIL.SelectionItem, SpaceVIL.RadioButton, and SpaceVIL.CheckBox.

◆ SetMousePressed()

virtual void SpaceVIL.Prototype.SetMousePressed ( bool  value)
virtual

Setting True if you want that mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False.

Parameters
valueTrue: if you want this item be mouse pressed. False: if you want this item be not mouse pressed.

◆ SetPadding() [1/2]

void SpaceVIL.Prototype.SetPadding ( Indents  padding)

Setting indents of an item to offset its children.

Parameters
paddingPadding indents as SpaceVIL.Decorations.Indents.

◆ SetPadding() [2/2]

void SpaceVIL.Prototype.SetPadding ( int  left = 0,
int  top = 0,
int  right = 0,
int  bottom = 0 
)

Setting indents of an item to offset its children.

Parameters
leftIndent on the left.
topIndent on the top.
rightIndent on the right.
bottomIndent on the bottom.

◆ SetParent()

void SpaceVIL.Prototype.SetParent ( Prototype  parent)

Setting the parent of the item.

Parameters
parentParent as SpaceVIL.Prototype (Prototype is container and can contains children).

Implements SpaceVIL.Core.IBaseItem.

◆ SetPassEvents() [1/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value)

Setting on or off so that this item can pass further any input events (mouse, keyboard and etc.).

Parameters
valueTrue: if you want that this item may to pass on any input events. False: if you want that this item cannot to pass on any input events.

◆ SetPassEvents() [2/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value,
InputEventType  e 
)

Setting on or off so that this item can pass further the specified type of input events (mouse, keyboard and etc.).

Parameters
valueTrue: if you want this item can pass further the specified type of input events. False: if you want this item connot pass further the specified type of input events.
eType of input events as SpaceVIL.Core.InputEventType.

◆ SetPassEvents() [3/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value,
params InputEventType[]  events 
)

Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.).

Parameters
valueTrue: if you want this item can pass further the specified types of input events. False: if you want this item connot pass further the specified types of input events.
eventsSequence of input event types as SpaceVIL.Core.InputEventType.

◆ SetPosition()

virtual void SpaceVIL.Prototype.SetPosition ( int  x,
int  y 
)
virtual

Setting item position.

Parameters
xX position of the left-top corner.
yY position of the left-top corner.

◆ SetShadow()

void SpaceVIL.Prototype.SetShadow ( int  radius,
int  x,
int  y,
Color  color 
)

Setting the shadow with specified blur radius, axis shifts, shadow color.

Parameters
radiusA blur radius of the shadow.
xX shift of the shadow.
yY shift of the shadow.
colorA shadow color as System.Drawing.Color.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowColor()

void SpaceVIL.Prototype.SetShadowColor ( Color  color)

Setting shadow color.

Parameters
colorShadow color as System.Drawing.Color.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowDrop()

void SpaceVIL.Prototype.SetShadowDrop ( bool  value)

Setting the shadow visibility status of an item.

Parameters
valueTrue: if shadow should be visible. False: if shadow should be invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowExtension()

void SpaceVIL.Prototype.SetShadowExtension ( int  wExtension,
int  hExtension 
)

Setting the values of shadow extensions in pixels.

Parameters
wExtensionExtension by width.
hExtensionExtension by height.

◆ SetShadowRadius()

void SpaceVIL.Prototype.SetShadowRadius ( int  radius)

Setting the specified blur radius of the shadow. Default: 0.

Parameters
radiusBlur radius of the shadow.

Implements SpaceVIL.Core.IBaseItem.

◆ SetSize()

virtual void SpaceVIL.Prototype.SetSize ( int  width,
int  height 
)
virtual

Setting item size (width and height).

Parameters
widthWidth of the item.
heightHeight of the item.

Implements SpaceVIL.Core.ISize.

Reimplemented in SpaceVIL.ImageItem.

◆ SetSizePolicy()

void SpaceVIL.Prototype.SetSizePolicy ( SizePolicy  width,
SizePolicy  height 
)

Setting the size policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Parameters
widthWidth policy of an item's shape.
heightHeight policy of an item's shape.

◆ SetSpacing() [1/2]

void SpaceVIL.Prototype.SetSpacing ( int  horizontal = 0,
int  vertical = 0 
)

Setting indents between children of a container type item.

Parameters
horizontalHorizontal indent. Default: 0.
verticalVertical indent. Default: 0.

◆ SetSpacing() [2/2]

void SpaceVIL.Prototype.SetSpacing ( Spacing  spacing)

Setting indents between children of a container type item.

Parameters
spacingSpacing as SpaceVIL.Decorations.Spacing.

◆ SetState()

void SpaceVIL.Prototype.SetState ( ItemStateType  state)
protected

◆ SetStyle()

◆ SetToolTip()

void SpaceVIL.Prototype.SetToolTip ( String  text)

Setting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough.

Parameters
textTooltip text.

◆ SetTriangles()

virtual void SpaceVIL.Prototype.SetTriangles ( List< float[]>  triangles)
virtual

Setting triangles as item's shape.

Parameters
trianglesPoints list of the shape as List of float[2] array (2D).

Implements SpaceVIL.Core.IItem.

◆ SetVisible()

virtual void SpaceVIL.Prototype.SetVisible ( bool  value)
virtual

Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property.

Parameters
valueTrue: if item should be visible. False: if item should be invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ SetWidth()

virtual void SpaceVIL.Prototype.SetWidth ( int  width)
virtual

Setting item width. If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value.

Parameters
widthWidth of the item.

Implements SpaceVIL.Core.ISize.

Reimplemented in SpaceVIL.WrapGrid, SpaceVIL.TextView, SpaceVIL.ListBox, SpaceVIL.Label, SpaceVIL.TreeItem, SpaceVIL.ProgressBar, SpaceVIL.TextArea, SpaceVIL.ResizableItem, SpaceVIL.Grid, SpaceVIL.ImageItem, SpaceVIL.SideArea, SpaceVIL.VerticalSplitArea, and SpaceVIL.HorizontalStack.

◆ SetWidthPolicy()

void SpaceVIL.Prototype.SetWidthPolicy ( SizePolicy  policy)

Setting width policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Parameters
policyWidth policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ SetX()

virtual void SpaceVIL.Prototype.SetX ( int  x)
virtual

Setting X coordinate of the left-top corner of a shape.

Parameters
xX position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

Reimplemented in SpaceVIL.WrapArea, SpaceVIL.TreeItem, SpaceVIL.ProgressBar, SpaceVIL.Grid, SpaceVIL.ImageItem, SpaceVIL.HorizontalSlider, SpaceVIL.VerticalSplitArea, and SpaceVIL.HorizontalStack.

◆ SetY()

virtual void SpaceVIL.Prototype.SetY ( int  y)
virtual

Setting Y coordinate of the left-top corner of a shape.

Parameters
yY position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

Reimplemented in SpaceVIL.WrapArea, SpaceVIL.ListArea, SpaceVIL.Grid, SpaceVIL.ImageItem, SpaceVIL.VerticalSlider, SpaceVIL.HorizontalSplitArea, and SpaceVIL.VerticalStack.

◆ Update()

void SpaceVIL.Prototype.Update ( GeometryEventType  type,
int  value = 0 
)

Updating an item size or/and position.

Parameters
typeType of event as SpaceVIL.Core.GeometryEventType.
valueValue of a property that was changed.

Implements SpaceVIL.Core.IEventUpdate.

◆ UpdateState()

virtual void SpaceVIL.Prototype.UpdateState ( )
protectedvirtual

Updating Prototype's state according to its ItemStateType.

Member Data Documentation

◆ EventDestroy

EventCommonMethodState SpaceVIL.Prototype.EventDestroy

Event that is invoked when an item is destroyed (removed).

◆ EventKeyPress

EventKeyMethodState SpaceVIL.Prototype.EventKeyPress

Event that is invoked when key of keyboard is pressed.

◆ EventKeyRelease

EventKeyMethodState SpaceVIL.Prototype.EventKeyRelease

Event that is invoked when key of keyboard is released.

◆ EventMouseClick

EventMouseMethodState SpaceVIL.Prototype.EventMouseClick

Event that is invoked when mouse click (release) on an item.

◆ EventMouseDoubleClick

EventMouseMethodState SpaceVIL.Prototype.EventMouseDoubleClick

Event that is invoked when mouse double click on an item.

◆ EventMouseDrag

EventMouseMethodState SpaceVIL.Prototype.EventMouseDrag

Event that is invoked when mouse drag on an item.

◆ EventMouseDrop

EventMouseMethodState SpaceVIL.Prototype.EventMouseDrop

Event that is invoked when mouse drop on an item.

◆ EventMouseHover

EventMouseMethodState SpaceVIL.Prototype.EventMouseHover

Event that is invoked when mouse cursor enters inside an item area.

◆ EventMouseLeave

EventMouseMethodState SpaceVIL.Prototype.EventMouseLeave

Event that is invoked when mouse cursor leaves inside an item area.

◆ EventMousePress

EventMouseMethodState SpaceVIL.Prototype.EventMousePress

Event that is invoked when mouse press on an item.

◆ EventResize

EventCommonMethodState SpaceVIL.Prototype.EventResize

Event that is invoked when an item is resizing.

◆ EventScrollDown

EventMouseMethodState SpaceVIL.Prototype.EventScrollDown

Event that is invoked when mouse wheel scrolls down on an item.

◆ EventScrollUp

EventMouseMethodState SpaceVIL.Prototype.EventScrollUp

Event that is invoked when mouse wheel scrolls up on an item.

◆ EventTextInput

EventInputTextMethodState SpaceVIL.Prototype.EventTextInput

Event that is invoked when typing text on the keyboard.

◆ IsFocusable

bool SpaceVIL.Prototype.IsFocusable = true

Item's focusable property. True: this item can get focus. False: this item cannot get focus.


The documentation for this class was generated from the following file: