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.CoreWindow Class Referenceabstract

CoreWindow is an abstract class containing an implementation of common functionality for a window. More...

Inherited by SpaceVIL.ActiveWindow, and SpaceVIL.DialogWindow.

Public Member Functions

 CoreWindow ()
 Constructs a CoreWindow. More...
 
void SetParameters (String name, String title)
 Setting basic window attributes. More...
 
void SetParameters (String name, String title, int width, int height)
 Setting basic window attributes More...
 
void SetParameters (String name, String title, int width, int height, bool isBorder)
 Setting basic window attributes. More...
 
virtual void Show ()
 Show the CoreWindow. More...
 
virtual void Close ()
 Close the CoreWindow. More...
 
abstract void InitWindow ()
 This abstract method should provide the initial window attributes, content, events. More...
 
int GetCount ()
 
Returns
Count of all CoreWindows
More...
 
Guid GetWindowGuid ()
 
Returns
CoreWindow unique ID
More...
 
void SetBackground (Color color)
 Setting window background color. More...
 
void SetBackground (int r, int g, int b)
 Setting window background color. More...
 
void SetBackground (int r, int g, int b, int a)
 Setting window background color. More...
 
void SetBackground (float r, float g, float b)
 Setting window background color. More...
 
void SetBackground (float r, float g, float b, float a)
 Setting window background color. More...
 
Color GetBackground ()
 Getting window background color. More...
 
void SetPadding (Indents padding)
 Setting padding indents. Padding is the space that’s inside the element between the element and the border. More...
 
void SetPadding (int left, int top, int right, int bottom)
 Setting padding indents. Padding is the space that’s inside the element between the element and the border. More...
 
List< IBaseItemGetItems ()
 Getting items as a list of IBaseItem items. More...
 
void AddItem (IBaseItem item)
 Adding an item to the window. More...
 
void AddItems (params IBaseItem[] items)
 Allows to add multiple items to the window. More...
 
void InsertItem (IBaseItem item, int index)
 Allows you to insert an item at a specified position. More...
 
bool RemoveItem (IBaseItem item)
 Removing a specified item. More...
 
void Clear ()
 Removing all containing items in the window. More...
 
void SetWindowName (String value)
 Setting the window name. The window name is the string ID of the window and may differ from the window title. More...
 
String GetWindowName ()
 Getting the window name. More...
 
void SetWindowTitle (String title)
 Setting the window title text. More...
 
String GetWindowTitle ()
 Getting the title text. More...
 
void SetWidth (int width)
 Setting the window width. More...
 
void SetHeight (int height)
 Setting the window height. More...
 
void SetSize (int width, int height)
 Setting the window size in pixels: width and height. More...
 
void SetMinWidth (int width)
 Setting the window minimum width. More...
 
void SetMinHeight (int height)
 Setting the window minimum height. More...
 
void SetMinSize (int width, int height)
 Setting the minimum window size in pixels: width and height. More...
 
void SetMaxWidth (int width)
 Setting the window maximum width. More...
 
void SetMaxHeight (int height)
 Setting the window maximum height. More...
 
void SetMaxSize (int width, int height)
 Setting the maximum window size in pixels: width and height. More...
 
int GetMinWidth ()
 Getting the current minimum window width. More...
 
int GetWidth ()
 Getting the current minimum window width. More...
 
int GetMaxWidth ()
 Getting the current maximum window width. More...
 
int GetMinHeight ()
 Getting the current minimum window height. More...
 
int GetHeight ()
 Getting the current window height. More...
 
int GetMaxHeight ()
 Getting the current maximum window height. More...
 
Core.Size GetSize ()
 Getting the current window size. More...
 
void SetX (int x)
 Setting the window x-coordinate (the left-top window corner). Relocating the window at specified x-coordinate. More...
 
int GetX ()
 Getting the current window x-coordinate. More...
 
void SetY (int y)
 Setting the window y-coordinate (the left-top window corner). Relocating the window at specified y-coordinate. More...
 
int GetY ()
 Getting the current window y-coordinate. More...
 
void SetPosition (int x, int y)
 Setting the window x-coordinate and y-coordinate (the left-top window corner). Relocating the window at specified coordinates. More...
 
