7-UI図書館物？と特性 - Guru Mods!!!! 別館色々置き場

7 UI Library Objects and Properties
The user interface consists of widgets and styles. This section describes the objects and their properties.

Please let us know what additional details are necessary.

7.1 BaseObject
Parent : none
The class everything inherits from

Name - identifier
String

application properties - additional properties
String, (bool, integer, etc)

7.2 Effector Group
An effector enables an object to change over time and can be attached as a property

7.2.1 Effector
Parent: BaseObject
The base effector

No properties

7.2.2 ColorEffector
Parent : Effector
change color over time
default color is widget color

Speed
float

TargetColor
Color

Background - color for widget background color
bool

BackgroundTint - color for widget background tint color
bool

7.2.3 LocationEffector
Parent : Effector
change location over time

Speed - how fast to move in x,y
Point (x,y)

TargetLocation - destination
Point (x,y)

7.2.4 OpacityEffector
Parent: Effector
change opacity over time
default is widget opacity

Speed -
float

TargetOpacity - destination
float (0,0 - 1.0)

Background - if true, background opacity.
bool

7.2.5 RotationEffector
Parent: Effector
change rotation over time

Period - time to rotate completely
float

7.2.6 ScrollLocationEffector
Parent: Effector
change scroll location over time

Speed - scroll speed for x,y
Point (x,y)

TargetScrollLocation - destination
Point (x,y)

7.2.7 SizeEffector
Parent: Effector
change size over time

Speed - size speed for x,y
Point (x,y)

TargetSize - destination
Point (x,y)

7.3 Page Group
Pages are widgets whose primary purpose is to contain other widgets.

7.3.1 Page
Parent : Widget
The base page class

ClipToPage - if true, clipping is on.
bool

7.3.2 ComboBox
Parent : Page
A dropdown menu that allows the user to type in the selection

ButtonStyle

ButtonWidth
integer

Editable
bool

ListStyle

ScrollbarStyle

TextboxStyle

DataSource

DropDownHeight
integer

SelectedIndex
Integer

SelectedText
string

7.3.3 Composite
Parent : Page
Page that automatically spaces visible widgets

Orientation
Horizontal/Vertical

Spacing - gap size
integer

SpacingType
Fill - make the widgets take up all the space
Spread - spread the widgets equally
Constant - fixed spacing

Alignment
Front - left/top
Center - center
Back - right/bottom

Padding -
Internal - spacing between items
External - spacing on the outside
Both - spacing both between and on the outside

7.3.4 PopupMenu
Parent : Page

Style
PopupMenuStyle

* apparently requires a DataSource but no property

7.3.5 PopupMenuStyle
Parent : WidgetStyle
The style for a PopupMenu

ButtonStyle - style for buttons created from data
ButtonStyle

ItemHeight - height
integer

7.3.6 RadialMenu
Parent : Page
menu that is circular

DataSource

Style
RadialMenuStyle

PopupDataNamespace - the menu that appears
Namespace

7.3.7 RadialMenuStyle
Parent : WidgetStyle
Style for a RadialMenu

ItemHeight -
integer

ItemMargin - space between items
Point (x,y)

ButtonStyleNW
ButtonStyleN
ButtonStyleNE
ButtonStyleE
ButtonStyleSE
ButtonStyleS
ButtonStyleSW
ButtonStyleW
ImageStyle

ItemPopupTimeout - time before menu disappears
integer

ItemPopupMenuStyle
PopupMenuStyle

7.3.8 TabbedPane
Parent : Page

DataSource

ActiveTab - index to active tab
integer (-1 for none)

Style
TabbedPaneStyle

TargetPage - pages
Page

7.3.9 TabbedPaneStyle
Parent : WidgetStyle
Style for a TabbedPane

ButtonStyle - button for tabs
ButtonStyle

7.3.10 VolumePage
Parent : Page

CellSize
Point (x,y)

CellPadding
Point (x,y)

CellMax
integer

CellCount
integer

CellCountFixed -
integer

CellForceDragable -
bool

CellSelectable
bool

CellDragAccept
bool

MultiSelection
bool

CellAlignmentV
Top
Center
Bottom

CellAlignmentH
Left
Center
Right

CellSelectionOverlay
RectangleStyle

VolumeFill  defines the fill order
Left2Right_Down (default)
Left2Right_Up
Right2Left_Down
Right2Left_Up
Down_Left2Right
Down_Right2Left
Up_Left2Right
Up_Right2Left

7.4 Widget Group
A widget is a visible control. Some controls contain other controls.
7.4.1 Widget
Parent : BaseObject
The base widget

