Class MUI.ui::UI

)

Arguments

–

→ top of page

Function AddCursor

Add a cursor resource

Signature

AddCursor	(	String	name	,
		Cursor	cursor
		)

Arguments

String	name	–
Cursor	cursor	–

→ top of page

Function AddFloatingLayer

Adds a new layer on top of all other layers. Please notice that the layer (+children) geometry must already be set

Signature

AddFloatingLayer

(

)

Arguments

–

→ top of page

Function AddFontAlias

Signature

AddFontAlias	(	String	fontName	,
		String	aliasFontName
		)

Arguments

String	fontName	–
String	aliasFontName	–

→ top of page

Function AddFontResource

Signature

AddFontResource	(	ui::FontResource	fr	)
	:	int

Arguments

ui::FontResource

–

Returns

int

–

→ top of page

Function AddIcon

Signature

AddIcon

(

ui::Icon

icon

)

Arguments

ui::Icon

icon

–

→ top of page

Function AddKbdFocusCandidates

Signature

AddKbdFocusCandidates

(

)

Arguments

–

→ top of page

Function AddWindowXML

Signature

AddWindowXML

(

xml

)

Arguments

xml

–

→ top of page

Function ApplySwapStrategyPOSTOPEN

Signature

ApplySwapStrategyPOSTOPEN

(

)

→ top of page

Function ApplySwapStrategyPREOPEN

Signature

ApplySwapStrategyPREOPEN

(

)

→ top of page

Function Backtrace

Signature

Backtrace

(

)

→ top of page

Function BeginKbdFocusSelectionMode

Signature

BeginKbdFocusSelectionMode

(

)

→ top of page

Function BeginMarkRegion

Signature

BeginMarkRegion	(	ui::Rectangle2f	region	,
		float	bs
		)

Arguments

ui::Rectangle2f	region	–
float	bs	–

→ top of page

Function CallOnUIActivate

Signature

CallOnUIActivate

(

)

→ top of page

Function CallOnUIDeactivate

Signature

CallOnUIDeactivate

(

)

→ top of page

Function CancelKbdFocusSelectionMode

Signature

CancelKbdFocusSelectionMode

(

)

→ top of page

Function CancelSchedule

Cancel the given timeraction. Return true if a matching timer was found, false otherwise.

Signature

CancelSchedule	(	ui::TimerAction	ta	)
	:	int

Arguments

ui::TimerAction

–

Returns

int

–

→ top of page

Function CancelSchedule2

Signature

CancelSchedule2	(	List	timerList	,
		ui::TimerAction	ta
		)

Arguments

List	timerList	–
ui::TimerAction	ta	–

→ top of page

Function CancelScheduleFor

Signature

CancelScheduleFor

(

ui::ActionConsumer

aac

)

Arguments

ui::ActionConsumer

aac

–

→ top of page

Function CancelScheduleFor2

Signature

CancelScheduleFor2	(	List	timerList	,
		ui::ActionConsumer	aac
		)

Arguments

List	timerList	–
ui::ActionConsumer	aac	–

→ top of page

Function CancelTriadKeyTimer

Signature

CancelTriadKeyTimer

(

)

→ top of page

Function CheckAllAcceleratorLists

Signature

CheckAllAcceleratorLists	(	Key	k	)
	:	int

Arguments

–

Returns

int

–

→ top of page

Function CompositeAll

Signature

CompositeAll

(

)

→ top of page

Function ConfigureKeyRepeat

Signature

ConfigureKeyRepeat	(	int	delay	,
		int	rate
		)

Arguments

int	delay	–
int	rate	–

→ top of page

Function ConfigureKeyRepeatFrames

Signature

ConfigureKeyRepeatFrames	(	int	delay	,
		int	rate
		)

Arguments

int	delay	–
int	rate	–

→ top of page

Function CreateLayerXML

Signature

CreateLayerXML

(

xml

)

Arguments

xml

–

→ top of page

Function Debug

Signature

Debug

(

msg

)

Arguments

msg

–

→ top of page

Function DetermineSwapStrategy

Signature

DetermineSwapStrategy

(

)

→ top of page

Function DrawKbdFocusSelection

Signature

DrawKbdFocusSelection

(

)

→ top of page

Function DrawMarkedRegion

Signature

DrawMarkedRegion

(

)

→ top of page

Function EndKbdFocusSelectionMode