void SetPosition (Position position)
 Setting the window x-coordinate and y-coordinate (the left-top window corner). Relocating the window at specified coordinates. More...
 
Position GetPosition ()
 Getting the current window position. More...
 
void SetAntiAliasingQuality (MSAA msaa)
 Setting the anti aliasing quality (off, x2, x4, x8). Default: MSAA.MSAA4x More...
 
bool IsFocused ()
 Lets to know if the current window is focused or not. More...
 
void Focus ()
 Sets the window focused. More...
 
void Minimize ()
 Sets the window minimized. More...
 
void Maximize ()
 Sets the window maximized. More...
 
void ToggleFullScreen ()
 Toggles the window to full screen mode or windowed mode. More...
 
Prototype GetFocusedItem ()
 Getting the current focused item in the current window. More...
 
void SetFocusedItem (Prototype item)
 Setting the specified item to the focused state. More...
 
void ResetFocus ()
 Returns focus to the root item of the window. More...
 
void SetIcon (Bitmap iconBig, Bitmap iconSmall)
 Sets the icons of the current window. More...
 
void SetHidden (bool value)
 Hides of unhides the current window. More...
 
void SetRenderFrequency (RedrawFrequency value)
 Lets to set the rendering frequency. Default: SpaceVIL.Core.RedrawFrequency.Low More...
 
RedrawFrequency GetRenderFrequency ()
 Getting the current rendering frequency. More...
 
void SetAspectRatio (int w, int h)
 Lets to set aspect ratio. More...
 
void SetBorder (Border border)
 Setting the border of the root item of the window. More...
 
void SetBorderFill (Color fill)
 Setting the color of the window border. More...
 
void SetBorderFill (int r, int g, int b)
 Setting the color of the window border. More...
 
void SetBorderFill (int r, int g, int b, int a)
 Setting the color of the window border. More...
 
void SetBorderFill (float r, float g, float b)
 Setting the color of the window border. More...
 
void SetBorderFill (float r, float g, float b, float a)
 Setting the color of the window border. More...
 
void SetBorderRadius (CornerRadius radius)
 Setting the corner radii of the window border. More...
 
void SetBorderRadius (int radius)
 Setting the common corner radius of the window border. More...
 
void SetBorderThickness (int thickness)
 Setting the window border thickness. More...
 
CornerRadius GetBorderRadius ()
 Getting the current window border corner radii. More...
 
int GetBorderThickness ()
 Getting the current window border thickness. More...
 
Color GetBorderFill ()
 Getting the current window border color. More...
 
Int64 GetGLWID ()
 Getting the GLFW ID of the window. More...
 
void SetShadeColor (Color color)
 Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window. More...
 
void SetShadeColor (int r, int g, int b)
 Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window. More...
 
void SetShadeColor (int r, int g, int b, int a)
 Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window. More...
 
void SetShadeColor (float r, float g, float b)
 Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window. More...
 
void SetShadeColor (float r, float g, float b, float a)
 Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window. More...
 
Color GetShadeColor ()
 Getting the current dimmer color. More...
 
Area GetWorkArea ()
 Getting the area of a primary monitor. The work area not occupied by global task bars or menu bars. More...
 
Scale GetDpiScale ()
 Getting DPI scale for the current window. More...
 
void Hold ()
 Makes this window inactive. Window cannot receive and process any input events. Tip: to restore window activity use CoreWindow.Proceed(). More...
 
void Proceed ()
 Restores window activity. Window may receive and process any input events. Tip: used with CoreWindow.Hold() method which makes a window inactive. More...
 

Public Attributes

bool IsDialog
 A flag that determines whether the current window is dialog or not. True: window is dialog. False: window is NOT dialog. Default: False. More...
 
bool IsClosed
 A flag that determines whether the current window is in closed state or not. True: window is closed. False: window is opened. Default: True. More...
 
bool IsHidden
 A flag that determines whether the current window is in hidden state or not. True: window is hidden. False: window is unhidden. Default: False. More...
 
bool IsResizable
 A flag that determines whether the current window can be resize or not. True: window is resizable. False: window is NOT resizable. Default: True. More...
 
bool IsAlwaysOnTop
 A flag that determines whether the current window is always on top of all other windows or not. True: window is on top. False: window is NOT on top. Default: False. More...
 