AbsorbsInput - control wants input
bool

Activated - selected
bool

BackgroundColor
Color

BackgroundTint
Color

BackgroundOpacity
float (0.0-1.0)

BoundaryPolygon - non-rectangular hit areas
points

Color
color

ContextToParent
bool

ContextCapable
bool

Cursor

CursorSet

Dragable
bool

DragAccepts - types
string

DragBadCursor
DragGoodCursor
Cursor

DragType
string

DropToParent
bool

Enabled -
bool

Focus - has focus
bool

GetsInput -
bool

HideSound - sound name
ShowSound - sound name
String

LocalTooltip - tooltip string after being mapped
string

Location -
Point (x,y)

Maximum Size -
Point (x,y)

MinimumScrollExtent - amount you can scroll
Point (x,y)

MinimumSize -
Point (x,y)

OnActive - action
OnDeactivate - action
OnDisable - action
OnEnable - action
OnHide - action
OnHoverIn - action
OnHoverOut - action
OnShow - action
string

OnActiveEffector - effector
OnDeactivateEffector - effector
OnDisableEffector - effector
OnEnableEffector - effector
OnHideEffector - effector
OnHoverInEffector - effector
OnHoverOutEffector - effector
OnShowEffector - effector
Effector

PackLocation
PackLocationProp
PackSize
PackSizeProp
see notes

Rotation
float (0.0-1.0)

ScrollExtent - maximum amount you can scroll
Point (x,y)

ScrollLocation - current scroll amount
Point( x,y )

Shear -

Size
Point (x,y)

SizeIncrement - amount to scroll per tick
Point (x,y)

Tooltip
string

TooltipStyle

Visible -
bool

UserMovable -
bool

UserResizable
bool

UserScrollable
bool

RStyleDefault
RStyleDisabled
RStyleSelected
RStyleMouseOver
RStyleMouseOverSelected
RStyleActivated
RStyleMouseOverActivated
RStyleDisabledActivated
RectangleStyle

7.4.2 Button
Parent : Widget
A control that triggers an action when pressed

OnPress - action to call when button is pressed

Style
ButtonStyle

Text -
String

LocalText - text after being mapped
String

TextColor
Color

TextMaxLines
Integer

IsCancelButton - if true, called on escape
bool

IsDefaultButton - if true, called on enter
bool

PressSound -
ReleaseSound -
MouseOverSound -
String

7.4.3 ButtonStyle
Parent : WidgetStyle
Style for a button

NormalTextStyle
SelectedTextStyle
DisabledTextStyle
PressedTextStyle
MouseOverTextStyle
TextStyle

NormalTextShadowStyle
SelectedTextShadowStyle
DisabledTextShadowStyle
PressedTextShadowStyle
MouseOverTextShadowStyle
ShadowStyle

NormalTextColor
SelectedTextColor
DisabledTextColor
PressedTextColor
MouseOverTextColor
Color

PressSound - sound name
ReleaseSound - sound name
MouseOverSound - sound name
String

TextAlignment - horizontal alignment
Left
Center
Right

TextVerticalAlignment - vertical alignment
Top
Center
Bottom

7.4.4 Checkbox
Parent : Widget
A button that remembers its state.

Checked - true if pressed
bool

OnPress - action

OnSet - action if checked

OnUnset - action when unchecked

Style
CheckboxStyle

Text -
String

LocalText - string after being mapped
String

MouseOverSound - sound name
SetSound - sound name
UnsetSound - sound name
String

TextColor - normal text color
Color

Radio - part of a radio group
bool

7.4.5 CheckboxStyle
Parent : WidgetStyle
Style for a checkbox

CheckboxSize - image size
Point (x,y)

CheckboxOffset - image offset
Point (x,y)

NormalTextStyle
DisabledTextStyle
TextStyle

NormalTextShadowStyle
DisabledTextShadowStyle
ShadowStyle

TextOffset - text offset
Point (x,y)

MouseOverSound - sound name
SetSound - sound name
UnsetSound - sound name
String

7.4.6 Dropdownbox
Parent : Widget
A list that can be minimized to the selected entry
See also: Combobox

DataSouce

OnSelect - action
String

SelectedItem - text for selected item
string

SelectedItemIndex - index of selected item
integer

Style
DropdownboxStyle

RowTemplate - description of row
Template

OpenSound - sound name
CloseSound - sound name
String

7.4.7 DropdownboxStyle
Parent : WidgetStyle
Style for a dropdownbox