Signature

EndKbdFocusSelectionMode

(

)

→ top of page

Function EndMarkRegion

Signature

EndMarkRegion

(

)

→ top of page

Function FindFloatingLayerAtXY

Find floating layer / window resp. subwindow within that layer at (x;y) position

Signature

FindFloatingLayerAtXY	(	float	x	,
		float	y
		)
	:	ui::Layer

Arguments

float	x	–
float	y	–

Returns

–

→ top of page

Function FindFloatingLayerBelowXY

Find floating layer / window below window at (x;y) position (if any)

Signature

FindFloatingLayerBelowXY	(	float	x	,
		float	y
		)
	:	ui::Layer

Arguments

float	x	–
float	y	–

Returns

–

→ top of page

Function FindKbdFocusDown

Signature

FindKbdFocusDown

(

)

→ top of page

Function FindKbdFocusFirstTabRootMember

Signature

FindKbdFocusFirstTabRootMember

(

)

→ top of page

Function FindKbdFocusLeft

Signature

FindKbdFocusLeft

(

)

→ top of page

Function FindKbdFocusRight

Signature

FindKbdFocusRight

(

)

→ top of page

Function FindKbdFocusUp

Signature

FindKbdFocusUp

(

)

→ top of page

Function FindLayerAtXY

Find layer at absolute mouse coordinates.

Signature

FindLayerAtXY	(	float	x	,
		float	y
		)
	:	ui::Layer

Arguments

float	x	–
float	y	–

Returns

–

→ top of page

Function FloatingLayerToFront

Signature

FloatingLayerToFront

(

)

Arguments

–

→ top of page

Function GetAcceleratorChar

Extract accelerator key (prefixed by a) from string. Returns null if no accel key was found.

Signature

GetAcceleratorChar	(	String	s	)
	:	int

Arguments

–

Returns

int

–

→ top of page

Function GetClipboard

Signature

GetClipboard

(

)

→ top of page

Function GetColor

Signature

GetColor	(	int	lnfIdx	)
	:	int

Arguments

int

lnfIdx

–

Returns

int

–

→ top of page

Function GetColorAlpha

Signature

GetColorAlpha	(	int	lnfIdx	,
		int	alpha
		)
	:	int

Arguments

int	lnfIdx	–
int	alpha	–

Returns

int

–

→ top of page

Function GetConfigurationFileName

Signature

GetConfigurationFileName

(

)

Returns

–

→ top of page

Function GetEnableRedrawWindowMoveResize

Signature

GetEnableRedrawWindowMoveResize

(

)

→ top of page

Function GetEnableTransparentLayers

Query whether support for tranparent layers is currently enabled.

Signature

GetEnableTransparentLayers

(

)

int

Returns

int

–

→ top of page

Function GetFontByName

Signature

GetFontByName	(	String	fontName_extendedStyleFlags_desiredSize	)
	:	ui::Font

Arguments

fontName_extendedStyleFlags_desiredSize

–

Returns

ui::Font

–

→ top of page

Function GetFrontMostFloatingLayer

Signature

GetFrontMostFloatingLayer

(

)

ui::FloatingLayer

Returns

ui::FloatingLayer

–

→ top of page

Function GetIcon

Signature

GetIcon	(	String	name	)
	:	ui::Icon

Arguments

name

–

Returns

ui::Icon

–

→ top of page

Function GetKeyboardFocus

Signature

GetKeyboardFocus

(

)

Returns

–

→ top of page

Function GetKeyMod

Query the current key modifier state.

Signature

GetKeyMod

(

)

int

Returns

int

–

→ top of page

Function GetMouseFocus

Signature

GetMouseFocus

(

)

Returns

–

→ top of page

Function GetMouseX

Signature

GetMouseX

(

)

float

Returns

float

–

→ top of page

Function GetMouseY

Signature

GetMouseY

(

)

float

Returns

float

–

→ top of page

Function GetNumFloatingLayers

Signature

GetNumFloatingLayers

(

)

int

Returns

int

–

→ top of page

Function GetNumModalFloatingLayers

Signature

GetNumModalFloatingLayers

(

)

int

Returns

int

–

→ top of page

Function GetRootLayer

Signature

GetRootLayer

(

)

Returns

–

→ top of page

Function GetTintedColor

Signature