bool IsBorderHidden
 A flag that shows/hides native the current window border decoration. True: native window border is HIDDEN. False: native window border is SHOWN. Default: False. More...
 
bool IsCentered
 A flag that determines whether the current window will first appear in the center of the screen or not. True: window is centered. False: window is NOT centered. Default: True. More...
 
bool IsFocusable
 
bool IsOutsideClickClosable
 A flag that determines whether the current window can be closed if the mouse is clicked outside of the current window or not. True: window can be closed if the mouse is clicked outside. False: window can NOT be closed if the mouse is clicked outside. Default: False. More...
 
bool IsMaximized
 A flag that determines whether the current window will first appear maximized or not. True: window will first appear maximized. False: window will NOT first appear maximized. Default: False. More...
 
bool IsTransparent
 A flag that determines whether the current window can be transparent or not. True: window can be transparent. False: window can NOT be transparent. Default: False. More...
 
EventCommonMethod EventOnStart
 Lets to describe the actions when the window starts. More...
 
EventCommonMethod EventClose
 Lets to describe the actions when closing the window. More...
 
EventWindowDropMethod EventDrop
 Lets to describe the actions when you drag and drop files/folders to the current window. More...
 
EventCommonMethodState EventResize
 ATTENTION! Not implemented yet. More...
 
EventCommonMethodState EventDestroy
 ATTENTION! Not implemented yet. More...
 
EventMouseMethodState EventMouseHover
 Lets to describe the actions when mouse cursor hovers the root item of the window. More...
 
EventMouseMethodState EventMouseLeave
 Lets to describe the actions when mouse cursor leaves the root item of the window. More...
 
EventMouseMethodState EventMouseClick
 Lets to describe the actions when the root item of the window was clicked. More...
 
EventMouseMethodState EventMouseDoubleClick
 Lets to describe the actions when the root item of the window was double clicked. More...
 
EventMouseMethodState EventMousePress
 Lets to describe the actions when the root item of the window was pressed. More...
 
EventMouseMethodState EventMouseDrag
 Lets to describe the actions when the mouse button was pressed and moved inside the root item of the window. More...
 
EventMouseMethodState EventMouseDrop
 Lets to describe the actions when the mouse button was released after dragging. More...
 
EventMouseMethodState EventScrollUp
 Lets to describe the actions when mouse wheel scrolls up. More...
 
EventMouseMethodState EventScrollDown
 Lets to describe the actions when mouse wheel scrolls down. More...
 
EventKeyMethodState EventKeyPress
 Lets to describe the actions when a keyboard key was pressed. More...
 
EventKeyMethodState EventKeyRelease
 Lets to describe the actions when a keyboard key was released. More...
 
EventInputTextMethodState EventTextInput
 Lets to describe the actions when you type text. More...
 

Detailed Description

CoreWindow is an abstract class containing an implementation of common functionality for a window.

Constructor & Destructor Documentation

◆ CoreWindow()

SpaceVIL.CoreWindow.CoreWindow ( )

Constructs a CoreWindow.

Member Function Documentation

◆ AddItem()

void SpaceVIL.CoreWindow.AddItem ( IBaseItem  item)

Adding an item to the window.

Parameters
itemAn instance of any IBaseItem class.

◆ AddItems()

void SpaceVIL.CoreWindow.AddItems ( params IBaseItem[]  items)

Allows to add multiple items to the window.

Parameters
itemsAn instance of any IBaseItem class.

◆ Clear()

void SpaceVIL.CoreWindow.Clear ( )

Removing all containing items in the window.

◆ Close()

virtual void SpaceVIL.CoreWindow.Close ( )
virtual

Close the CoreWindow.

Reimplemented in SpaceVIL.MessageBox.

◆ Focus()

void SpaceVIL.CoreWindow.Focus ( )

Sets the window focused.

◆ GetBackground()

Color SpaceVIL.CoreWindow.GetBackground ( )

Getting window background color.

Returns
Returns background color as System.Drawing.Color

◆ GetBorderFill()

Color SpaceVIL.CoreWindow.GetBorderFill ( )

Getting the current window border color.

Returns
The border color as System.Drawing.Color