Normal.StartCap
Normal.Background
Normal.DownArrow
Disabled.StartCap
Disabled.Background
Disabled.DownArrow
Selected.StartCap
Selected.Background
Selected.DownArrow
Pressed.StartCap
Pressed.Background
Pressed.DownArrow
ImageStyle

DropBy - amount to drop the list when open
integer

Padding - amount of space around the list
Rect (left,top,right,bottom)

Scrollbar.Style - scrollbar information
ScrollbarStyle

Listbox.Style - listbox information
ListboxStyle

OpenSound - sound name
CloseSound - sound name
String

7.4.8 Ellipse
Parent : Widget
an ellipse or pie

ArcBegin -
float (0.0 - 1.0)

ArcEnd -
float (0.0 - 1.0)

InnerRadiusColor
Color
InnerRadiusOpacity -
float (0.0 - 1.0)

Thickness - widget of the line
float

7.4.9 Grid
Parent : Widget
A multidimension list

CellCount - number of cells
Point (x,y)

CellSize - size of each cell
Point (x,y)

DataSource - data

SelectedItem - index

Style
GridStyle

Tooltip - tooltip if nothing is in the cell
String

7.4.10 GridStyle
Parent : WidgetStyle
Style for a Grid

Normal.Background - cell background
Normal.Junction - corner
Normal.VStartCap - vertical start
Normal.VBackground - vertical line
Normal.Normal.VEndCap - vertical end
Normal.HStartCap - horizontal start
Normal.HBackground - horizontal line
Normal.HEndCap - horizontal end
Selected.Background - cell background
Selected.Junction - corner
Selected.VStartCap - vertical start
Selected.VBackground - vertical line
Selected.VEndCap - vertical end
Selected.HStartCap - horizontal start
Selected.HBackground - horizontal line
Selected.HEndCap - horizontal end
ImageStyle

7.4.11 Image
Parent : Widget
A static image

SourceRect - are of the image
Rect (left,top,right,bottom)

SourceResource - filename
String

Strecth - true if allow image to be stretched
bool

Style
ImageStyle

7.4.12 ImageStyle
Parent : UIStyle
describes an image. contains list of ImageFrame

Loop - loop frames
bool

Playtime - amount of time to play
float

7.4.13 List
Parent : Widget
A list of items

DataSource - data items

SelectedRow - selected row index
integer (-1 for none)

SelectedRowCount - does nothing?

SelectionAllowMultiRow - allow multiple selections
bool

Style
ListStyle

7.4.14 ListStyle
Parent : WidgetStyle
Style for a list

CellPadding -
Point (x,y)

CellHeight - height of a cell
integer

GridColor - grid box color
Color

DefaultTextStyle - text style
TextStyle

DefaultTextColor - text color
Color

SelectionColorBackground - selection background
Color

SelectionColorRect - box around selection
Color

7.4.15 Listbox
Parent : Widget
A list of items

DataSource

OnSelect - action
OnDoubleClick - action
String

SelectedItem - value of item
String

SelectedItemIndex - index of selected item
integer

Style
ListboxStyle

RowTemplate - describes a row
Template

AutoScrollSpeed - scroll the list automatically
this is used for the credits
integer

7.4.16 ListboxStyle
Parent : WidgetStyle
Style for a list

GridStyle - info about the grid box

Layout -
Vertical
Horizontal

7.4.17 Polyline
Parent : Widget
A line from one point to another

Style
ImageStyle

Thickness - width
float

7.4.18 Progressbar
Parent : Widget
The progress control

BackgroundColor
Color

BarBackgroundColor
Color

Progress - percent complete
float ( 0.0 - 1.0)

Style
ProgressbarStyle

7.4.19 ProgressbarStyle
Parent : WidgetStyle
Style for a Progressbar

StepSize - size to change
integer

StarCap - end art
Background - background art
EndCap - end art
Bar.StarCap - end art
Bar.Background - background art
Bar.EndCap - end art
ImageStyle

Layout
Horizontal
Vertical

Inverted - reverse direction if true
bool

7.4.20 Scrollbar
Parent : Widget
A scrollbar. changes an objects scroll location

Control - parent control
Widget

Style
ScrollbarStyle

ArrowPressSound
ArrowReleaseSound
ThumbPressSound
ThumbReleaseSound
String

OnChange - action
String

UpdateContinuous - send multiple events
bool

7.4.21 ScrollbarStyle
Parent : WidgetStyle
Style for a scrollbar

