SpaceVIL
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
SpaceVIL.Prototype Class Reference

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.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.TabView, SpaceVIL.TextArea, SpaceVIL.TextBlock, SpaceVIL.TextEdit, SpaceVIL.TextEncrypt, SpaceVIL.ToolTip, SpaceVIL.TreeItem, SpaceVIL.VerticalSlider, SpaceVIL.VerticalSplitArea, SpaceVIL.VerticalStack, SpaceVIL.WContainer, SpaceVIL.WindowAnchor, SpaceVIL.WrapArea, and SpaceVIL.WrapGrid.

Public Member Functions

 Prototype ()
 Constructs a Prototype More...
 
virtual void Release ()
 
void SetHandler (CoreWindow handler)
 Set parent window for the Prototype More...
 
CoreWindow GetHandler ()
 
String GetToolTip ()
 tooltip of the Prototype More...
 
void SetToolTip (String text)
 
Prototype GetParent ()
 Prototype parent item More...
 
void SetParent (Prototype parent)
 
Spacing GetSpacing ()
 Spacing(horizontal, vertical) of the Prototype More...
 
void SetSpacing (Spacing spacing)
 
void SetSpacing (int horizontal=0, int vertical=0)
 
Indents GetPadding ()
 Prototype padding (left, top, right, bottom) More...
 
void SetPadding (Indents padding)
 
void SetPadding (int left=0, int top=0, int right=0, int bottom=0)
 
Indents GetMargin ()
 Margin of the Prototype (left, top, right, bottom) More...
 
void SetMargin (Indents margin)
 
void SetMargin (int left=0, int top=0, int right=0, int bottom=0)
 
void SetBorder (Border border)
 
Parameters
borderBorder of the Prototype

 
void SetBorderFill (Color fill)
 Prototype border color More...
 
Color GetBorderFill ()
 
void SetBorderFill (int r, int g, int b, int a=255)
 
void SetBorderFill (float r, float g, float b, float a=1.0f)
 
void SetBorderRadius (CornerRadius radius)
 Radius of the border's corners More...
 
void SetBorderRadius (int radius)
 
CornerRadius GetBorderRadius ()
 
void SetBorderThickness (int thickness)
 Border thickness of the Prototype More...
 
int GetBorderThickness ()
 
virtual void InitElements ()
 Initialization and adding of all elements in the Prototype More...
 
List< float[]> GetTriangles ()
 Make/get shape of the item using triangles list More...
 
virtual void SetTriangles (List< float[]> triangles)
 
virtual List< float[]> MakeShape ()
 
virtual void SetBackground (Color color)
 Text color in the Prototype More...
 
virtual void SetBackground (int r, int g, int b)
 
virtual void SetBackground (int r, int g, int b, int a)
 
virtual void SetBackground (float r, float g, float b)
 
virtual void SetBackground (float r, float g, float b, float a)
 
virtual Color GetBackground ()
 
void SetItemName (string name)
 Name of the Prototype More...
 
string GetItemName ()
 
void SetMinWidth (int width)
 Prototype minimum width More...
 
int GetMinWidth ()
 
virtual void SetWidth (int width)
 Prototype width More...
 
virtual int GetWidth ()
 
void SetMaxWidth (int width)
 Prototype maximum width More...
 
int GetMaxWidth ()
 
void SetMinHeight (int height)
 Prototype minimum height More...
 
int GetMinHeight ()
 
virtual void SetHeight (int height)
 Prototype height More...
 
virtual int GetHeight ()
 
void SetMaxHeight (int height)
 Prototype maximum height More...
 
int GetMaxHeight ()
 
virtual void SetSize (int width, int height)
 Prototype size (width, height) More...
 
int [] GetSize ()
 
void SetMinSize (int width, int height)
 Prototype minimum size (width, height) More...
 
int [] GetMinSize ()
 
void SetMaxSize (int width, int height)
 Prototype maximum size (width, height) More...
 
int [] GetMaxSize ()
 
void SetAlignment (ItemAlignment alignment)
 Prototype alignment More...
 
void SetAlignment (params ItemAlignment[] alignment)
 
ItemAlignment GetAlignment ()
 
void SetSizePolicy (SizePolicy width, SizePolicy height)
 Prototype size policy (FIXED, EXPAND) by width and height More...
 
void SetWidthPolicy (SizePolicy policy)
 
SizePolicy GetWidthPolicy ()
 
void SetHeightPolicy (SizePolicy policy)
 