◆ GetBorderRadius()

CornerRadius SpaceVIL.CoreWindow.GetBorderRadius ( )

Getting the current window border corner radii.

Returns
Corner radii as SpaceVIL.Decorations.CornerRadius

◆ GetBorderThickness()

int SpaceVIL.CoreWindow.GetBorderThickness ( )

Getting the current window border thickness.

Returns
The current thickness.

◆ GetCount()

int SpaceVIL.CoreWindow.GetCount ( )

Returns
Count of all CoreWindows

◆ GetDpiScale()

Scale SpaceVIL.CoreWindow.GetDpiScale ( )

Getting DPI scale for the current window.

Returns
DPI scale as SpaceVIL.Core.Scale

◆ GetFocusedItem()

Prototype SpaceVIL.CoreWindow.GetFocusedItem ( )

Getting the current focused item in the current window.

Returns
SpaceVIL.Prototype (abstract class for interactive items).

◆ GetGLWID()

Int64 SpaceVIL.CoreWindow.GetGLWID ( )

Getting the GLFW ID of the window.

Returns
ID of the window.

◆ GetHeight()

int SpaceVIL.CoreWindow.GetHeight ( )

Getting the current window height.

Returns
Current height in pixels.

◆ GetItems()

List<IBaseItem> SpaceVIL.CoreWindow.GetItems ( )

Getting items as a list of IBaseItem items.

Returns
Returns a list of contained items in the window.

◆ GetMaxHeight()

int SpaceVIL.CoreWindow.GetMaxHeight ( )

Getting the current maximum window height.

Returns
Current maximum height in pixels.

◆ GetMaxWidth()

int SpaceVIL.CoreWindow.GetMaxWidth ( )

Getting the current maximum window width.

Returns
Current maximum width in pixels.

◆ GetMinHeight()

int SpaceVIL.CoreWindow.GetMinHeight ( )

Getting the current minimum window height.

Returns
Current minimum height in pixels.

◆ GetMinWidth()

int SpaceVIL.CoreWindow.GetMinWidth ( )

Getting the current minimum window width.

Returns
Current minimum width in pixels.

◆ GetPosition()

Position SpaceVIL.CoreWindow.GetPosition ( )

Getting the current window position.

Returns
X-coordinate and Y-coordinate provided as SpaceVIL.Core.Position

◆ GetRenderFrequency()

RedrawFrequency SpaceVIL.CoreWindow.GetRenderFrequency ( )

Getting the current rendering frequency.

Returns
Rendering frequency as SpaceVIL.Core.RedrawFrequency

◆ GetShadeColor()

Color SpaceVIL.CoreWindow.GetShadeColor ( )

Getting the current dimmer color.

Returns
The dimmer color as System.Drawing.Color

◆ GetSize()

Core.Size SpaceVIL.CoreWindow.GetSize ( )

Getting the current window size.

Returns
Current window size as SpaceVIL.Core.Size.

◆ GetWidth()

int SpaceVIL.CoreWindow.GetWidth ( )

Getting the current minimum window width.

Returns
Current minimum width in pixels.

◆ GetWindowGuid()

Guid SpaceVIL.CoreWindow.GetWindowGuid ( )

Returns
CoreWindow unique ID

◆ GetWindowName()

String SpaceVIL.CoreWindow.GetWindowName ( )

Getting the window name.

Returns
Window name.

◆ GetWindowTitle()

String SpaceVIL.CoreWindow.GetWindowTitle ( )

Getting the title text.

Returns
Title text.

◆ GetWorkArea()

Area SpaceVIL.CoreWindow.GetWorkArea ( )

Getting the area of a primary monitor. The work area not occupied by global task bars or menu bars.

Returns
Work area as SpaceVIL.Core.Area

◆ GetX()

int SpaceVIL.CoreWindow.GetX ( )

Getting the current window x-coordinate.

Returns
Current x-coordinate.

◆ GetY()

int SpaceVIL.CoreWindow.GetY ( )

Getting the current window y-coordinate.

Returns
Current y-coordinate.

◆ Hold()

void SpaceVIL.CoreWindow.Hold ( )

Makes this window inactive. Window cannot receive and process any input events. Tip: to restore window activity use CoreWindow.Proceed().