StartCap.Normal
Background.Normal
EndCap.Normal
Thumb.StartCap.Normal
Thumb.Background.Normal
Thumb.EndCap.Normal
StartCap.Disabled
Background.Disabled
EndCap.Disabled
Thumb.StartCap.Disabled
Thumb.Background.Disabled
Thumb.EndCap.Disabled
StartCap.Pressed
Background.Pressed
EndCap.Pressed
Thumb.StartCap.Pressed
Thumb.Background.Pressed
Thumb.EndCap.Pressed
ImageStyle

Layout
Horizontal
Vertical

Startcap.StopOffset -
Point (x,y)

EndCap.StopOffset -
Point (x,y)

Thumb.MinSize -
Point (x,y)

ArrowPressSound
ArrowReleaseSound
ThumbPressSound
ThumbReleaseSound
String

7.4.22 Sliderbar
Parent : Widget
widget that sets a value using a slider

LowerLimit - minimum value
integer

OnChange - action
string

Style
SliderbarStyle

UpperLimit - maximum value
integer

Value - current value
integer

ValueUpdateContinuous - send multiple events when slider is moving
bool

7.4.23 SliderbarStyle
Parent : WidgetStyle
Style for a sliderbar

Layout
Horizontal
Vertical

StartCap
Background
EndCap
Slider
ImageStyle

7.4.24 Sliderplane
Parent : Widget
Slider with 2 axis.

LowerLimit - minimum value
integer

OnChange - action
string

Style
SliderplaneStyle

UpperLimit - maximum value
integer

Value - current value
integer

ValueUpdateContinuous - send multiple events when slider is moving
bool

7.4.25 SliderplaneStyle
Parent : WidgetStyle
Style for a sliderplane

Layout
Horizontal
Vertical

StartCap
Background
EndCap
Slider
ImageStyle

7.4.26 Splitter
Parent : Widget
Allow two widgets to be resized

OnChange - action
string

Style
SplitterStyle

ControlBefore
Widget

ControlAfter
Widget

7.4.27 SplitterStyle
Parent : WidgetStyle
Style for a splitter

Layout
Horizontal
Vertical

StartCap
Background
EndCap
7.4.28 TabSet
Parent : Widget
list of pages controlled by tabs

Style
TabSetStyle

Template
Template

7.4.29 TabSetStyle
Parent : WidgetStyle
Style for a TabSet

ActiveTabStartCap
ActiveTabBackground
ActiveTabEndCap
InactiveTabStartCap
InactiveTabBackground
InactiveTabEndCap
ImageStyle

BodyTopLeft
BodyTop
BodyTopRight
BodyRight
BodyBottomRight
BodyBottom
BodyBottomLeft
BodyLeft
BodyFill
ImageStyle

Layout
Horizontal
Vertical

7.4.30 TabSet
Parent : Widget
list of pages controlled by tabs

Style
TabSetStyle

Template
Template

7.4.31 TabSetStyle
Parent : WidgetStyle
Style for a TabSet

ActiveTabStartCap
ActiveTabBackground
ActiveTabEndCap
InactiveTabStartCap
InactiveTabBackground
InactiveTabEndCap
ImageStyle

BodyTopLeft
BodyTop
BodyTopRight
BodyRight
BodyBottomRight
BodyBottom
BodyBottomLeft
BodyLeft
BodyFill
ImageStyle

Layout
Horizontal
Vertical

7.4.32 TreeView
Parent : Widget
a tree

DataSourceContainer - tree of data

SelectedRow - currently selected row
integer (-1 for none)

SelectedRowCount - does nothing?

SelectionAllowMultRow - allow multiple selections
bool

Style -
TreeViewStyle

7.4.33 TreeViewStyle
Parent : WidgetStyle
style for tree view

CellPadding -

CellHeight -
integer

GridColor -
Color

DefaultTextStyle
TextStyle

DefaultTextColor
Color

SelectionColorBackground - color for selection background
Color

SelectionColorRect - color for selection border
Color

ImageStyleCollapsed - icon for collapsed branch
ImageStyle

ImageStyleExpanded - icon for expanded branch
ImageStyle

Indentation - amount to indent
integer

7.4.34 Table
Parent : Widget

TableModel -
TableModel

ColumnResizePolicy - not used

SelectedRow
integer (-1 for none)

SelectedRowCount - not used?

SelectionAllowedRow
bool

SelectionAllowedMultiRow
bool

CellPadding
Point (x,y)

CellHeight
integer

GridColorHorizontal
Color

GridColorVertical
Color

DefaultTextStyle
TextStyle

DefaultTextColor
Color

SelectionColorBackground
Color

SelectionColorRect
Color

