SpaceVIL.ItemsLayoutBox Class Reference

ItemsLayoutBox is a storage-class that provides an access to existing items. More...

Static Public Member Functions
static List< IBaseItem >	GetLayoutItems (Guid id)
	Getting existing static items in specified window by its GUID. Static items are items that depend on their parent. Parent controls their size, position and etc. More...
static List< IBaseItem >	GetLayoutFloatItems (Guid id)
	Getting existing float items in specified window by its GUID. Floating items are independent items that do not have a parent, or their root parent is a floating item. Examples: SideArea, FloatItem, ContextMenu and etc. More...
static void	AddItem (CoreWindow window, IBaseItem item, LayoutType type)
	Adding an item to global item storage (ItemsLayoutBox). In usual situation you do not need to use this function only if you create your own implementation of IBaseItem or create a new implementation of IFloatItem. More...
static bool	RemoveItem (CoreWindow window, IBaseItem item, LayoutType type)
	Removing an item from global item storage (ItemsLayoutBox). In usual situation you do not need to use this function only if you create your own implementation of IBaseItem or want to remove IFloatItem instance. More...
static List< string >	GetListOfItemsNames (CoreWindow window)
	Getting the list of names of existing items in the specified window. More...
static void	PrintListOfItems (CoreWindow window)
	Printing all existing items in the specified window. More...

Detailed Description

ItemsLayoutBox is a storage-class that provides an access to existing items.

Member Function Documentation

AddItem()

static void SpaceVIL.ItemsLayoutBox.AddItem ( CoreWindow  window, IBaseItem  item, LayoutType  type  )

static

Adding an item to global item storage (ItemsLayoutBox). In usual situation you do not need to use this function only if you create your own implementation of IBaseItem or create a new implementation of IFloatItem.

Parameters

window	Any CoreWindow instance.
item	Any IBaseItem instance.
type	Type of an item: SpaceVIL.Core.LayoutType.Static or SpaceVIL.Core.LayoutType.Floating.

GetLayoutFloatItems()

static List<IBaseItem> SpaceVIL.ItemsLayoutBox.GetLayoutFloatItems ( Guid  id )

static

Getting existing float items in specified window by its GUID. Floating items are independent items that do not have a parent, or their root parent is a floating item. Examples: SideArea, FloatItem, ContextMenu and etc.

Parameters

id	GUID of the window.

Returns

The list of existing float items in specified window by its GUID.

GetLayoutItems()

static List<IBaseItem> SpaceVIL.ItemsLayoutBox.GetLayoutItems ( Guid  id )

static

Getting existing static items in specified window by its GUID. Static items are items that depend on their parent. Parent controls their size, position and etc.

Parameters

id	GUID of the window.

Returns

The list of existing static items in specified window by its GUID.

GetListOfItemsNames()

static List<string> SpaceVIL.ItemsLayoutBox.GetListOfItemsNames ( CoreWindow  window )

static

Getting the list of names of existing items in the specified window.

Parameters

window

Any CoreWindow instance.

Returns

The list of names of existing items in the specified window.

PrintListOfItems()

static void SpaceVIL.ItemsLayoutBox.PrintListOfItems ( CoreWindow  window )

static

Printing all existing items in the specified window.

Parameters

window

Any CoreWindow instance.

RemoveItem()

static bool SpaceVIL.ItemsLayoutBox.RemoveItem ( CoreWindow  window, IBaseItem  item, LayoutType  type  )

static

Removing an item from global item storage (ItemsLayoutBox). In usual situation you do not need to use this function only if you create your own implementation of IBaseItem or want to remove IFloatItem instance.

Parameters

window	Any CoreWindow instance.
item	Any IBaseItem instance.
type	Type of an item: SpaceVIL.Core.LayoutType.Static or SpaceVIL.Core.LayoutType.Floating

Returns

True: if removal was successfull. False: if the specified item does not exist in the storage.

---

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

• ItemsLayoutBox.cs