◆ InitWindow()

abstract void SpaceVIL.CoreWindow.InitWindow ( )
pure virtual

This abstract method should provide the initial window attributes, content, events.

Implemented in SpaceVIL.MessageBox.

◆ InsertItem()

void SpaceVIL.CoreWindow.InsertItem ( IBaseItem  item,
int  index 
)

Allows you to insert an item at a specified position.

Parameters
itemAn instance of any IBaseItem class.
indexIndex of position.

◆ IsFocused()

bool SpaceVIL.CoreWindow.IsFocused ( )

Lets to know if the current window is focused or not.

Returns
True: if the current window is focused. False: if the current window is unfocused.

◆ Maximize()

void SpaceVIL.CoreWindow.Maximize ( )

Sets the window maximized.

◆ Minimize()

void SpaceVIL.CoreWindow.Minimize ( )

Sets the window minimized.

◆ Proceed()

void SpaceVIL.CoreWindow.Proceed ( )

Restores window activity. Window may receive and process any input events. Tip: used with CoreWindow.Hold() method which makes a window inactive.

◆ RemoveItem()

bool SpaceVIL.CoreWindow.RemoveItem ( IBaseItem  item)

Removing a specified item.

Parameters
itemAn instance of any IBaseItem class.
Returns
True: if the window cantained the specified item and it was successfully removed. False: if the window did not cantain the specified item.

◆ ResetFocus()

void SpaceVIL.CoreWindow.ResetFocus ( )

Returns focus to the root item of the window.

◆ SetAntiAliasingQuality()

void SpaceVIL.CoreWindow.SetAntiAliasingQuality ( MSAA  msaa)

Setting the anti aliasing quality (off, x2, x4, x8). Default: MSAA.MSAA4x

Parameters
msaaSpaceVIL.Core.MSAA anti aliasing quality.

◆ SetAspectRatio()

void SpaceVIL.CoreWindow.SetAspectRatio ( int  w,
int  h 
)

Lets to set aspect ratio.

Parameters
wWidth value.
hHeight value.

◆ SetBackground() [1/5]

void SpaceVIL.CoreWindow.SetBackground ( Color  color)

Setting window background color.

Parameters
colorSystem.Drawing.Color.FromARGB(alpha, red, green, blue)

◆ SetBackground() [2/5]

void SpaceVIL.CoreWindow.SetBackground ( float  r,
float  g,
float  b 
)

Setting window background color.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)

◆ SetBackground() [3/5]

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

Setting window background color.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)
aAlpha (0.0f - 1.0f)

◆ SetBackground() [4/5]

void SpaceVIL.CoreWindow.SetBackground ( int  r,
int  g,
int  b 
)

Setting window background color.

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

◆ SetBackground() [5/5]

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

Setting window background color.

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)

◆ SetBorder()

void SpaceVIL.CoreWindow.SetBorder ( Border  border)

Setting the border of the root item of the window.

Parameters
borderBorder as SpaceVIL.Decorations.Border

◆ SetBorderFill() [1/5]

void SpaceVIL.CoreWindow.SetBorderFill ( Color  fill)

Setting the color of the window border.

Parameters
fillColor as System.Drawing.Color

◆ SetBorderFill() [2/5]

void SpaceVIL.CoreWindow.SetBorderFill ( float  r,
float  g,
float  b 
)

Setting the color of the window border.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)

◆ SetBorderFill() [3/5]

void SpaceVIL.CoreWindow.SetBorderFill ( float  r,
float  g,
float  b,
float  a 
)

Setting the color of the window border.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)
aAlpha (0.0f - 1.0f)

◆ SetBorderFill() [4/5]

void SpaceVIL.CoreWindow.SetBorderFill ( int  r,
int  g,
int  b 
)

Setting the color of the window border.

Parameters
rRed (0 - 255)
gGreen (0 - 255)
bBlue (0 - 255)

◆ SetBorderFill() [5/5]

void SpaceVIL.CoreWindow.SetBorderFill ( int  r,
int  g,
int  b,
int  a 
)

Setting the color of the window border.

Parameters
rRed (0 - 255)
gGreen (0 - 255)
bBlue (0 - 255)
aAlpha (0 - 255)