7.4.35 TableModelDefault
Parent : TableModel
DataSourceContainer - collection of data sources

7.4.36 TableHeader
Parent : Page
Table - name of the associated table
Table

ButtonStyle - button
ButtonStyle

ImageSortUp - image if sorting up
ImageStyle

ImageSortDown - image if sorting down
ImageStyle

CursorResize - cursor to indicate resize
Cursor

7.4.37 Text
Parent : Widget
a static string

Text - the string
string

LocalText - string after being mapped
string

Margin - area around the text
Rect (left,top,right,bottom)

MaxLines -
integer

ShadowStyle

Font -
TextStyle

TextAlignment
Left
Center
Right

TextAlignmentVertical
Top
Center
Bottom

TextColor
Color

TruncateElipsis - use elipsis if too long
bool

7.4.38 Textbox
Parent : Widget
a text entry control

MaxLength - character
integer

MaxLines -
integer

OnChange - action
OnOverflow - action
string

Password - is password style
bool

Style
TextboxStyle

Text -
LocalText -
string

WrapWidth
integer
-1 no wrapping
-2 automatic wrapping

Editable
EditableUnicode
bool

TextColor
color

NumericInteger - just number
bool

NumericFloat - XX.XX
bool

NumericNegative - allow negatives
bool

NumericIP - XX.XX.XX.XX
bool

7.4.39 TextboxStyle
Parent : WidgetStyle
Style for a Textbox

CaratColor
Color

CaratWidth
integer

Cursor

NormalGridStyle
DisabledGridStyle
SelectedGridStyle
GridStyle

NormalShadowStyle
DisabledShadowStyle
SelectedShadowStyle
ShadowStyle

NormaTextStyle
DisabledTextStyle
SelectedTextStyle
TextStyle

SelectionColor
Color

SelectionOpacity
float (0.0 - 1.0)

TextPadding - area around text
Rect (left,top,right,bottom)

7.5 Style Group:
A style helps define the look of a widget/page. Often a style will be used to create common properties for similar widgets.

7.5.1 Style
Parent : BaseObject
The base style

No properties

7.5.2 RectangleStyle
Parent : Style
a style that contains 9 images and rules

North
NorthEast
NorthWest
South
SouthEast
SouthWest
East
West
Center
ImageStyle

NorthStretch - can image stretch
NorthShrink - can image shrink
SouthStretch
SouthShrink
EastStretch
EastShrink
WestStretch
WestShrink
CenterStetchH
CenterStetchV
CenterShrinkH
CenterShrinkV
bool

Color -
color

Opacity -
float (0.0 - 1.0)

7.5.3 ShadowStyle
Parent : Style
dropshadow description

Color -
Color

Offset - shift from the normal text
Point (x,y)

Opacity -
float (0.0 - 1.0)

RenderShadow - true if draw the shadow
bool

7.5.4 TextStyle
Parent : Style
Defines a font and the available characters

Leading - height
integer

ShadowStyle

CachedStyle - id of cached font (1-9)
integer

UseCachedFont - use cached font for missing chars
bool

7.5.5 TooltipStyle
Parent : Style
Style for a Tooltip

DataSource

GridStyle - for the box


MaxWidth
integer

Template - ui library information

TextColor
Color

TextPadding - space around text
Rect (left,top,right,bottom)

TextShadowStyle
ShadowStyle

TextStyle

7.5.6 WidgetStyle
Parent : Style
Style for all widgets

HideSound
ShowSound
String

OnShowEffector
OnHideEffector
OnEnableEffector
OnDisableEffector
Effector

7.6 Extras
Some items do not fit into the categories above.
7.6.1 Cursor
Parent : BaseObject
the pointer image

ImageStyle - pointer image
ImageStyle

HotSpot - offset into image for hotspot
Point (x,y)

7.6.2 CursorSet
Parent : BaseObject
a collection of cursors

Count - number of cursors
long

7.6.3 ImageFragment
Parent : BaseObject
portion of an image

Offset - offset into full image
Point (x,y)

SourceRect - area of this fragment
Rect (left,top,right,bottom)

Source - name of the file
String

7.6.4 ImageFrame
Parent : ImageFragment
One part of an image

Duration - time to play this frame
long

7.6.5 FontCharacter
Parent : BaseObject
a character glyph

Code - unicode value
wchar_t

Advance - width
long

SourceRect - area in image for this character
Rect (left,top,right,bottom)

SourceFile - image
String


7.6.6 Template
Parent : BaseObject
describes the layout of a row of data

Size - row size
Point (x,y)

Template - ui library information
String