SizePolicy GetHeightPolicy ()
 
virtual void SetPosition (int x, int y)
 Prototype position More...
 
virtual void SetX (int x)
 
virtual int GetX ()
 
virtual void SetY (int y)
 
virtual int GetY ()
 
virtual void SetConfines ()
 Set default confines of the Prototype based on parent properties More...
 
virtual void SetConfines (int x0, int x1, int y0, int y1)
 Set Prototype confines More...
 
virtual void SetStyle (Style style)
 Set style of the Prototype More...
 
virtual Style GetCoreStyle ()
 Generate all item properties in one style More...
 
bool IsShadowDrop ()
 
Returns
if Prototype has shadow

 
void SetShadowDrop (bool value)
 
void SetShadowRadius (int radius)
 Radius of the shadows corners More...
 
int GetShadowRadius ()
 
Color GetShadowColor ()
 Shadow color More...
 
void SetShadowColor (Color color)
 
Position GetShadowPos ()
 Prototype's shadow position More...
 
void SetShadow (int radius, int x, int y, Color color)
 Set Prototype's shadow More...
 
void AddItemState (ItemStateType type, ItemState state)
 Add new item state for one of the item state types (BASE, HOVERED, PRESSED, TOGGLED, FOCUSED, DISABLED) More...
 
void RemoveItemState (ItemStateType type)
 Remove item state More...
 
void RemoveAllItemStates ()
 Remove all item states More...
 
ItemState GetState (ItemStateType type)
 
Returns
Returns ItemState for the ItemStateType type

 
virtual void InsertItem (IBaseItem item, Int32 index)
 Insert item to the Prototype. If Prototype has more items than index replace existing item, else add new item More...
 
virtual void AddItems (params IBaseItem[] items)
 Add items into the Prototype More...
 
virtual void AddItem (IBaseItem item)
 
void Update (GeometryEventType type, int value=0)
 Update Prototype size or position depending on the GeometryEventType More...
 
virtual bool IsDrawable ()
 Is Prototype and its inner items drawable More...
 
void SetDrawable (bool value)
 
virtual bool IsVisible ()
 Is Prototype visible More...
 
virtual void SetVisible (bool value)
 
virtual bool IsPassEvents ()
 Is Prototype pass events throw itself More...
 
bool IsPassEvents (InputEventType e)
 Is Prototype pass the InputEventType throw More...
 
void SetPassEvents (bool value)
 Sets all InputEventType passed or non passed (value) More...
 
void SetPassEvents (bool value, InputEventType e)
 
void SetPassEvents (bool value, params InputEventType[] e)
 
virtual bool IsDisabled ()
 Is Prototype disabled More...
 
virtual void SetDisabled (bool value)
 
virtual bool IsMouseHover ()
 Is mouse hover on the Prototype More...
 
virtual void SetMouseHover (bool value)
 
virtual bool IsMousePressed ()
 Is mouse pressed on the Prototype More...
 
virtual void SetMousePressed (bool value)
 
virtual bool IsFocused ()
 Is Prototype focused More...
 
virtual void SetFocus ()
 Set focus on the Prototype if its focusable More...
 
virtual List< IBaseItemGetItems ()
 Returns list of the Prototype's inner items More...
 
virtual bool RemoveItem (IBaseItem item)
 Remove item from the Prototype More...
 
virtual void Clear ()
 
int [] GetConfines ()
 Prototype confines More...
 
CustomFigure IsCustomFigure ()
 Is Prototype has CustomFigure shape, return it
More...
 
void SetCustomFigure (CustomFigure figure)
 Sets shape of the Prototype as CustomFigure More...
 
ItemRule GetHoverRule ()
 Hover rule of the Prototype More...
 
void SetHoverRule (ItemRule rule)
 
CursorImage GetCursor ()
 
void SetCursor (EmbeddedCursor type)
 
void SetCursor (CursorImage cursor)
 
void SetCursor (Bitmap bitmap)
 
void SetCursor (Bitmap bitmap, int width, int height)
 

Public Attributes

EventCommonMethodState EventResize
 
EventCommonMethodState EventDestroy
 
EventMouseMethodState EventMouseHover
 Mouse input events More...
 
EventMouseMethodState EventMouseLeave
 
EventMouseMethodState EventMouseClick
 
EventMouseMethodState EventMouseDoubleClick
 
EventMouseMethodState EventMousePress
 
EventMouseMethodState EventMouseDrag
 
EventMouseMethodState EventMouseDrop
 