◆ SetBorderRadius() [1/2]

void SpaceVIL.CoreWindow.SetBorderRadius ( CornerRadius  radius)

Setting the corner radii of the window border.

Parameters
radiusCorner radii as SpaceVIL.Decorations.CornerRadius

◆ SetBorderRadius() [2/2]

void SpaceVIL.CoreWindow.SetBorderRadius ( int  radius)

Setting the common corner radius of the window border.

Parameters
radiusThe corner radius.

◆ SetBorderThickness()

void SpaceVIL.CoreWindow.SetBorderThickness ( int  thickness)

Setting the window border thickness.

Parameters
thicknessThe border thickness.

◆ SetFocusedItem()

void SpaceVIL.CoreWindow.SetFocusedItem ( Prototype  item)

Setting the specified item to the focused state.

Parameters
itemAny item that can be focused and extends of SpaceVIL.Prototype (abstract class for interactive items).

◆ SetHeight()

void SpaceVIL.CoreWindow.SetHeight ( int  height)

Setting the window height.

Parameters
heightHeight in pixels.

◆ SetHidden()

void SpaceVIL.CoreWindow.SetHidden ( bool  value)

Hides of unhides the current window.

Parameters
valueTrue: if you want to hide the window. False: if you want tu unhide the window.

◆ SetIcon()

void SpaceVIL.CoreWindow.SetIcon ( Bitmap  iconBig,
Bitmap  iconSmall 
)

Sets the icons of the current window.

Parameters
iconBigTask bar icon.
iconSmallTitle bar icon.

◆ SetMaxHeight()

void SpaceVIL.CoreWindow.SetMaxHeight ( int  height)

Setting the window maximum height.

Parameters
heightMaximum height in pixels.

◆ SetMaxSize()

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

Setting the maximum window size in pixels: width and height.

Parameters
widthMaximum width in pixels.
heightMaximum height in pixels.

◆ SetMaxWidth()

void SpaceVIL.CoreWindow.SetMaxWidth ( int  width)

Setting the window maximum width.

Parameters
widthMaximum width in pixels.

◆ SetMinHeight()

void SpaceVIL.CoreWindow.SetMinHeight ( int  height)

Setting the window minimum height.

Parameters
heightMinimum height in pixels.

◆ SetMinSize()

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

Setting the minimum window size in pixels: width and height.

Parameters
widthMinimum width in pixels.
heightMinimum height in pixels.

◆ SetMinWidth()

void SpaceVIL.CoreWindow.SetMinWidth ( int  width)

Setting the window minimum width.

Parameters
widthMinimum width in pixels.

◆ SetPadding() [1/2]

void SpaceVIL.CoreWindow.SetPadding ( Indents  padding)

Setting padding indents. Padding is the space that’s inside the element between the element and the border.

Parameters
paddingSpaceVIL.Decorations.Indents(int left, int top, int right, int bottom)

◆ SetPadding() [2/2]

void SpaceVIL.CoreWindow.SetPadding ( int  left,
int  top,
int  right,
int  bottom 
)

Setting padding indents. Padding is the space that’s inside the element between the element and the border.

Parameters
leftLeft indent.
topTop indent.
rightRight indent.
bottomBottom indent.

◆ SetParameters() [1/3]

void SpaceVIL.CoreWindow.SetParameters ( String  name,
String  title 
)

Setting basic window attributes.

Parameters
nameWindow name.
titleTitle text.

◆ SetParameters() [2/3]

void SpaceVIL.CoreWindow.SetParameters ( String  name,
String  title,
int  width,
int  height 
)

Setting basic window attributes

Parameters
nameWindow name.
titleTitle text.
widthWindow width in pixels.
heightWindow height in pixels.

◆ SetParameters() [3/3]

void SpaceVIL.CoreWindow.SetParameters ( String  name,
String  title,
int  width,
int  height,
bool  isBorder 
)

Setting basic window attributes.

Parameters
nameWindow name.
titleTitle text.
widthWindow width in pixels.
heightWindow height in pixels.
isBorderA flag that shows/hides native window border decoration.

◆ SetPosition() [1/2]

void SpaceVIL.CoreWindow.SetPosition ( int  x,
int  y 
)