GetTintedColor	(	int	lnfIdx	,
		int	tint32
		)
	:	int

Arguments

int	lnfIdx	–
int	tint32	–

Returns

int

–

→ top of page

Function GetTintedColorAlpha

Signature

GetTintedColorAlpha	(	int	lnfIdx	,
		int	tint32	,
		int	alpha
		)
	:	int

Arguments

int	lnfIdx	–
int	tint32	–
int	alpha	–

Returns

int

–

→ top of page

Function GrabMouse

Grab mouse and adjust mouse_rel_x/mouse_rel_y fields accordingly

Signature

GrabMouse

(

)

→ top of page

Function HandleKbdFocusSelectionKey

Signature

HandleKbdFocusSelectionKey	(	Key	k	)
	:	int

Arguments

–

Returns

int

–

→ top of page

Function HandleKeyRepeat

Signature

HandleKeyRepeat

(

)

→ top of page

Function HandleKeyRepeatEnd

Signature

HandleKeyRepeatEnd

(

)

Arguments

–

→ top of page

Function HandleLookAndFeelChanged

Signature

HandleLookAndFeelChanged

(

)

→ top of page

Function HandleMouseEvent

Signature

HandleMouseEvent	(	Object	layer	,
		ui::MouseEvent	ev
		)
	:	int

Arguments

Object	layer	–
ui::MouseEvent	ev	–

Returns

int

–

→ top of page

Function HandleMouseHold

Signature

HandleMouseHold

(

)

→ top of page

Function HandleTriadKeyTimeout

Signature

HandleTriadKeyTimeout

(

)

→ top of page

Function HSVTOARGB32

Signature

HSVTOARGB32	(	float	h	,
		float	s	,
		float	v	,
		int	a
		)
	:	int

Arguments

float	h	–
float	s	–
float	v	–
int	a	–

Returns

int

–

→ top of page

Function InitCallbacks

Signature

InitCallbacks

(

)

→ top of page

Function Initialize

Signature

Initialize

(

StringArray

arguments

)

Arguments

StringArray

arguments

–

→ top of page

Function InitScissors

Signature

InitScissors

(

)

→ top of page

Function IsMouseFocusAllowed

Signature

IsMouseFocusAllowed	(	Object	l	)
	:	int

Arguments

–

Returns

int

–

→ top of page

Function LayoutRootLayer

Signature

LayoutRootLayer

(

)

→ top of page

Function LoadConfiguration

Signature

LoadConfiguration

(

)

→ top of page

Function LockRedraw

Disable UI redraws

Signature

LockRedraw

(

)

→ top of page

Function LoseKeyboardFocus

Set keyboard focus to none. Do not generate events.

Signature

LoseKeyboardFocus

(

)

→ top of page

Function LoseKeyboardFocusIfWithin

Set keyboard focus to if it is currently set to _l or one of its child layers. Do not generate events.

Signature

LoseKeyboardFocusIfWithin	(	ui::Layer	l	,
		int	bQuiet
		)

Arguments

ui::Layer	l	–
int	bQuiet	–

→ top of page

Function LoseMouseFocusIfWithin

Set mouse focus to null if it is currently set to _l or one of its child layers. Do not generate events.

Signature

LoseMouseFocusIfWithin

(

)

Arguments

–

→ top of page

Function MixColor32

Signature

MixColor32	(	int	x	,
		int	y	,
		float	t
		)
	:	int

Arguments

int	x	–
int	y	–
float	t	–

Returns

int

–

→ top of page

Function NewObjectByFQName

Allocate new object by fully qualified name.

Signature

NewObjectByFQName	(	String	s	)
	:	Object

Arguments

–

Returns

–

→ top of page

Function OnApplicationActive

Signature

OnApplicationActive

(

int

)

Arguments

int

–

→ top of page

Function OnClose

Signature

OnClose

(

)

→ top of page

Function OnDraw

Signature

OnDraw

(

)

→ top of page

Function OnDropFiles

Signature

OnDropFiles	(	int	x	,
		int	y	,
		StringArray	fileNames
		)

Arguments

int	x	–
int	y	–
StringArray	fileNames	–

→ top of page

Function OnInputFocusActive

Signature

OnInputFocusActive

(

int

)

Arguments

int

–

→ top of page

Function OnKeyboard

Signature

OnKeyboard

(

)

Arguments

–

→ top of page

Function OnMouse