EventMouseMethodState EventScrollUp
 
EventMouseMethodState EventScrollDown
 
EventKeyMethodState EventKeyPress
 Keyboard input events More...
 
EventKeyMethodState EventKeyRelease
 
EventInputTextMethodState EventTextInput
 Text input events More...
 
bool IsFocusable = true
 Is Prototype focusable More...
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ Prototype()

SpaceVIL.Prototype.Prototype ( )

Constructs a Prototype

Member Function Documentation

◆ AddItems()

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

Add items into the Prototype

◆ AddItemState()

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

Add new item state for one of the item state types (BASE, HOVERED, PRESSED, TOGGLED, FOCUSED, DISABLED)

◆ GetConfines()

int [] SpaceVIL.Prototype.GetConfines ( )

Prototype confines

Implements SpaceVIL.Core.IBaseItem.

◆ GetCoreStyle()

virtual Style SpaceVIL.Prototype.GetCoreStyle ( )
virtual

Generate all item properties in one style

Implements SpaceVIL.Core.IBaseItem.

◆ GetHoverRule()

ItemRule SpaceVIL.Prototype.GetHoverRule ( )

Hover rule of the Prototype

◆ GetItems()

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

Returns list of the Prototype's inner items

◆ GetMargin()

Indents SpaceVIL.Prototype.GetMargin ( )

Margin of the Prototype (left, top, right, bottom)

Implements SpaceVIL.Core.IBaseItem.

◆ GetPadding()

Indents SpaceVIL.Prototype.GetPadding ( )

Prototype padding (left, top, right, bottom)

◆ GetParent()

Prototype SpaceVIL.Prototype.GetParent ( )

Prototype parent item

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowColor()

Color SpaceVIL.Prototype.GetShadowColor ( )

Shadow color

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowPos()

Position SpaceVIL.Prototype.GetShadowPos ( )

Prototype's shadow position

Implements SpaceVIL.Core.IBaseItem.

◆ GetSpacing()

Spacing SpaceVIL.Prototype.GetSpacing ( )

Spacing(horizontal, vertical) of the Prototype

◆ GetToolTip()

String SpaceVIL.Prototype.GetToolTip ( )

tooltip of the Prototype

◆ GetTriangles()

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

Make/get shape of the item using triangles list

Implements SpaceVIL.Core.IItem.

◆ InitElements()

virtual void SpaceVIL.Prototype.InitElements ( )
virtual

◆ InsertItem()

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

Insert item to the Prototype. If Prototype has more items than index replace existing item, else add new item

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

◆ IsCustomFigure()

CustomFigure SpaceVIL.Prototype.IsCustomFigure ( )

Is Prototype has CustomFigure shape, return it

◆ IsDisabled()

virtual bool SpaceVIL.Prototype.IsDisabled ( )
virtual

Is Prototype disabled

◆ IsDrawable()

virtual bool SpaceVIL.Prototype.IsDrawable ( )
virtual

Is Prototype and its inner items drawable

Implements SpaceVIL.Core.IBaseItem.

◆ IsFocused()

virtual bool SpaceVIL.Prototype.IsFocused ( )
virtual

Is Prototype focused

◆ IsMouseHover()

virtual bool SpaceVIL.Prototype.IsMouseHover ( )
virtual

Is mouse hover on the Prototype

◆ IsMousePressed()

virtual bool SpaceVIL.Prototype.IsMousePressed ( )
virtual

Is mouse pressed on the Prototype

◆ IsPassEvents() [1/2]

virtual bool SpaceVIL.Prototype.IsPassEvents ( )
virtual

Is Prototype pass events throw itself

◆ IsPassEvents() [2/2]

bool SpaceVIL.Prototype.IsPassEvents ( InputEventType  e)

Is Prototype pass the InputEventType throw

◆ IsVisible()

virtual bool SpaceVIL.Prototype.IsVisible ( )
virtual

Is Prototype visible

Implements SpaceVIL.Core.IBaseItem.

◆ RemoveAllItemStates()

void SpaceVIL.Prototype.RemoveAllItemStates ( )

Remove all item states

◆ RemoveItem()

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

◆ RemoveItemState()

void SpaceVIL.Prototype.RemoveItemState ( ItemStateType  type)

Remove item state

◆ SetAlignment()

void SpaceVIL.Prototype.SetAlignment ( ItemAlignment  alignment)

Prototype alignment

Implements SpaceVIL.Core.IBehavior.

◆ SetBackground()

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