Setting the window x-coordinate and y-coordinate (the left-top window corner). Relocating the window at specified coordinates.

Parameters
xX-Coordinate.
yY-Coordinate.

◆ SetPosition() [2/2]

void SpaceVIL.CoreWindow.SetPosition ( Position  position)

Setting the window x-coordinate and y-coordinate (the left-top window corner). Relocating the window at specified coordinates.

Parameters
positionX-coordinate and Y-coordinate provided as SpaceVIL.Core.Position

◆ SetRenderFrequency()

void SpaceVIL.CoreWindow.SetRenderFrequency ( RedrawFrequency  value)

Lets to set the rendering frequency. Default: SpaceVIL.Core.RedrawFrequency.Low

Parameters
valueRendering frequency as SpaceVIL.Core.RedrawFrequency.

◆ SetShadeColor() [1/5]

void SpaceVIL.CoreWindow.SetShadeColor ( Color  color)

Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window.

Parameters
colorThe dimmer color as System.Drawing.Color

◆ SetShadeColor() [2/5]

void SpaceVIL.CoreWindow.SetShadeColor ( float  r,
float  g,
float  b 
)

Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)

◆ SetShadeColor() [3/5]

void SpaceVIL.CoreWindow.SetShadeColor ( float  r,
float  g,
float  b,
float  a 
)

Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window.

Parameters
rRed (0.0f - 1.0f)
gGreen (0.0f - 1.0f)
bBlue (0.0f - 1.0f)
aAlpha (0.0f - 1.0f)

◆ SetShadeColor() [4/5]

void SpaceVIL.CoreWindow.SetShadeColor ( int  r,
int  g,
int  b 
)

Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window.

Parameters
rRed (0 - 255)
gGreen (0 - 255)
bBlue (0 - 255)

◆ SetShadeColor() [5/5]

void SpaceVIL.CoreWindow.SetShadeColor ( int  r,
int  g,
int  b,
int  a 
)

Setting the dimmer color of the window. The dimmer appears when the current window opens a dialog window.

Parameters
rRed (0 - 255)
gGreen (0 - 255)
bBlue (0 - 255)
aAlpha (0 - 255)

◆ SetSize()

void SpaceVIL.CoreWindow.SetSize ( int  width,
int  height 
)

Setting the window size in pixels: width and height.

Parameters
widthWidth in pixels.
heightHeight in pixels.

◆ SetWidth()

void SpaceVIL.CoreWindow.SetWidth ( int  width)

Setting the window width.

Parameters
widthWidth in pixels.

◆ SetWindowName()

void SpaceVIL.CoreWindow.SetWindowName ( String  value)

Setting the window name. The window name is the string ID of the window and may differ from the window title.

Parameters
valueWindow name.

◆ SetWindowTitle()

void SpaceVIL.CoreWindow.SetWindowTitle ( String  title)

Setting the window title text.

Parameters
titleTitle text.

◆ SetX()

void SpaceVIL.CoreWindow.SetX ( int  x)

Setting the window x-coordinate (the left-top window corner). Relocating the window at specified x-coordinate.

Parameters
xX-Coordinate.

◆ SetY()

void SpaceVIL.CoreWindow.SetY ( int  y)

Setting the window y-coordinate (the left-top window corner). Relocating the window at specified y-coordinate.

Parameters
yY-Coordinate.

◆ Show()

virtual void SpaceVIL.CoreWindow.Show ( )
virtual

Show the CoreWindow.

Reimplemented in SpaceVIL.MessageBox, and SpaceVIL.DialogWindow.

◆ ToggleFullScreen()

void SpaceVIL.CoreWindow.ToggleFullScreen ( )

Toggles the window to full screen mode or windowed mode.

Member Data Documentation

◆ EventClose

EventCommonMethod SpaceVIL.CoreWindow.EventClose

Lets to describe the actions when closing the window.

◆ EventDestroy

EventCommonMethodState SpaceVIL.CoreWindow.EventDestroy

ATTENTION! Not implemented yet.

◆ EventDrop

EventWindowDropMethod SpaceVIL.CoreWindow.EventDrop

Lets to describe the actions when you drag and drop files/folders to the current window.

◆ EventKeyPress

EventKeyMethodState SpaceVIL.CoreWindow.EventKeyPress