Signature

OnMouse

(

)

Arguments

–

→ top of page

Function OnMouseFocusActive

Signature

OnMouseFocusActive

(

int

)

Arguments

int

–

→ top of page

Function OnOpen

Signature

OnOpen

(

)

→ top of page

Function OnTimer

Signature

OnTimer

(

)

→ top of page

Function OpenFileDialog

Show a file dialog which lets the user select one or many files / directories. The dialogs are currently handled by a simple native OS toolkit wrapper (GTK+ or Win32).

Signature

OpenFileDialog	(	String	suggestedPath	,
		String	suggestedFile	,
		String	windowTitle	,
		Object	filterNames	,
		Object	filterStrings	,
		int	bMultiSel	,
		int	bDirsOnly
		)

Arguments

String	suggestedPath	–
String	suggestedFile	–
String	windowTitle	–
Object	filterNames	–
Object	filterStrings	–
int	bMultiSel	–
int	bDirsOnly	–

→ top of page

Function OpenWindow

Signature

OpenWindow	(	int	w	,
		int	h
		)

Arguments

int	w	–
int	h	–

→ top of page

Function PopScissors

Signature

PopScissors

(

)

→ top of page

Function ProcessTimers

Signature

ProcessTimers

(

int

bOnDraw

)

Arguments

int

bOnDraw

–

→ top of page

Function PushScissors

Signature

PushScissors	(	int	x	,
		int	y	,
		int	w	,
		int	h
		)

Arguments

int	x	–
int	y	–
int	w	–
int	h	–

→ top of page

Function QueueReopen

Queue screen mode change

Signature

QueueReopen

(

)

→ top of page

Function QueueToggleFullscreen

Queue screen mode change (fullscreen)

Signature

QueueToggleFullscreen

(

)

→ top of page

Function RecursiveHandleKey

Signature

RecursiveHandleKey	(	Object	c	,
		Key	k
		)
	:	int

Arguments

Object	c	–
Key	k	–

Returns

int

–

→ top of page

Function RecursiveRemoveLayerRefs

Signature

RecursiveRemoveLayerRefs

(

)

Arguments

–

→ top of page

Function RedrawAll

Redraw the entire screen

Signature

RedrawAll

(

)

→ top of page

Function RedrawDirty

Signature

RedrawDirty

(

)

Arguments

–

→ top of page

Function RemoveAcceleratorList

Signature

RemoveAcceleratorList

(

)

Arguments

–

→ top of page

Function RemoveFloatingLayer

Signature

RemoveFloatingLayer

(

)

Arguments

–

→ top of page

Function RemoveLayer

Signature

RemoveLayer

(

)

Arguments

–

→ top of page

Function ResetMouseClick

Signature

ResetMouseClick

(

)

→ top of page

Function RevertCursor

Signature

RevertCursor

(

)

→ top of page

Function RGB32TOHSV

Signature

RGB32TOHSV	(	int	c32	,
		Float	h	,
		Float	s	,
		Float	v
		)

Arguments

int	c32	–
Float	h	–
Float	s	–
Float	v	–

→ top of page

Function RootLayerResized

Signature

RootLayerResized

(

)

→ top of page

Function Run

Signature

Run

(

)

→ top of page

Function SaveConfiguration

Signature

SaveConfiguration

(

)

→ top of page

Function SaveFileDialog

Show a file dialog which lets the user select one or many files / directories. The dialogs are currently handled by a simple native OS toolkit wrapper (GTK+ or Win32).

Signature

SaveFileDialog	(	String	suggestedPath	,
		String	suggestedFile	,
		String	windowTitle	,
		Object	filterNames	,
		Object	filterStrings	,
		int	bDirsOnly
		)
	:	String

Arguments

String	suggestedPath	–
String	suggestedFile	–
String	windowTitle	–
Object	filterNames	–
Object	filterStrings	–
int	bDirsOnly	–

Returns

–

→ top of page

Function Schedule

Signature

Schedule

(

ui::TimerAction

)

Arguments

ui::TimerAction

–

→ top of page

Function ScheduleTriadKeyTimer

Signature

ScheduleTriadKeyTimer

(

)

→ top of page

Function SelectMinDistKbdFocus

Signature

SelectMinDistKbdFocus

(

)

→ top of page

Function SetClipboard

Signature

SetClipboard

(

)

Arguments