Text color in the Prototype

Implements SpaceVIL.Core.IItem.

Reimplemented in SpaceVIL.SpinItem.

◆ SetBorderFill()

void SpaceVIL.Prototype.SetBorderFill ( Color  fill)

Prototype border color

◆ SetBorderRadius()

void SpaceVIL.Prototype.SetBorderRadius ( CornerRadius  radius)

Radius of the border's corners

◆ SetBorderThickness()

void SpaceVIL.Prototype.SetBorderThickness ( int  thickness)

Border thickness of the Prototype

◆ SetConfines() [1/2]

virtual void SpaceVIL.Prototype.SetConfines ( )
virtual

Set default confines of the Prototype based on parent properties

Implements SpaceVIL.Core.IBaseItem.

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

◆ SetConfines() [2/2]

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

Set Prototype confines

Implements SpaceVIL.Core.IBaseItem.

◆ SetCustomFigure()

void SpaceVIL.Prototype.SetCustomFigure ( CustomFigure  figure)

Sets shape of the Prototype as CustomFigure

◆ SetFocus()

virtual void SpaceVIL.Prototype.SetFocus ( )
virtual

Set focus on the Prototype if its focusable

Reimplemented in SpaceVIL.TextArea, and SpaceVIL.PasswordLine.

◆ SetHandler()

void SpaceVIL.Prototype.SetHandler ( CoreWindow  handler)

Set parent window for the Prototype

Implements SpaceVIL.Core.IBaseItem.

◆ SetHeight()

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

◆ SetItemName()

void SpaceVIL.Prototype.SetItemName ( string  name)

Name of the Prototype

Implements SpaceVIL.Core.IItem.

◆ SetMaxHeight()

void SpaceVIL.Prototype.SetMaxHeight ( int  height)

Prototype maximum height

Implements SpaceVIL.Core.ISize.

◆ SetMaxSize()

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

Prototype maximum size (width, height)

◆ SetMaxWidth()

void SpaceVIL.Prototype.SetMaxWidth ( int  width)

Prototype maximum width

Implements SpaceVIL.Core.ISize.

◆ SetMinHeight()

void SpaceVIL.Prototype.SetMinHeight ( int  height)

Prototype minimum height

Implements SpaceVIL.Core.ISize.

◆ SetMinSize()

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

Prototype minimum size (width, height)

◆ SetMinWidth()

void SpaceVIL.Prototype.SetMinWidth ( int  width)

Prototype minimum width

Implements SpaceVIL.Core.ISize.

◆ SetPassEvents() [1/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value)

Sets all InputEventType passed or non passed (value)

◆ SetPassEvents() [2/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value,
InputEventType  e 
)
Parameters
valuepassed or non passed
eInputEventType

◆ SetPassEvents() [3/3]

void SpaceVIL.Prototype.SetPassEvents ( bool  value,
params InputEventType []  e 
)
Parameters
valuepassed or non passed
eInputEventType

◆ SetPosition()

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

Prototype 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 
)

Set Prototype's shadow

Parameters
radiusRadius of the shadow's corners
xX position of the shadow
yY Position of the shadow
colorShadow color

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowRadius()

void SpaceVIL.Prototype.SetShadowRadius ( int  radius)

Radius of the shadows corners

Implements SpaceVIL.Core.IBaseItem.

◆ SetSize()

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

Prototype size (width, height)

Implements SpaceVIL.Core.ISize.

Reimplemented in SpaceVIL.ImageItem.

◆ SetSizePolicy()

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

Prototype size policy (FIXED, EXPAND) by width and height

◆ SetStyle()

virtual void SpaceVIL.Prototype.SetStyle ( Style  style)
virtual

◆ SetWidth()

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

◆ Update()

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

Update Prototype size or position depending on the GeometryEventType

Implements SpaceVIL.Core.IEventUpdate.

◆ UpdateState()

virtual void SpaceVIL.Prototype.UpdateState ( )
protectedvirtual

Update Prototype's state according to its ItemStateType

Member Data Documentation

◆ EventKeyPress

EventKeyMethodState SpaceVIL.Prototype.EventKeyPress

Keyboard input events

◆ EventMouseHover

EventMouseMethodState SpaceVIL.Prototype.EventMouseHover

Mouse input events

◆ EventTextInput

EventInputTextMethodState SpaceVIL.Prototype.EventTextInput

Text input events

◆ IsFocusable

bool SpaceVIL.Prototype.IsFocusable = true

Is Prototype focusable


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