Lets to describe the actions when a keyboard key was pressed.

◆ EventKeyRelease

EventKeyMethodState SpaceVIL.CoreWindow.EventKeyRelease

Lets to describe the actions when a keyboard key was released.

◆ EventMouseClick

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseClick

Lets to describe the actions when the root item of the window was clicked.

◆ EventMouseDoubleClick

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseDoubleClick

Lets to describe the actions when the root item of the window was double clicked.

◆ EventMouseDrag

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseDrag

Lets to describe the actions when the mouse button was pressed and moved inside the root item of the window.

◆ EventMouseDrop

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseDrop

Lets to describe the actions when the mouse button was released after dragging.

◆ EventMouseHover

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseHover

Lets to describe the actions when mouse cursor hovers the root item of the window.

◆ EventMouseLeave

EventMouseMethodState SpaceVIL.CoreWindow.EventMouseLeave

Lets to describe the actions when mouse cursor leaves the root item of the window.

◆ EventMousePress

EventMouseMethodState SpaceVIL.CoreWindow.EventMousePress

Lets to describe the actions when the root item of the window was pressed.

◆ EventOnStart

EventCommonMethod SpaceVIL.CoreWindow.EventOnStart

Lets to describe the actions when the window starts.

◆ EventResize

EventCommonMethodState SpaceVIL.CoreWindow.EventResize

ATTENTION! Not implemented yet.

◆ EventScrollDown

EventMouseMethodState SpaceVIL.CoreWindow.EventScrollDown

Lets to describe the actions when mouse wheel scrolls down.

◆ EventScrollUp

EventMouseMethodState SpaceVIL.CoreWindow.EventScrollUp

Lets to describe the actions when mouse wheel scrolls up.

◆ EventTextInput

EventInputTextMethodState SpaceVIL.CoreWindow.EventTextInput

Lets to describe the actions when you type text.

◆ IsAlwaysOnTop

bool SpaceVIL.CoreWindow.IsAlwaysOnTop

A flag that determines whether the current window is always on top of all other windows or not. True: window is on top. False: window is NOT on top. Default: False.

◆ IsBorderHidden

bool SpaceVIL.CoreWindow.IsBorderHidden

A flag that shows/hides native the current window border decoration. True: native window border is HIDDEN. False: native window border is SHOWN. Default: False.

◆ IsCentered

bool SpaceVIL.CoreWindow.IsCentered

A flag that determines whether the current window will first appear in the center of the screen or not. True: window is centered. False: window is NOT centered. Default: True.

◆ IsClosed

bool SpaceVIL.CoreWindow.IsClosed

A flag that determines whether the current window is in closed state or not. True: window is closed. False: window is opened. Default: True.

◆ IsDialog

bool SpaceVIL.CoreWindow.IsDialog

A flag that determines whether the current window is dialog or not. True: window is dialog. False: window is NOT dialog. Default: False.

◆ IsFocusable

bool SpaceVIL.CoreWindow.IsFocusable

A flag that determines whether the current window can be in focused state or not.

True: window is focusable. False: window is NOT focusable.

Default: True.

◆ IsHidden

bool SpaceVIL.CoreWindow.IsHidden

A flag that determines whether the current window is in hidden state or not. True: window is hidden. False: window is unhidden. Default: False.

◆ IsMaximized

bool SpaceVIL.CoreWindow.IsMaximized

A flag that determines whether the current window will first appear maximized or not. True: window will first appear maximized. False: window will NOT first appear maximized. Default: False.

◆ IsOutsideClickClosable

bool SpaceVIL.CoreWindow.IsOutsideClickClosable

A flag that determines whether the current window can be closed if the mouse is clicked outside of the current window or not. True: window can be closed if the mouse is clicked outside. False: window can NOT be closed if the mouse is clicked outside. Default: False.

◆ IsResizable

bool SpaceVIL.CoreWindow.IsResizable

A flag that determines whether the current window can be resize or not. True: window is resizable. False: window is NOT resizable. Default: True.

◆ IsTransparent

bool SpaceVIL.CoreWindow.IsTransparent

A flag that determines whether the current window can be transparent or not. True: window can be transparent. False: window can NOT be transparent. Default: False.


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