–

→ top of page

Function SetEnableForceHighFramerate

Signature

SetEnableForceHighFramerate

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Function SetEnableKeyRepeat

Signature

SetEnableKeyRepeat

(

int

bRepeat

)

Arguments

int

bRepeat

–

→ top of page

Function SetEnableRedrawWindowMoveResize

Signature

SetEnableRedrawWindowMoveResize

(

int

)

Arguments

int

–

→ top of page

Function SetEnableShadeModal

Enable background shading when modal floating layers are drawn. Returns previous setting.

Signature

SetEnableShadeModal	(	int	b	)
	:	int

Arguments

int

–

Returns

int

–

→ top of page

Function SetEnableTouchMode

Signature

SetEnableTouchMode

(

int

bEnabled

)

Arguments

int

bEnabled

–

→ top of page

Function SetEnableTransparentLayers

Enable support for tranparent layers

Signature

SetEnableTransparentLayers

(

int

)

Arguments

int

–

→ top of page

Function SetFrameRate

Signature

SetFrameRate	(	float	fpsLo	,
		float	fpsHi
		)

Arguments

float	fpsLo	–
float	fpsHi	–

→ top of page

Function SetGlobalPaintFlag

Signature

SetGlobalPaintFlag

(

int

mode

)

Arguments

int

mode

–

→ top of page

Function SetKbdFocusSelectionModeBehaviour

Signature

SetKbdFocusSelectionModeBehaviour

(

int

bHoldKey

)

Arguments

int

bHoldKey

–

→ top of page

Function SetKeyboardFocus

Signature

SetKeyboardFocus

(

)

Arguments

–

→ top of page

Function SetKeyboardTabFocus

Signature

SetKeyboardTabFocus

(

)

Arguments

–

→ top of page

Function SetLookAndFeel

Set look and feel (colors, fonts, timeouts, insets etc..)

Signature

SetLookAndFeel

(

ui::LookAndFeel

class

)

Arguments

ui::LookAndFeel

class

–

→ top of page

Function SetMouseFocus

Signature

SetMouseFocus

(

)

Arguments

–

→ top of page

Function SetRootForm

Signature

SetRootForm

(

ui::Form

newRootForm

)

Arguments

ui::Form

newRootForm

–

→ top of page

Function SetRootLayer

Signature

SetRootLayer

(

newRootLayer

)

Arguments

newRootLayer

–

→ top of page

Function SetViewport

Signature

SetViewport	(	int	x	,
		int	y	,
		int	w	,
		int	h
		)

Arguments

int	x	–
int	y	–
int	w	–
int	h	–

→ top of page

Function SetZoom

Set overall UI zoom level. Must be called before opening the window/screen.

Signature

SetZoom	(	float	zoomX	,
		float	zoomY
		)

Arguments

float	zoomX	–
float	zoomY	–

→ top of page

Function ShowCursor

Select named cursor shape

Signature

ShowCursor	(	String	name	)
	:	int

Arguments

name

–

Returns

int

–

→ top of page

Function ShowCursorIf

Signature

ShowCursorIf	(	String	lastName	,
		String	newName
		)

Arguments

String	lastName	–
String	newName	–

→ top of page

Function ShowCursorIfNot

Signature

ShowCursorIfNot	(	String	lastName	,
		String	newName
		)

Arguments

String	lastName	–
String	newName	–

→ top of page

Function StartOrContinueKeyRepeat

Signature

StartOrContinueKeyRepeat

(

)

Arguments

–

→ top of page

Function Stop

Signature

Stop

(

)

→ top of page

Function StopKeyRepeat

Signature

StopKeyRepeat

(

)

Arguments

–

→ top of page

Function TintColor32

Signature

TintColor32	(	int	a	,
		int	b
		)
	:	int

Arguments

int	a	–
int	b	–

Returns

int

–

→ top of page

Function ToggleKbdFocusSelectionMode

Signature

ToggleKbdFocusSelectionMode

(

)

→ top of page

Function UngrabMouse

Ungrab mouse

Signature

UngrabMouse

(

)

→ top of page

Function UnlockRedraw

Re-enable UI redraws

Signature

UnlockRedraw

(

)

→ top of page

Function UnsetMouseFocus

Make the current mouse layer lose the focus. Generates onMouseLeave event.

Signature

UnsetMouseFocus

(

)

Arguments