BookmarksGui

Description

sealed class Tinman.AddOns.Components.BookmarksGui

Derived from

Container
IUpdateableGui
IEventListenerGeneric<Component>

Full source code is included in the Tinman 3D SDK download.

A GUI component that allows to manage the JSON settings of a Widget.

The following default Layout settings are defined for BookmarksGui objects:

The GUI uses IWidget.Screenshot on its TargetWidget to save bookmarks, which means that the target IWidget must handle screenshot requests properly. Otherwise, no bookmarks can be saved.

Public / Constants

Bookmark​Count

public constant BookmarkCount → (10:int32)

Number of bookmark slots.

Label​Bookmark

[Localized]
public constant LabelBookmark → ("Bookmark ###":string)

Label for the caption of a bookmark entry.

Label arguments (see Format):
#0 : one-based bookmark index

Label​Delete

[Localized]
public constant LabelDelete → ("Delete":string)

Label of the button to delete a bookmark.

Label​Load

[Localized]
public constant LabelLoad → ("Load":string)

Label of the button to load a bookmark.

Label​Not​Used

[Localized]
public constant LabelNotUsed → (" - not used - ":string)

Label for unused bookmark entries.

Label​Save

[Localized]
public constant LabelSave → ("Save":string)

Label of the button to save a bookmark.

Public / Constructors

Bookmarks​Gui

public constructor BookmarksGui → (2)

targetWidget in : IWidget

The initial target widget.

thumbnailWidth opt : int32 = 320

[>0]
The screenshot thumbnail height, in pixels.

Creates a new instance of BookmarksGui.

Public / Methods

Delete

public method Delete → (1)

bookmark in : int32

[0..BookmarksGui.BookmarkCount-1]
The bookmark index.

Deletes a settings file.

IOException

If an I/O error has occurred while deleting the settings file.

Load

public method Load → (1)

bookmark in : int32

[0..BookmarksGui.BookmarkCount-1]
The bookmark index.

Loads a settings file.

IOException

If an I/O error has occurred while reading the settings file.

ValidatingException

If the contents of the settings file is malformed.

Save

public method Save → (1)

bookmark in : int32

[0..BookmarksGui.BookmarkCount-1]
The bookmark index.

Saves a settings file.

Public / Attributes

Target​Widget

public attribute TargetWidget → (get,set)

value : IWidget

The IWidget object.

The IWidget object to use.

Logging

Logger

public static readonly attribute Logger → (ILogger)

The logger object of this class.