AbsoluteLayout.rogue

class AbsoluteLayout

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	AbsoluteLayout
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
minimum_layout_size( available_size:XY, &limited )	XY
perform_content_layout()
resolve_content_layout_sizes( available_size:XY )
update_layout()

AspectRatioLayoutSwitcher.rogue

class AlternateAspectLayout [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( component:Component, min_aspect_ratio:Real )	AlternateAspectLayout

Properties

Name	Type	Description
component	Component
min_aspect_ratio	Real

Methods

Signature	Return Type	Description
description()	String
operator==( other:AlternateAspectLayout )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<AlternateAspectLayout>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

class AspectRatioLayoutSwitcher

extends Component

Properties

Name	Type	Description
actions	Action
alternates	AlternateAspectLayout[]
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
add_alternate( component:Component, min_aspect_ratio:Real )
add_default( component:Component )
cloned()	AspectRatioLayoutSwitcher
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
resolve_layout_size( available_size:XY, &limited )	XY

Border.rogue

class Border

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
bottom_padding	Padding
bottom_px	Real	current pixel values derived from 'left_padding' etc.
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
left_padding	Padding
left_px	Real	current pixel values derived from 'left_padding' etc.
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
right_padding	Padding
right_px	Real	current pixel values derived from 'left_padding' etc.
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
top_padding	Padding
top_px	Real	current pixel values derived from 'left_padding' etc.
weight	XY

Methods

Signature	Return Type	Description
cloned()	Border
content_position()	XY
content_size()	XY
content_size_to_layout_size( content_size:XY )	XY
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
resolve_layout_size( available_size:XY, &limited )	XY
set_horizontal_padding( padding:Padding )
set_padding( padding:Padding )
set_vertical_padding( padding:Padding )

class Padding [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( parameter_id:VariantEntryID )	Padding
create( value:Real, [proportional=false:Logical] )	Padding
create( value:Real, mode:SizingMode )	Padding
fixed( value:Real )	Padding
proportional( value:Real )	Padding

Properties

Name	Type	Description
mode	SizingMode
value	Real

Methods

Signature	Return Type	Description
description()	String
operator==( other:Padding )	Logical
print_to( buffer:PrintWriter )
resolved_value( available_size:Real )	Real
to<<Object>>()	Boxed<<Padding>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

Component.rogue

class Component

extends Entity

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
init()
init( child:Component )
init( fixed_size:XY )
init( size_parameter_id:VariantEntryID )
align_content_bottom()
align_content_bottom_left()
align_content_bottom_right()
align_content_center()
align_content_left()
align_content_right()
align_content_top()
align_content_top_left()
align_content_top_right()
align_content( content_alignment:Anchor? )
anchor()	Anchor
anchor_bottom()
anchor_bottom_left()
anchor_bottom_right()
anchor_center()
anchor_left()
anchor_right()
anchor_top()
anchor_top_left()
anchor_top_right()
aspect_fit()
aspect_fit_height_to_natural_width()
aspect_fit_width_to_natural_height()
aspect_fit( aspect_size:XY )
aspect_fit_height_to_width( aspect_size:XY )
aspect_fit_width_to_height( aspect_size:XY )
begin_content_layout()
begin_layout( &only_content )
bounds()	Box
can_split_from( next_component:Component )	Logical	Used by HFlow layout, overridden by Text
capture_focus()	Logical
capture_keyboard_focus()	Logical
capture_pointer_focus()	Logical
cloned()	Component
collect_child_display_components( list:Component[], &only_visible )		Collect child components that need to be laid out, skipping any meta-components.
collect_display_components( list:Component[], &only_visible )
contains( at_position:XY )	Logical
contains( e:PointerEvent )	Logical
content_alignment()	Anchor
content_bounds()	Box
content_display_bounds()	Box
content_opacity()	Real
content_position()	XY
content_size()	XY
content_contains( at_position:XY )	Logical
content_contains( e:PointerEvent )	Logical
content_size_to_layout_size( content_size:XY )	XY
copy_settings_from( other:Component )
dispatch( e:KeyEvent )
dispatch( e:MultitouchEvent )
dispatch( e:PointerEvent )
dispatch( e:ScrollEvent )
dispatch( e:TextEvent )
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
display_bounds()	Box
display_position()	XY
display_components( &only_visible )	DisplayComponents
end_layout( &only_content )
expand_to_fill()
expand_to_fill_height()
expand_to_fill_width()
find( at_position:XY )	Entity
find( e:PointerEvent )	Entity
find_content( at_position:XY )	Entity
find_h_split( max_width:Real, &force )	Real?
first_content_component()	Component
font()	Font
handle( e:KeyEvent )
handle( e:MultitouchEvent )
handle( e:PointerEvent )
handle( e:ScrollEvent )
handle( e:TextEvent )
has_keyboard_focus()	Logical
has_pointer_focus()	Logical
is_br()	Logical
is_display_component()	Logical	If false, this component is considered an informational meta-component.
is_space()	Logical
keyboard_focus()	Component
line_height()	Real
manually_update_content_layout( [setting=true:Logical] )
minimum_layout_size( available_size:XY, &limited )	XY
next_component()	Component
on_begin_draw()
on_begin_layout()		Called at the beginning of layout
on_capture_keyboard_focus()
on_capture_pointer_focus()
on_end_draw()
on_end_layout()
on_layout_size_resolved()		Called when this component's size has been set but before child component sizes are set. 'size' may be modified here.
on_release_keyboard_focus()
on_release_pointer_focus()
on( e:KeyEvent )
on( e:MultitouchEvent )
on( e:PointerEvent )
on( e:ScrollEvent )
on( e:TextEvent )
on_unhandled( e:KeyEvent )
on_unhandled( e:MultitouchEvent )
on_unhandled( e:PointerEvent )
on_unhandled( e:ScrollEvent )
on_unhandled( e:TextEvent )
opacity()	Real
operator&( rhs:Component )	Component
operator+( rhs:Component )	Component
operator/( rhs:Component )	Component
operator\|( rhs:Component )	Component
perform_content_layout()
perform_layout( position:XY )
pointer_focus()	Component
release_focus()
release_keyboard_focus()
release_pointer_focus()
request_layout()
request_redraw()
resolve_content_layout_sizes()
resolve_content_layout_sizes( available_size:XY )
resolve_layout_size( available_size:XY, &limited )	XY
resolve_minmax_layout_size( min_available_size:XY, max_available_size:XY, &limited )	(min:XY,max:XY)
set_anchor( anchor:Anchor? )
set_content_offset( new_content_offset:XY )
set_content_opacity( content_opacity:Real )
set_fixed_height( h:Real )
set_fixed_size( layout_size:XY )
set_fixed_width( w:Real )
set_gap( gap:Real )
set_gap( parameter_id:VariantEntryID )
set_h_gap( gap:Real )
set_h_gap( parameter_id:VariantEntryID )
set_height( parameter_id:VariantEntryID )
set_natural_height( h:Real )
set_natural_size( natural_size:XY )
set_natural_width( w:Real )
set_opacity( opacity:Real )
set_proportional_height( h:Real )
set_proportional_height( size_reference:Component, h:Real )
set_proportional_size( layout_size:XY )
set_proportional_size( size_reference:Component, layout_size:XY )
set_proportional_width( size_reference:Component, w:Real )
set_proportional_width( w:Real )
set_size( parameter_id:VariantEntryID )
set_size( size:XY )
set_structure_modified( setting:Logical )
set_v_gap( gap:Real )
set_v_gap( parameter_id:VariantEntryID )
set_weight( weight:Real )
set_weight( weight:XY )
set_width( parameter_id:VariantEntryID )
shrink_to_fit()
shrink_to_fit_height()
shrink_to_fit_width()
split_h( split_position:Real, components:Component[], component_i:Int )
text_style()	TextStyle
update_content_layout()
use_natural_height()
use_natural_size()
use_natural_width()
yield_pointer_focus_to( e:PointerEvent )	Logical

class UIGeneratedStack

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	UIGeneratedStack
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
operator\|( rhs:Component )	Component

ComponentGroupProperties.rogue

class ComponentGroupProperties [aspect]

Description

Example usage: extend Component[] and incorporate this aspect; because Component[] implements collection iteration protocols (iterator() etc.), calling e.g. align_content_left() will call align_content_left() on all elements of the list.

Methods

Signature	Return Type	Description
align_content_bottom()
align_content_bottom_left()
align_content_bottom_right()
align_content_center()
align_content_left()
align_content_right()
align_content_top()
align_content_top_left()
align_content_top_right()
align_content( content_alignment:Anchor )
aspect_fit()
aspect_fit_height_to_natural_width()
aspect_fit_width_to_natural_height()
aspect_fit( aspect_size:XY )
aspect_fit_height_to_width( aspect_size:XY )
aspect_fit_width_to_height( aspect_size:XY )
expand_to_fill()
expand_to_fill_height()
expand_to_fill_width()
set_anchor( anchor:Anchor )
set_content_opacity( content_opacity:Real )
set_fixed_height( h:Real )
set_fixed_size( layout_size:XY )
set_fixed_width( w:Real )
set_font( font:Font )
set_height( parameter_id:VariantEntryID )
set_opacity( opacity:Real )
set_proportional_height( h:Real )
set_proportional_height( size_reference:Component, h:Real )
set_proportional_size( layout_size:XY )
set_proportional_size( size_reference:Component, layout_size:XY )
set_proportional_width( size_reference:Component, w:Real )
set_proportional_width( w:Real )
set_size( parameter_id:VariantEntryID )
set_text_style( style:TextStyle )
set_weight( weight:Real )
set_weight( weight:XY )
set_width( parameter_id:VariantEntryID )
shrink_to_fit()
shrink_to_fit_height()
shrink_to_fit_width()
use_natural_height()
use_natural_size()
use_natural_width()

ComponentSizeInfo.rogue

class ComponentSizeInfo [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( component:Component, min_size:XY, max_size:XY )	ComponentSizeInfo

Properties

Name	Type	Description
component	Component
max_size	XY
min_size	XY

Methods

Signature	Return Type	Description
description()	String
operator==( other:ComponentSizeInfo )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<ComponentSizeInfo>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

DisplayComponents.rogue

class DisplayComponents [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( parent:Component, [only_visible=false:Logical] )	DisplayComponents

Properties

Name	Type	Description
only_visible	Logical
parent	Component

Methods

Signature	Return Type	Description
description()	String
on_use()	Component[]
on_end_use( list:Component[] )
operator==( other:DisplayComponents )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<DisplayComponents>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

Event.rogue

class Event

extends Object

Properties

Name	Type	Description
is_consumed	Logical
refcount	Int
timestamp	Int64

Methods

Signature	Return Type	Description
init( [timestamp=System.execution_time_ms:Int64] )
init( existing:Event )
cloned()	Event
consume()
dispatch()		Application-specific
release()
retain()

class KeyEvent

extends Event

Properties

Name	Type	Description
is_consumed	Logical
is_press	Logical
is_repeat	Logical
keycode	Keycode
modifiers	KeyModifier
refcount	Int
scancode	Int
timestamp	Int64
unicode	Character

Methods

Signature	Return Type	Description
init()
init( existing:KeyEvent )
init( keycode:Keycode, scancode:Int, [is_press=false:Logical], [is_repeat=false:Logical], [modifiers=Keyboard.modifier_state:KeyModifier] )
init( unicode:Character, [is_press=false:Logical], [is_repeat=false:Logical], [modifiers=Keyboard.modifier_state:KeyModifier] )
cloned()	KeyEvent
dispatch()		Application-specific
is_alt_pressed()	Logical
is_control_pressed()	Logical
is_os_pressed()	Logical
is_printable()	Logical
is_release()	Logical
is_shift_pressed()	Logical
is_press( keycode:Keycode )	Logical
is_release( keycode:Keycode )	Logical
is_repeat( keycode:Keycode )	Logical
release()
to<<String>>()	String

class MultitouchEvent

extends Event

Properties

Name	Type	Description
delta	XYZ
is_consumed	Logical
refcount	Int
timestamp	Int64

Methods

Signature	Return Type	Description
init()
init( delta:XYZ )
init( existing:MultitouchEvent )
cloned()	MultitouchEvent
dispatch()		Application-specific
release()
to<<String>>()	String

class PointerEvent

extends Event

Properties

Name	Type	Description
delta	XY
ignore_sequence	Logical	gesure overlaps with e.g. Android 'show system bar'; press/move/release are ignored
index	Int	button index for mouse press
is_cancelled	Logical	When a touch event in progress is interrupted, a <RELEASE> event is sent with .is_cancelled==true.
is_click	Logical	Can be true for <RELEASE> events
is_consumed	Logical
is_drag	Logical	this <MOVE> or <RELEASE> event is part of a press and drag movement
is_long_press	Logical	Can be true for any event type, including redispatched <PRESS>
is_multitouch	Logical	this is one of at least two touches that are currently active
is_touch	Logical	this pointer event is from a touch rather than the mouse
pointer_id	Int	used to distinguish touches, only valid if is_touch
position	XY
refcount	Int
tick_delay	Int	used on iOS as time for touch events to be recognized as OS gestures
timestamp	Int64
type	GlobalID	<PRESS>, <MOVE>, <RELEASE>, <LEAVE>

Methods

Signature	Return Type	Description
init()
init( existing:PointerEvent )
init( type:GlobalID )
init( type:GlobalID, position:XY, delta:XY, index:Int, [is_cancelled=false:Logical], [is_touch=false:Logical] )
cloned()	PointerEvent
dispatch()		Application-specific
is_enter()	Logical
is_leave()	Logical
is_move()	Logical
is_press()	Logical
is_press_left()	Logical
is_press_middle()	Logical
is_press_right()	Logical
is_release()	Logical
is_release_left()	Logical
is_release_middle()	Logical
is_release_right()	Logical
is_press( button_index:Int )	Logical
is_release( button_index:Int )	Logical
operator+( offset:XY )	PointerEvent
operator-( offset:XY )	PointerEvent
release()
to<<String>>()	String

class ScrollEvent

extends Event

Properties

Name	Type	Description
delta	XY
density	Int
in_progress	Logical	macOS: in_progress means that either the finger is still resting on the Magic Mouse/trackpad or that a "momentum scroll" is active. Either way scroll events are guaranteed to continue to be received until one where 'in_progress' is false.
is_consumed	Logical
is_momentum	Logical
is_precise	Logical	True for Apple Magic Mouse and Trackpad, AKA supports gestures and momentum. If this is true then is_progress and is_momentum are valid (and vice versa).
refcount	Int
timestamp	Int64

Methods

Signature	Return Type	Description
init()
init( delta:XY, [is_precise=false:Logical], [in_progress=false:Logical], [is_momentum=false:Logical], [density=1:Int] )
init( existing:ScrollEvent )
cloned()	ScrollEvent
dispatch()		Application-specific
release()
to<<String>>()	String

class ScrollRate

extends Object

Properties

Name	Type	Description
acceleration_x	Real
acceleration_y	Real
base_scale	Real
delta	XY
history_x	ScrollEvent[]
history_y	ScrollEvent[]

Methods

Signature	Return Type	Description
init( [base_scale=5.0:Real] )
add( e:ScrollEvent )	XY	Returns the scaled or accelerated scroll-delta.

class TextEvent

extends Event

Properties

Name	Type	Description
character	Character
is_consumed	Logical
refcount	Int
text	String
timestamp	Int64

Methods

Signature	Return Type	Description
init()
init( character:Character, [text=null:String] )
init( existing:TextEvent )
init( text:String )
cloned()	TextEvent
count()	Int
dispatch()		Application-specific
operator==( ch:Character )	Logical
operator==( value:String )	Logical
print_to( buffer:PrintWriter )
release()
text()	String
to<<String>>()	String

Filler.rogue

class Filler

extends Component

Global Methods

Signature	Return Type	Description
h()	Filler
v()	Filler

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
init()
cloned()	Filler
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )

Focus.rogue

class Focus

extends Object

Properties

Name	Type	Description
keyboard	Component
pointer	Component

Font.rogue

class Font

extends Object

Properties

Name	Type	Description
anchor	Anchor
line_spacing	Real
name	String
scale	XY

Methods

Signature	Return Type	Description
anchor_bottom()
anchor_bottom_left()
anchor_bottom_right()
anchor_center()
anchor_left()
anchor_right()
anchor_top()
anchor_top_left()
anchor_top_right()
cloned()	Font
draw( text:String, bounds:Box, [anchor=Anchor.CENTER:Anchor] )
draw( text:String, container:Component )
draw( text:String, position:XY, anchor:Anchor )
init_clone( existing:Font )
measure( text:String, [i1=null:Int?], [count=null:Int?] )	XY
set_scale( new_scale:Real )
set_scale( scale:XY )
word_wrap( st:String, pixel_width:Real, [buffer=String():String] )	String	Prints a word-wrapped version of the given string into the specified StringBuilder. Existing newline characters will cause a new line to begin immediately. Spaces immediately following existing newline characters are preserved.

HBox.rogue

class HBox

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	Real	In pixels
gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	HBox
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()
minimum_layout_size( available_size:XY, &limited )	XY
on_begin_layout()
perform_content_layout()
resolve_content_layout_sizes( available_size:XY )
set_gap( gap:Real )
set_gap( gap_parameter_id:VariantEntryID )
set_h_gap( gap:Real )
set_h_gap( parameter_id:VariantEntryID )

class UIGeneratedHBox

extends HBox

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	Real	In pixels
gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	UIGeneratedHBox
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
operator+( rhs:Component )	Component

HFlow.rogue

class HFlow

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
cur_line_advance	Real
cur_line_height	Real
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
laid_out_for_size	XY?	size finished for
last_child	Entity
layout_cursor	XY
layout_size	XY
max_width	Real
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
init()
init( component:Component )
init( text:String )
cloned()	HFlow
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()
minimum_layout_size( available_size:XY, &limited )	XY
on_begin_layout()
on_end_layout()
perform_content_layout()
resolve_content_layout_sizes( available_size:XY )
set_structure_modified( setting:Logical )

class LayoutCluster

extends Component[]

Properties

Name	Type	Description
@native105	RogueCNativeProperty
capacity	Int
count	Int
element_size	Int
element_type	Component	Used by native code to determine sizeof($DataType)
is_borrowed	Logical
is_ref_array	Logical

Methods

Signature	Return Type	Description
find_h_split( max_width:Real, &force )	Real?
height()	Real
is_br()	Logical
is_space()	Logical
line_advance()	Real
perform_layout( position:XY )
release()		Called by RecyclePool
split_h( split_position:Real, components:Component[], component_i:Int )
width()	Real

Keyboard.rogue

class Keyboard [singleton]

extends Object

Properties

Name	Type	Description
key_pressed	Logical[]

Methods

Signature	Return Type	Description
clear_pressed_keys()		Clears the key_pressed array - used when window focus is lost and regained
is_alt_pressed()	Logical
is_control_pressed()	Logical
is_os_pressed()	Logical
is_shift_pressed()	Logical
is_key_pressed( keycode:Keycode )	Logical
modifier_state()	KeyModifier
on( e:KeyEvent )

enum Keycode

incorporates CommonCompoundMethods

Categories

Category	Value	Description
UNDEFINED	0
LEFT_ARROW	1
UP_ARROW	2
RIGHT_ARROW	3
DOWN_ARROW	4
BACKSPACE	8
TAB	9
ENTER	10
CAPS_LOCK	11
LEFT_SHIFT	12
RIGHT_SHIFT	13
LEFT_CONTROL	14
RIGHT_CONTROL	15
LEFT_ALT	16
RIGHT_ALT	17
LEFT_OS	18
RIGHT_OS	19
FUNCTION	26
ESCAPE	27
SPACE	32
QUOTE	39	AKA APOSTROPHE
COMMA	44
MINUS	45
PERIOD	46
SLASH	47
NUMBER_0	48
NUMBER_1	49
NUMBER_2	50
NUMBER_3	51
NUMBER_4	52
NUMBER_5	53
NUMBER_6	54
NUMBER_7	55
NUMBER_8	56
NUMBER_9	57
SEMICOLON	59
EQUALS	61
AT	64
A	65
B	66
C	67
D	68
E	69
F	70
G	71
H	72
I	73
J	74
K	75
L	76
M	77
N	78
O	79
P	80
Q	81
R	82
S	83
T	84
U	85
V	86
W	87
X	88
Y	89
Z	90
OPEN_BRACKET	91
BACKSLASH	92
CLOSE_BRACKET	93
BACKQUOTE	96	AKA GRAVE
SYS_REQUEST	124
SCROLL_LOCK	125
BREAK	126
DELETE	127
INSERT	128
HOME	129
END	130
PAGE_UP	131
PAGE_DOWN	132
PRINT_SCREEN	133
PAUSE	134
NUMPAD_ENTER	140
NUMPAD_EQUALS	141
NUMPAD_PLUS	142
NUMPAD_MINUS	143
NUMPAD_TIMES	144
NUMPAD_DIVIDE	145
NUMPAD_COMMA	146
NUMPAD_PERIOD	147
NUMPAD_0	148
NUMPAD_1	149
NUMPAD_2	150
NUMPAD_3	151
NUMPAD_4	152
NUMPAD_5	153
NUMPAD_6	154
NUMPAD_7	155
NUMPAD_8	156
NUMPAD_9	157
NUMPAD_TAB	158
NUMPAD_BACKSPACE	159
NUMPAD_NUM_LOCK	160
F1	201
F2	202
F3	203
F4	204
F5	205
F6	206
F7	207
F8	208
F9	209
F10	210
F11	211
F12	212
F13	213
F14	214
F15	215
F16	216
F17	217
F18	218
F19	219
F20	220
F21	221
F22	222
F23	223
F24	224

Global Properties

Name	Type	Description
categories	Keycode[]
shifted_keycode_to_unicode	String
unicode_to_keycode	Keycode[]
unicode_to_shift_state	Logical[]
unshifted_keycode_to_unicode	String

Global Methods

Signature	Return Type	Description
create( name:String )	Keycode
create( value:Int )	Keycode
keycode_to_unicode( keycode:Keycode, [is_shift_pressed=false:Logical] )	Character
operator<>( a:Keycode, b:Keycode )	Int
unicode_to_keycode( unicode:Character )	(Keycode,Logical)	keycode, is_shifted

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
description()	String
hashcode()	Int
name()	String
operator?()	Logical
operator+( value:Int )	Int
operator-( value:Int )	Int
operator==( other:Keycode )	Logical
operator\|( value:Int )	Int
print_to( buffer:PrintWriter )
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

enum KeyModifier [bitflags]

incorporates CommonCompoundMethods

Categories

Category	Value	Description
LEFT_SHIFT	1
RIGHT_SHIFT	2
LEFT_CONTROL	4
RIGHT_CONTROL	8
LEFT_ALT	16
RIGHT_ALT	32
LEFT_OS	64
RIGHT_OS	128
CAPS_LOCK	256
NUM_LOCK	512
SCROLL_LOCK	1024

Global Properties

Name	Type	Description
categories	KeyModifier[]

Global Methods

Signature	Return Type	Description
create( name:String )	KeyModifier
create( value:Int )	KeyModifier

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
alt()	Logical
caps_lock()	Logical
control()	Logical
description()	String
hashcode()	Int
left_alt()	Logical
left_control()	Logical
left_os()	Logical
left_shift()	Logical
name()	String
num_lock()	Logical
operator!()	KeyModifier
operator?()	Logical
operator&( flag:KeyModifier )	KeyModifier
operator==( other:KeyModifier )	Logical
operator\|( flag:KeyModifier )	KeyModifier
os()	Logical
print_to( buffer:PrintWriter )
right_alt()	Logical
right_control()	Logical
right_os()	Logical
right_shift()	Logical
scroll_lock()	Logical
set_caps_lock( setting:Logical )
set_left_alt( setting:Logical )
set_left_control( setting:Logical )
set_left_os( setting:Logical )
set_left_shift( setting:Logical )
set_num_lock( setting:Logical )
set_right_alt( setting:Logical )
set_right_control( setting:Logical )
set_right_os( setting:Logical )
set_right_shift( setting:Logical )
set_scroll_lock( setting:Logical )
shift()	Logical
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

Label.rogue

class Label

extends Text

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
scaling_mode	ScalingModeXY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
value	String
weight	XY

Methods

Signature	Return Type	Description
can_split()	Logical
cloned()	Label
create_fragment( [text=String():String], &fragment )	Label
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()

LimitedSize.rogue

class LimitedSize

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_limit	XY?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
is_proportional	Logical	limits are proportional to display size
last_child	Entity
layout_size	XY
maximum_aspect_height	Logical
maximum_aspect_width	Logical
maximum_height	Real?
maximum_width	Real?
minimum_aspect_height	Logical
minimum_aspect_width	Logical
minimum_height	Real?
minimum_width	Real?
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	LimitedSize
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
maximum_aspect_height( aspect_limit:XY? )
maximum_aspect_width( aspect_limit:XY? )
minimum_aspect_height( aspect_limit:XY? )
minimum_aspect_width( aspect_limit:XY? )
proportional()
resolve_layout_size( available_size:XY, &limited )	XY
set_maximum_height( height:Real )
set_maximum_size( size:XY )
set_maximum_width( width:Real )
set_minimum_height( height:Real )
set_minimum_size( size:XY )
set_minimum_width( width:Real )

MetaComponent.rogue

class MetaComponent

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	MetaComponent
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
is_display_component()	Logical

Overlay.rogue

class Overlay

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
offset	XY
opacity	Real
parent	Entity
position	XY
position_reference	Component
scale	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
uses_proportional_offset	Logical
weight	XY

Methods

Signature	Return Type	Description
cloned()	Overlay
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
display_position()	XY
match_bounds( position_reference:Component )
perform_layout( inline_position:XY )
resolve_content_layout_sizes( available_size:XY )
set_offset( offset:XY )
set_offset( position_reference:Component, offset:XY )
set_proportional_offset( offset:XY )
set_proportional_offset( position_reference:Component, offset:XY )

Pointer.rogue

class Pointer [singleton]

extends Object

Properties

Name	Type	Description
click_time_threshold	Real
drag_threshold_px	Int	single-density pixels, auto-multiplied by display_density
is_dragging	Logical
is_long_press	Logical
is_multitouch	Logical
position	XY?	of first touch in current single touch or multitouch event
press_position	XY
press_start_time	Real
presses	PointerEvent[]

Methods

Signature	Return Type	Description
average_position()	XY?
clear()
drag_threshold()	Real
find( by_id:Int )	PointerEvent?
locate( by_id:Int )	Int?
record( e:PointerEvent )
update()

ScalingMode.rogue

enum ScalingMode

incorporates CommonCompoundMethods

Categories

Category	Value	Description
NONE	0
SHRINK_TO_FIT	1
ASPECT_FIT	2

Global Properties

Name	Type	Description
categories	ScalingMode[]

Global Methods

Signature	Return Type	Description
create( name:String )	ScalingMode
create( value:Int )	ScalingMode

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
description()	String
hashcode()	Int
name()	String
operator?()	Logical
operator==( other:ScalingMode )	Logical
print_to( buffer:PrintWriter )
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

class ScalingModeXY [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( x:ScalingMode, y:ScalingMode )	ScalingModeXY

Properties

Name	Type	Description
x	ScalingMode
y	ScalingMode

Methods

Signature	Return Type	Description
description()	String
operator==( other:ScalingModeXY )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<ScalingModeXY>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

SizingMode.rogue

enum SizingMode

incorporates CommonCompoundMethods

Categories

Category	Value	Description
EXPAND_TO_FILL	0
ASPECT_FIT	1
ASPECT_FIT_NATURAL_SIZE	2
PROPORTIONAL	3
SHRINK_TO_FIT	4
FIXED	5
NATURAL	6
PARAMETER_REAL	7
PARAMETER_XY	8

Global Properties

Name	Type	Description
categories	SizingMode[]

Global Methods

Signature	Return Type	Description
create( name:String )	SizingMode
create( value:Int )	SizingMode

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
description()	String
hashcode()	Int
name()	String
operator?()	Logical
operator==( other:SizingMode )	Logical
print_to( buffer:PrintWriter )
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

class SizingModeXY [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( mode:SizingMode )	SizingModeXY
create( x:SizingMode, y:SizingMode )	SizingModeXY

Properties

Name	Type	Description
x	SizingMode
y	SizingMode

Methods

Signature	Return Type	Description
description()	String
operator==( other:SizingModeXY )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<SizingModeXY>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

Table.rogue

class Table

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
cells_high	Int
cells_wide	Int
columns	TableColumns
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	XY	In pixels
h_gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
rows	TableRows
script	EntityScript
size	XY
size_reference	Component
size_resolved_for	XY?
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
v_gap_parameter_id	VariantEntryID
weight	XY

Methods

Signature	Return Type	Description
init( cells_wide:Int, cells_high:Int )
add( entity:Entity )		Adds the entity to the first empty cell. If there are no empty cells, starts a new row.
cell( i:Int, j:Int )	TableCell
cells()	TableSubsetProperties
cells( i1:Int, j1:Int, i2:Int, j2:Int )	TableSubsetProperties
cloned()	Table
column( i:Int )	TableColumn
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
get( i:Int, j:Int )	Component
init_object()
minimum_layout_size( available_size:XY, &limited )	XY
on_begin_layout()
perform_content_layout()
resize( w:Int, h:Int )
resolve_content_layout_sizes( available_size:XY )
resolve_layout_size( available_size:XY, &limited )	XY
row( j:Int )	TableRow
set( index:XY, component:Component )
set_cell( index:XY, cell:TableCell )
set_gap( gap:Real )
set_gap( gap:XY )
set_gap( gap_parameter_id:VariantEntryID )
set_h_gap( gap:Real )
set_h_gap( h_gap_parameter_id:VariantEntryID )
set_v_gap( gap:Real )
set_v_gap( v_gap_parameter_id:VariantEntryID )
update_cell_visibility()		Update cell visibility settings based on current cell span values

class TableCell

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
index	XY
internal_id	Int
is_obscured	Logical	layout helper
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
span	XY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
init( index:XY )
cloned()	TableCell
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()
set_span( span:XY )
to<<String>>()	String

class TableColumn

extends Object

Properties

Name	Type	Description
i	Int
is_resolved	Logical
layout_width	Real
max_width	Real
min_width	Real
sizing_mode	SizingMode
table	Table
weight	Real
width	Real

Methods

Signature	Return Type	Description
init( table:Table, i:Int )
cells()	TableSubsetProperties
expand_to_fill_width()
fixed_width( w:Real )
set_width( width:Real )
shrink_to_fit_width()

class TableColumns

extends TableColumn[]

Properties

Name	Type	Description
@native135	RogueCNativeProperty
capacity	Int
count	Int
element_size	Int
element_type	TableColumn	Used by native code to determine sizeof($DataType)
is_borrowed	Logical
is_ref_array	Logical

Methods

Signature	Return Type	Description
expand_to_fill_width()
fixed_width( w:Real )
set_width( width:Real )
shrink_to_fit_width()

class TableRow

extends Object

Properties

Name	Type	Description
height	Real
is_resolved	Logical
j	Int
layout_height	Real
max_height	Real
min_height	Real
sizing_mode	SizingMode
table	Table
weight	Real

Methods

Signature	Return Type	Description
init( table:Table, j:Int )
cells()	TableSubsetProperties
expand_to_fill_height()
fixed_height( h:Real )
set_height( height:Real )
shrink_to_fit_height()

class TableRows

extends TableRow[]

Properties

Name	Type	Description
@native136	RogueCNativeProperty
capacity	Int
count	Int
element_size	Int
element_type	TableRow	Used by native code to determine sizeof($DataType)
is_borrowed	Logical
is_ref_array	Logical

Methods

Signature	Return Type	Description
cells()	TableSubsetProperties
expand_to_fill_height()
fixed_height( h:Real )
set_height( height:Real )
shrink_to_fit_height()

class TableSubsetProperties [compound]

incorporates ComponentGroupProperties, CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( table:Table, i1:Int, j1:Int, i2:Int, j2:Int )	TableSubsetProperties

Properties

Name	Type	Description
i1	Int
i2	Int
j1	Int
j2	Int
table	Table

Methods

Signature	Return Type	Description
align_content_bottom()
align_content_bottom_left()
align_content_bottom_right()
align_content_center()
align_content_left()
align_content_right()
align_content_top()
align_content_top_left()
align_content_top_right()
align_content( content_alignment:Anchor )
aspect_fit()
aspect_fit_height_to_natural_width()
aspect_fit_width_to_natural_height()
aspect_fit( aspect_size:XY )
aspect_fit_height_to_width( aspect_size:XY )
aspect_fit_width_to_height( aspect_size:XY )
description()	String
expand_to_fill()
expand_to_fill_height()
expand_to_fill_width()
iterator()	TableSubsetPropertiesIterator
operator==( other:TableSubsetProperties )	Logical
print_to( buffer:PrintWriter )
set_anchor( anchor:Anchor )
set_content_opacity( content_opacity:Real )
set_fixed_height( h:Real )
set_fixed_size( layout_size:XY )
set_fixed_width( w:Real )
set_font( font:Font )
set_height( parameter_id:VariantEntryID )
set_opacity( opacity:Real )
set_proportional_height( h:Real )
set_proportional_height( size_reference:Component, h:Real )
set_proportional_size( layout_size:XY )
set_proportional_size( size_reference:Component, layout_size:XY )
set_proportional_width( size_reference:Component, w:Real )
set_proportional_width( w:Real )
set_size( parameter_id:VariantEntryID )
set_text_style( style:TextStyle )
set_weight( weight:Real )
set_weight( weight:XY )
set_width( parameter_id:VariantEntryID )
shrink_to_fit()
shrink_to_fit_height()
shrink_to_fit_width()
to<<Object>>()	Boxed<<TableSubsetProperties>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo
use_natural_height()
use_natural_size()
use_natural_width()

class TableSubsetPropertiesIterator [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( table:Table, i:Int, j:Int, i2:Int, j2:Int, i1:Int )	TableSubsetPropertiesIterator

Properties

Name	Type	Description
i	Int
i1	Int
i2	Int
j	Int
j2	Int
table	Table

Methods

Signature	Return Type	Description
description()	String
operator==( other:TableSubsetPropertiesIterator )	Logical
print_to( buffer:PrintWriter )
read_another()	TableCell?
to<<Object>>()	Boxed<<TableSubsetPropertiesIterator>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

Text.rogue

class Text

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
scaling_mode	ScalingModeXY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
value	String
weight	XY

Methods

Signature	Return Type	Description
init( [text=String():String], &fragment )
aspect_fit_text()
aspect_fit_text_to_height()
aspect_fit_text_to_width()
can_split()	Logical	If true, Text can be internally split for word-wrapping purposes.
can_split_from( next_component:Component )	Logical
cloned()	Text
create_fragment( [text=String():String], &fragment )	Text
description()	String
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
display_position()	XY
find_h_split( max_width:Real, &force )	Real?
font()	Font
is_br()	Logical
is_display_component()	Logical
is_space()	Logical
line_height()	Real
minimum_layout_size( available_size:XY, &limited )	XY
on_begin_layout()
on_draw()
set_value( new_value:Int )
set_value( new_value:Real, [decimal_digits=4:Int] )
set_value( new_value:String )
shrink_text_to_fit_height()
shrink_text_to_fit_size()
shrink_text_to_fit_width()
split_h( split_position:Real, components:Component[], component_i:Int )
to<<String>>()	String
use_unscaled_text()
use_unscaled_text_height()
use_unscaled_text_width()

TextBox.rogue

class TextBox

extends HFlow

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
cur_line_advance	Real
cur_line_height	Real
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
laid_out_for_size	XY?	size finished for
last_child	Entity
layout_cursor	XY
layout_size	XY
max_width	Real
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
add( text:String )
cloned()	TextBox
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )

TextField.rogue

class TextField

extends Widget

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
behavior	WidgetPointerFocusBehavior
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
cursor	Int?
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
is_on	Logical
just_once	Logical
last_child	Entity
layout_size	XY
max_count	Int?
natural_size	XY
next	Entity
next_focus	Component
on_select_arg	Variant
on_select_callback	Function()
on_select_signal	GlobalID?
opacity	Real
parent	Entity
position	XY
previous_focus	Component
script	EntityScript
select_count	Int
size	XY
size_reference	Component
sizing_mode	SizingModeXY
state	WidgetState
structure_modified	Logical
text_style	TextStyle
value	String
weight	XY

Methods

Signature	Return Type	Description
init()
init( value:String )
capture_focus()	Logical
cloned()	TextField
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
handle_value_changed()
horizontal_margin()	Real
index_at( position:XY )	Int	Returns cursor index (0..value.count) closest to given display position.
on_capture_keyboard_focus()
on_cursor_relocated()
on_release_keyboard_focus()
on_value_changed()
on( e:KeyEvent )
on( e:PointerEvent )
on( e:TextEvent )
on_draw_cursor( bounds:Box )
set_cursor( new_index:Int? )
set_state( new_state:WidgetState )
set_value( other:String )
text_bounds()	Box
yield_pointer_focus_to( e:PointerEvent )	Logical

TextStyle.rogue

class TextStyle

extends Object

Properties

Name	Type	Description
bg_color	Color?
color	Color?
font	Font?

Methods

Signature	Return Type	Description
init()
init( existing:TextStyle )
cloned()	TextStyle
draw( font:Font, text:Text, bounds:Box )

TypedText.rogue

class TypedText

extends Text

Global Properties

Name	Type	Description
default_reveal_rate	Real

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
is_typed_text_active	Logical
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
reveal_next	Logical
reveal_rate	Real
revealed_count	Real
scaling_mode	ScalingModeXY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
value	String
weight	XY

Methods

Signature	Return Type	Description
cloned()	TypedText
copy_settings_from( other:Component )
create_fragment( [text=String():String], &fragment )	TypedText
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
is_revealed()	Logical
on_draw()
on_update()
reset( [progress=0.0:Real] )
restart()
reveal( [progress=1.0:Real] )
set_value( new_value:String )
start_typing( [reveal_next=true:Logical] )
stop_typing( &rewind )

UI.rogue

class UI [singleton]

extends Component

Global Properties

Name	Type	Description
display_density_fn	Function()->Real
shared_focus	Focus

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
clip	Box?
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
default_font	Font
entity_id	GlobalID
find_handler	Function(GlobalID,Variant)->Variant
first_child	Entity
focus	Focus
font	Font
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
needs_layout	Logical
needs_redraw	Logical
next	Entity
opacity	Real
parameters	Variant
parent	Entity
position	XY
script	EntityScript
scroll_rate	Real
size	XY
size_reference	Component
sizing_mode	SizingModeXY
snap_to_pixel_coordinates	Logical
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
bounds_changed( bounds:Box )	Logical
cloned()	UI
container( content:Component, &h, &v )	Component
container( content:Component, [w=null:Real?], [h=null:Real?] )	Component
default_scroll_rate()	Real
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
display_density()	Real
draw()
filler( &h, &v )	Component
find( id:GlobalID, [arg=undefined:Variant], &up )	Variant
font()	Font
handle( e:KeyEvent )
handle( e:PointerEvent )
handle( e:ScrollEvent )
handle( e:TextEvent )
init_object()
on_resize()		'.size' has changed since the previous update.
release_keyboard_focus()
release_pointer_focus()
request_layout()
request_redraw()
set_clip( clip:Box? )
set_display_density( display_density_fn:Function()->Real )
set_needs_layout( needs_layout:Logical )
spacer( &h, &v )	Component
spacer( [w=null:Real?], [h=null:Real?] )	Component
spacer( fixed_size:XY )	Component
spacer( size_parameter_id:VariantEntryID )	Component
update( bounds:Box )
update_bounds( bounds:Box )
update_layout( bounds:Box )

VBox.rogue

class UIGeneratedVBox

extends VBox

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	Real	In pixels
gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	UIGeneratedVBox
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
operator/( rhs:Component )	Component

class VBox

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	Real	In pixels
gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	VBox
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()
minimum_layout_size( available_size:XY, &limited )	XY
on_begin_layout()
perform_content_layout()
resolve_content_layout_sizes( available_size:XY )
set_gap( gap:Real )
set_gap( gap_parameter_id:VariantEntryID )
set_v_gap( gap:Real )
set_v_gap( parameter_id:VariantEntryID )

VList.rogue

class VList

extends VBox

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
gap	Real	In pixels
gap_parameter_id	VariantEntryID
internal_id	Int
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
cloned()	VList
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()

VScrollView.rogue

class DragDelta [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( value:XY, [time=System.execution_time:Real] )	DragDelta

Properties

Name	Type	Description
time	Real
value	XY

Methods

Signature	Return Type	Description
description()	String
operator==( other:DragDelta )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<DragDelta>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

class VScrollView

extends Component

Properties

Name	Type	Description
actions	Action
active_scroll	Logical
allow_momentum_scroll	Logical
allow_overscroll	Logical
anchor	Anchor?
aspect_size	XY
attributes	Attributes
clamp_to_bounds	Logical
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
decay	XY
drag_deltas	DragDelta[]
drag_pos	XY
drag_start	XY
drag_time	Timer
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
is_dragging	Logical
is_pressed	Logical
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
opacity	Real
parent	Entity
position	XY
script	EntityScript
scroll_rate	ScrollRate
size	XY
size_reference	Component
sizing_mode	SizingModeXY
structure_modified	Logical
text_style	TextStyle
tracks_bottom	Logical
velocity	XY
weight	XY

Methods

Signature	Return Type	Description
bottom_offset()	Real	Result will be negative or zero.
bottom_position()	XY
cloned()	VScrollView
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_object()
item_position( index:Int )	XY
left_offset()	Real
on_begin_layout()
on_end_layout()
on_update()
on( e:PointerEvent )
on( e:ScrollEvent )
on_select( e_press:PointerEvent, e_release:PointerEvent )		UIScrollView consumes any original press event in preparation for dragging. If a release comes without turning into a drag, this pair of press/release events should be dispatched to the appropriate subcomponent.
on_select_background( position:XY )
right_offset()	Real	Result will be negative or zero.
scroll_position()	XY
scroll( delta:XY, &clamp )
scroll_to( index:Int, [duration=0.5:Real], &clamp )
scroll_to( offset:XY, [duration=0.5:Real], &clamp )
scroll_to_make_visible( bounds:Box, [duration=0.5:Real] )
set_scroll_position( index:Int, &clamp )
set_scroll_position( offset:XY, &clamp )
top_offset()	Real
top_position()	XY

Widget.rogue

class Widget

extends Component

Properties

Name	Type	Description
actions	Action
anchor	Anchor?
aspect_size	XY
attributes	Attributes
behavior	WidgetPointerFocusBehavior
content_alignment	Anchor?
content_offset	XY
content_opacity	Real
count	Int
entity_id	GlobalID
first_child	Entity
font	Font
internal_id	Int
is_on	Logical
just_once	Logical
last_child	Entity
layout_size	XY
natural_size	XY
next	Entity
on_select_arg	Variant
on_select_callback	Function()
on_select_signal	GlobalID?
opacity	Real
parent	Entity
position	XY
script	EntityScript
select_count	Int
size	XY
size_reference	Component
sizing_mode	SizingModeXY
state	WidgetState
structure_modified	Logical
text_style	TextStyle
weight	XY

Methods

Signature	Return Type	Description
init()
init( component:Component )
init( label:String )
init( size:XY )
cloned()	Widget
disable()
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
enable()
handle_select()
is_disabled()	Logical
is_idle()	Logical
is_pressed()	Logical
is_targeted()	Logical
on_change_state()
on_select()
on_select( on_select_callback:Function() )
on_select( on_select_signal:GlobalID?, [on_select_arg=undefined:Variant] )
on_unhandled( e:PointerEvent )
once()
release_pointer_focus()
set_is_visible( setting:Logical )
set_state( new_state:WidgetState )

enum WidgetPointerFocusBehavior

incorporates CommonCompoundMethods

Description

is_pressed() only when pointer pressed; on_select() called on pointer release.

Categories

Category	Value	Description
CLICK	0	is_pressed() only when pointer pressed; on_select() called on pointer release.
STICKY	1	is_pressed() until out-of-bounds pointer press.

Global Properties

Name	Type	Description
categories	WidgetPointerFocusBehavior[]

Global Methods

Signature	Return Type	Description
create( name:String )	WidgetPointerFocusBehavior
create( value:Int )	WidgetPointerFocusBehavior

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
description()	String
hashcode()	Int
name()	String
operator?()	Logical
operator==( other:WidgetPointerFocusBehavior )	Logical
print_to( buffer:PrintWriter )
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

enum WidgetState

incorporates CommonCompoundMethods

Categories

Category	Value	Description
IDLE	0
TARGETED	1
PRESSED	2
DISABLED	3

Global Properties

Name	Type	Description
categories	WidgetState[]

Global Methods

Signature	Return Type	Description
create( name:String )	WidgetState
create( value:Int )	WidgetState

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
description()	String
hashcode()	Int
name()	String
operator?()	Logical
operator==( other:WidgetState )	Logical
print_to( buffer:PrintWriter )
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo

UI Library API - brombres/Rogue GitHub Wiki

AbsoluteLayout.rogue

class AbsoluteLayout

Properties

Methods

AspectRatioLayoutSwitcher.rogue

class AlternateAspectLayout [compound]

Global Methods

Properties

Methods

class AspectRatioLayoutSwitcher

Properties

Methods

Border.rogue

class Border

Properties

Methods

class Padding [compound]

Global Methods

Properties

Methods

Component.rogue

class Component

Properties

Methods

class UIGeneratedStack

Properties

Methods

ComponentGroupProperties.rogue

class ComponentGroupProperties [aspect]

Description

Methods

ComponentSizeInfo.rogue

class ComponentSizeInfo [compound]

Global Methods

Properties

Methods

DisplayComponents.rogue

class DisplayComponents [compound]

Global Methods

Properties

Methods

Event.rogue

class Event

Properties

Methods

class KeyEvent

Properties

Methods

class MultitouchEvent

Properties

Methods

class PointerEvent

Properties

Methods

class ScrollEvent

Properties

Methods

class ScrollRate

Properties

Methods

class TextEvent

Properties

Methods

Filler.rogue

class Filler

Global Methods

Properties

Methods

Focus.rogue

class Focus

Properties

Font.rogue

class Font

Properties

Methods

HBox.rogue

class HBox

Properties

Methods