→ index of namespace ui
 
→ index of project ui
 
→ index of module MUI

Class MUI.ui::UI


Synopsis: 

  Base classes:
  Functions:
  Constants:

Function ActivateFloatingLayer
Signature
ActivateFloatingLayer(ui::FloatingLayerw)
 :int
Arguments
Returns
int–

 
→ top of page
Function ActivateNextWindow
Signature
ActivateNextWindow()

 
→ top of page
Function ActivatePreviousWindow
Signature
ActivatePreviousWindow()

 
→ top of page
Function AddAcceleratorList
Signature
AddAcceleratorList(ui::AcceleratorListal)
Arguments

 
→ top of page
Function AddCursor
Add a cursor resource
Signature
AddCursor(Stringname,
  Cursorcursor 
  )  
Arguments
Stringname–
Cursorcursor–

 
→ 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(ui::FloatingLayerfl)
Arguments

 
→ top of page
Function AddFontAlias
Signature
AddFontAlias(StringfontName,
  StringaliasFontName 
  )  
Arguments
StringfontName–
StringaliasFontName–

 
→ top of page
Function AddFontResource
Signature
AddFontResource(ui::FontResourcefr)
 :int
Arguments
Returns
int–

 
→ top of page
Function AddIcon
Signature
AddIcon(ui::Iconicon)
Arguments
ui::Iconicon–

 
→ top of page
Function AddKbdFocusCandidates
Signature
AddKbdFocusCandidates(ui::Layerc)
Arguments
ui::Layerc–

 
→ top of page
Function AddOverlay
Signature
AddOverlay(Objectl)
Arguments
Objectl–

 
→ top of page
Function AddWindowXML
Signature
AddWindowXML(Stringxml)
Arguments
Stringxml–

 
→ top of page
Function AutoDetectLocalToRawKeyTable
Signature
AutoDetectLocalToRawKeyTable():int
Returns
int–

 
→ top of page
Function Backtrace
Signature
Backtrace()

 
→ top of page
Function BeginKbdFocusSelectionMode
Signature
BeginKbdFocusSelectionMode()

 
→ top of page
Function BeginMarkRegion
Signature
BeginMarkRegion(ui::Rectangle2fregion,
  floatbs 
  )  
Arguments
ui::Rectangle2fregion–
floatbs–

 
→ top of page
Function BeginMouseDragOther
Signature
BeginMouseDragOther(Objectl,
  ui::MouseEventev 
  )  
Arguments

 
→ 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 CancelKeyRepeat
Signature
CancelKeyRepeat()

 
→ top of page
Function CancelSchedule
Cancel the given timeraction. Return true if a matching timer was found, false otherwise.
Signature
CancelSchedule(ui::TimerActionta)
 :int
Arguments
Returns
int–

 
→ top of page
Function CancelSchedule2
Signature
CancelSchedule2(ListtimerList,
  ui::TimerActionta 
  )  
Arguments
ListtimerList–
ui::TimerActionta–

 
→ top of page
Function CancelScheduleFor
Signature
CancelScheduleFor(ui::ActionConsumeraac)
Arguments

 
→ top of page
Function CancelScheduleFor2
Signature
CancelScheduleFor2(ListtimerList,
  ui::ActionConsumeraac 
  )  
Arguments
ListtimerList–
ui::ActionConsumeraac–

 
→ top of page
Function CancelTriadKeyTimer
Signature
CancelTriadKeyTimer()

 
→ top of page
Function CheckAllAcceleratorLists
Signature
CheckAllAcceleratorLists(Keyk)
 :int
Arguments
Keyk–
Returns
int–

 
→ top of page
Function Color32Alpha
Signature
Color32Alpha(intc32,
  inta 
  )  
 :int
Arguments
intc32–
inta–
Returns
int–

 
→ top of page
Function CompositeAll
Signature
CompositeAll()

 
→ top of page
Function ConfigureGL
Signature
ConfigureGL(intbGLCore)
Arguments
intbGLCore–

 
→ top of page
Function ConfigureHiDPI
Signature
ConfigureHiDPI()

 
→ top of page
Function ConfigureKeyRepeat
Signature
ConfigureKeyRepeat(intdelay,
  intrate 
  )  
Arguments
intdelay–
intrate–

 
→ top of page
Function ConfigureKeyRepeatFrames
Signature
ConfigureKeyRepeatFrames(intdelay,
  intrate 
  )  
Arguments
intdelay–
intrate–

 
→ top of page
Function ConfigureMultisampling
Signature
ConfigureMultisampling(intnumSamples,
  intnumBuffers 
  )  
Arguments
intnumSamples–
intnumBuffers–

 
→ top of page
Function ConfigureScaling
Signature
ConfigureScaling(floats)
Arguments
floats–

 
→ top of page
Function ConfigureSupersampling
Signature
ConfigureSupersampling(intnumSamples)
Arguments
intnumSamples–

 
→ top of page
Function CreateColorGradingTexture256x16
Signature
CreateColorGradingTexture256x16(StringlocalPathname)
 :Texture
Arguments
StringlocalPathname–
Returns
Texture–

 
→ top of page
Function CreateCursors
Signature
CreateCursors()

 
→ top of page
Function CreateLayerXML
Signature
CreateLayerXML(Stringxml)
Arguments
Stringxml–

 
→ top of page
Function CycleLookAndFeel
Signature
CycleLookAndFeel()

 
→ top of page
Function Debug
Signature
Debug(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function Debug2
Signature
Debug2(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function DebugPrintC32
Signature
DebugPrintC32(Stringprefix,
  intc32 
  )  
Arguments
Stringprefix–
intc32–

 
→ top of page
Function DebugPrintTimerList
Signature
DebugPrintTimerList(ListtimerList)
Arguments
ListtimerList–

 
→ top of page
Function DebugPrintTimers
Signature
DebugPrintTimers()

 
→ top of page
Function DestroyAllShaders
Signature
DestroyAllShaders()

 
→ top of page
Function DrainEventQueue
Signature
DrainEventQueue()

 
→ 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 Exit
Signature
Exit()

 
→ top of page
Function FindFloatingLayerAtXY
Find floating layer / window resp. subwindow within that layer at (x;y) position
Signature
FindFloatingLayerAtXY(floatx,
  floaty 
  )  
 :ui::Layer
Arguments
floatx–
floaty–
Returns

 
→ top of page
Function FindFloatingLayerBelowXY
Find floating layer / window below window at (x;y) position (if any)
Signature
FindFloatingLayerBelowXY(floatx,
  floaty 
  )  
 :ui::Layer
Arguments
floatx–
floaty–
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 FindLayerAtDropXY
Signature
FindLayerAtDropXY():ui::Layer
Returns

 
→ top of page
Function FindLayerAtMouseXY
Signature
FindLayerAtMouseXY():ui::Layer
Returns

 
→ top of page
Function FindLayerAtXY
Find layer at absolute mouse coordinates.
Signature
FindLayerAtXY(floatx,
  floaty 
  )  
 :ui::Layer
Arguments
floatx–
floaty–
Returns

 
→ top of page
Function FloatingLayerToFront
Signature
FloatingLayerToFront(Objectl)
Arguments
Objectl–

 
→ top of page
Function FreeCursors
Signature
FreeCursors()

 
→ top of page
Function GetAcceleratorChar
Extract accelerator key (prefixed by a) from string. Returns null if no accel key was found.
Signature
GetAcceleratorChar(Strings)
 :int
Arguments
Strings–
Returns
int–

 
→ top of page
Function GetClipboard
Signature
GetClipboard()

 
→ top of page
Function GetColorString
Signature
GetColorString(intc32)
 :String
Arguments
intc32–
Returns
String–

 
→ top of page
Function GetEnableFontSmoothing
Signature
GetEnableFontSmoothing():int
Returns
int–

 
→ top of page
Function GetEnableRedrawWindowMoveResize
Signature
GetEnableRedrawWindowMoveResize()

 
→ top of page
Function GetEnableString
Signature
GetEnableString(intbEnabled)
 :String
Arguments
intbEnabled–
Returns
String–

 
→ top of page
Function GetEnableTransparentLayers
Query whether transparent layers are currently enabled.
Signature
GetEnableTransparentLayers():int
Returns
int–

 
→ top of page
Function GetFontByName
Signature
GetFontByName(StringfontName_extendedStyleFlags_desiredSize)
 :ui::Font
Arguments
StringfontName_extendedStyleFlags_desiredSize–
Returns

 
→ top of page
Function GetFontByNameEx
Signature
GetFontByNameEx(StringfontName_extendedStyleFlags_desiredSize,
  intbExactSizeMatch 
  )  
 :ui::Font
Arguments
StringfontName_extendedStyleFlags_desiredSize–
intbExactSizeMatch–
Returns

 
→ top of page
Function GetFontScaling
Signature
GetFontScaling():float
Returns
float–

 
→ top of page
Function GetFrontMostFloatingLayer
Signature
GetFrontMostFloatingLayer():ui::FloatingLayer
Returns

 
→ top of page
Function GetGLFramebufferId_RootFBO
Signature
GetGLFramebufferId_RootFBO():int
Returns
int–

 
→ top of page
Function GetIcon
Signature
GetIcon(Stringname)
 :ui::Icon
Arguments
Stringname–
Returns

 
→ top of page
Function GetIconScaling
Signature
GetIconScaling():float
Returns
float–

 
→ top of page
Function GetKeyboardFocus
Signature
GetKeyboardFocus():ui::Layer
Returns

 
→ top of page
Function GetKeyMod
Query the current key modifier state.
Signature
GetKeyMod():int
Returns
int–

 
→ top of page
Function GetLookAndFeel
Signature
GetLookAndFeel(Stringname)
 :ui::LookAndFeel
Arguments
Stringname–
Returns

 
→ top of page
Function GetLookAndFeelIdx
Signature
GetLookAndFeelIdx():int
Returns
int–

 
→ top of page
Function GetMouseFocus
Signature
GetMouseFocus():ui::Layer
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 GetPadScaling
Signature
GetPadScaling():float
Returns
float–

 
→ top of page
Function GetPluralString
Signature
GetPluralString(intnum)
 :String
Arguments
intnum–
Returns
String–

 
→ top of page
Function GetRootLayer
Signature
GetRootLayer():ui::Layer
Returns

 
→ top of page
Function GetShader
Signature
GetShader(Objectclass)
 :ui::Shader
Arguments
Objectclass–
Returns

 
→ top of page
Function GetShaderByName
Signature
GetShaderByName(Stringname)
 :ui::Shader
Arguments
Stringname–
Returns

 
→ top of page
Function GetWindowBorderScaling
Signature
GetWindowBorderScaling():float
Returns
float–

 
→ 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(Keyk)
 :int
Arguments
Keyk–
Returns
int–

 
→ top of page
Function HandleKeyboardFocusChanged
Signature
HandleKeyboardFocusChanged()

 
→ top of page
Function HandleKeyRepeat
Signature
HandleKeyRepeat()

 
→ top of page
Function HandleKeyRepeatEnd
Signature
HandleKeyRepeatEnd(Keyk)
Arguments
Keyk–

 
→ top of page
Function HandleLookAndFeelChanged
Signature
HandleLookAndFeelChanged()

 
→ top of page
Function HandleMouseEvent
Signature
HandleMouseEvent(Objectlayer,
  ui::MouseEventev 
  )  
 :int
Arguments
Objectlayer–
ui::MouseEventev–
Returns
int–

 
→ top of page
Function HandleMouseHold
Signature
HandleMouseHold()

 
→ top of page
Function HandleTriadKeyTimeout
Signature
HandleTriadKeyTimeout()

 
→ top of page
Function HSVTOARGB32
Signature
HSVTOARGB32(floath,
  floats,
  floatv,
  inta 
  )  
 :int
Arguments
floath–
floats–
floatv–
inta–
Returns
int–

 
→ top of page
Function IgnoreNextMouseRelease
Signature
IgnoreNextMouseRelease()

 
→ top of page
Function InitCallbacks
Signature
InitCallbacks()

 
→ top of page
Function Initialize
Signature
Initialize(StringArrayarguments)
Arguments
StringArrayarguments–

 
→ top of page
Function IntToBinary255String
Signature
IntToBinary255String(intval)
 :String
Arguments
intval–
Returns
String–

 
→ top of page
Function IsAutoFocusKey
Signature
IsAutoFocusKey(Keyk)
 :int
Arguments
Keyk–
Returns
int–

 
→ top of page
Function IsDark
Signature
IsDark():int
Returns
int–

 
→ top of page
Function IsDarkOrMono
Signature
IsDarkOrMono():int
Returns
int–

 
→ top of page
Function IsHiDPI
Signature
IsHiDPI():int
Returns
int–

 
→ top of page
Function IsKeyboardFocusLocked
Signature
IsKeyboardFocusLocked():int
Returns
int–

 
→ top of page
Function IsLight
Signature
IsLight():int
Returns
int–

 
→ top of page
Function IsLinux
Signature
IsLinux():int
Returns
int–

 
→ top of page
Function IsLoDPI
Signature
IsLoDPI():int
Returns
int–

 
→ top of page
Function IsMacOS
Signature
IsMacOS():int
Returns
int–

 
→ top of page
Function IsMono
Signature
IsMono():int
Returns
int–

 
→ top of page
Function IsMouseFocusAllowed
Signature
IsMouseFocusAllowed(Objectl)
 :int
Arguments
Objectl–
Returns
int–

 
→ top of page
Function IsMouseFocusLocked
Signature
IsMouseFocusLocked():int
Returns
int–

 
→ top of page
Function IsRunning
Signature
IsRunning():int
Returns
int–

 
→ top of page
Function IsWindows
Signature
IsWindows():int
Returns
int–

 
→ top of page
Function KeyModAlt
Signature
KeyModAlt():int
Returns
int–

 
→ top of page
Function KeyModAltOnly
Signature
KeyModAltOnly():int
Returns
int–

 
→ top of page
Function KeyModCtrl
Signature
KeyModCtrl():int
Returns
int–

 
→ top of page
Function KeyModCtrlOnly
Signature
KeyModCtrlOnly():int
Returns
int–

 
→ top of page
Function KeyModNone
Signature
KeyModNone():int
Returns
int–

 
→ top of page
Function KeyModShift
Signature
KeyModShift():int
Returns
int–

 
→ top of page
Function KeyModShiftOnly
Signature
KeyModShiftOnly():int
Returns
int–

 
→ top of page
Function LayoutRootLayer
Signature
LayoutRootLayer()

 
→ top of page
Function LockRedraw
Disable UI redraws
Signature
LockRedraw()

 
→ top of page
Function LogDebug
Signature
LogDebug(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogError
Signature
LogError(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogFatal
Signature
LogFatal(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogInfo
Signature
LogInfo(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogInfoFast
Signature
LogInfoFast(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogSuccess
Signature
LogSuccess(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogTrace
Signature
LogTrace(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogVerbose
Signature
LogVerbose(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LogWarning
Signature
LogWarning(Stringmsg)
Arguments
Stringmsg–

 
→ top of page
Function LookAndFeelForceFlat
Signature
LookAndFeelForceFlat()

 
→ 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::Layerl,
  intbQuiet 
  )  
Arguments
ui::Layerl–
intbQuiet–

 
→ 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(ui::Layerl)
Arguments
ui::Layerl–

 
→ top of page
Function MacOSGetInputSource
Signature
MacOSGetInputSource():String
Returns
String–

 
→ top of page
Function MapShiftedScanCode
Signature
MapShiftedScanCode(intcode)
 :int
Arguments
intcode–
Returns
int–

 
→ top of page
Function MixColor32
Signature
MixColor32(intx,
  inty,
  floatt 
  )  
 :int
Arguments
intx–
inty–
floatt–
Returns
int–

 
→ top of page
Function NewObjectByFQName
Allocate new object by fully qualified name.
Signature
NewObjectByFQName(Strings)
 :Object
Arguments
Strings–
Returns
Object–

 
→ top of page
Function OnApplicationActive
Signature
OnApplicationActive(intb)
Arguments
intb–

 
→ top of page
Function OnClose
Signature
OnClose()

 
→ top of page
Function OnDrainEventQueue
Signature
OnDrainEventQueue()

 
→ top of page
Function OnDraw
Signature
OnDraw()

 
→ top of page
Function OnDropFiles
Signature
OnDropFiles(intx,
  inty,
  StringArrayfileNames 
  )  
Arguments
intx–
inty–
StringArrayfileNames–

 
→ top of page
Function OnInputFocusActive
Signature
OnInputFocusActive(intb)
Arguments
intb–

 
→ top of page
Function OnKeyboard
Signature
OnKeyboard(Keyk)
Arguments
Keyk–

 
→ top of page
Function OnMouse
Signature
OnMouse(ui::MouseEventev)
Arguments

 
→ top of page
Function OnMouseFocusActive
Signature
OnMouseFocusActive(intb)
Arguments
intb–

 
→ top of page
Function OnMoveWindow
Signature
OnMoveWindow(intx,
  inty 
  )  
Arguments
intx–
inty–

 
→ 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(StringsuggestedPath,
  StringsuggestedFile,
  StringwindowTitle,
  ObjectfilterNames,
  ObjectfilterStrings,
  intbMultiSel,
  intbDirsOnly 
  )  
Arguments
StringsuggestedPath–
StringsuggestedFile–
StringwindowTitle–
ObjectfilterNames–
ObjectfilterStrings–
intbMultiSel–
intbDirsOnly–

 
→ top of page
Function OpenWindow
Signature
OpenWindow(intw,
  inth 
  )  
Arguments
intw–
inth–

 
→ top of page
Function PathNameToURL
Signature
PathNameToURL(Strings)
 :String
Arguments
Strings–
Returns
String–

 
→ top of page
Function PreferMonoIcons
Signature
PreferMonoIcons():int
Returns
int–

 
→ top of page
Function ProcessTimers
Signature
ProcessTimers(intbOnDraw)
Arguments
intbOnDraw–

 
→ top of page
Function QueueCustomResizePrefs
Signature
QueueCustomResizePrefs(intw,
  inth 
  )  
Arguments
intw–
inth–

 
→ top of page
Function QueueReopen
Queue screen mode change
Signature
QueueReopen()

 
→ top of page
Function QueueResize
Queue screen mode change
Signature
QueueResize(intw,
  inth 
  )  
Arguments
intw–
inth–

 
→ top of page
Function QueueToggleFullscreen
Queue screen mode change (fullscreen)
Signature
QueueToggleFullscreen()

 
→ top of page
Function RebindRootFBO
Signature
RebindRootFBO():ui::FBO
Returns
ui::FBO–

 
→ top of page
Function RecursiveHandleKey
Signature
RecursiveHandleKey(Objectc,
  Keyk 
  )  
 :int
Arguments
Objectc–
Keyk–
Returns
int–

 
→ top of page
Function RecursiveRemoveLayerRefs
Signature
RecursiveRemoveLayerRefs(ui::Layerl)
Arguments
ui::Layerl–

 
→ top of page
Function RedrawAll
Redraw the entire screen
Signature
RedrawAll()

 
→ top of page
Function RedrawDirty
Signature
RedrawDirty(Objectl)
Arguments
Objectl–

 
→ top of page
Function RegisterShaderClass
Signature
RegisterShaderClass(Objectclass)
Arguments
Objectclass–

 
→ top of page
Function RemoveAcceleratorList
Signature
RemoveAcceleratorList(ui::AcceleratorListal)
Arguments

 
→ top of page
Function RemoveFloatingLayer
Signature
RemoveFloatingLayer(ui::FloatingLayerfl)
Arguments

 
→ top of page
Function RemoveLayer
Signature
RemoveLayer(ui::Layerl)
Arguments
ui::Layerl–

 
→ top of page
Function RemoveOverlay
Signature
RemoveOverlay(Objectl)
Arguments
Objectl–

 
→ top of page
Function ResetMouseClick
Signature
ResetMouseClick()

 
→ top of page
Function RevertCursor
Signature
RevertCursor()

 
→ top of page
Function RGB32TOHSV
Signature
RGB32TOHSV(intc32,
  Floath,
  Floats,
  Floatv 
  )  
Arguments
intc32–
Floath–
Floats–
Floatv–

 
→ top of page
Function RootLayerResized
Signature
RootLayerResized()

 
→ top of page
Function Run
Signature
Run()

 
→ 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(StringsuggestedPath,
  StringsuggestedFile,
  StringwindowTitle,
  ObjectfilterNames,
  ObjectfilterStrings,
  intbDirsOnly 
  )  
 :String
Arguments
StringsuggestedPath–
StringsuggestedFile–
StringwindowTitle–
ObjectfilterNames–
ObjectfilterStrings–
intbDirsOnly–
Returns
String–

 
→ top of page
Function SaveScreenShotPNG
Signature
SaveScreenShotPNG(StringpathName,
  intoffX,
  intoffY,
  intw,
  inth 
  )  
 :int
Arguments
StringpathName–
intoffX–
intoffY–
intw–
inth–
Returns
int–

 
→ top of page
Function Schedule
Signature
Schedule(ui::TimerActionta)
Arguments

 
→ top of page
Function ScheduleTriadKeyTimer
Signature
ScheduleTriadKeyTimer()

 
→ top of page
Function SelectMinDistKbdFocus
Signature
SelectMinDistKbdFocus()

 
→ top of page
Function SelectNextFBOColorGrading
Signature
SelectNextFBOColorGrading()

 
→ top of page
Function SelectPreviousFBOColorGrading
Signature
SelectPreviousFBOColorGrading()

 
→ top of page
Function SetClipboard
Signature
SetClipboard(Objecto)
Arguments
Objecto–

 
→ top of page
Function SetCursorZoom
Signature
SetCursorZoom(intzoom)
Arguments
intzoom–

 
→ top of page
Function SetDefaultFBOColorGrading256x16FromLocalFile
Signature
SetDefaultFBOColorGrading256x16FromLocalFile(StringlocalPathname)
Arguments
StringlocalPathname–

 
→ top of page
Function SetEnableFBO
Signature
SetEnableFBO(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Function SetEnableFBODepthBuffers
Signature
SetEnableFBODepthBuffers(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Function SetEnableFloatParamMouseGrab
Signature
SetEnableFloatParamMouseGrab(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableFontSmoothing
Signature
SetEnableFontSmoothing(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableForceHighFramerate
Signature
SetEnableForceHighFramerate(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Function SetEnableForceMonoIcons
Signature
SetEnableForceMonoIcons(intbEnable,
  intbInvert 
  )  
Arguments
intbEnable–
intbInvert–

 
→ top of page
Function SetEnableForceUSUnicode
Signature
SetEnableForceUSUnicode(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableHeadless
Signature
SetEnableHeadless(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableHideAllOverlays
Signature
SetEnableHideAllOverlays(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Function SetEnableKeyCmdCopyPaste
Signature
SetEnableKeyCmdCopyPaste(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableKeyMapSlashToLess
Signature
SetEnableKeyMapSlashToLess(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableKeyRepeat
Signature
SetEnableKeyRepeat(intbRepeat)
Arguments
intbRepeat–

 
→ top of page
Function SetEnableLockKeyboardFocus
Lock keyboard focus (careful here!!!)
Signature
SetEnableLockKeyboardFocus(intbLocked)
 :int
Arguments
intbLocked–
Returns
int–

 
→ top of page
Function SetEnableLockMouseFocus
Lock mouse focus (careful here!!!)
Signature
SetEnableLockMouseFocus(intbLocked)
Arguments
intbLocked–

 
→ top of page
Function SetEnableRedrawWindowMoveResize
Signature
SetEnableRedrawWindowMoveResize(intb)
Arguments
intb–

 
→ top of page
Function SetEnableShadeModal
Enable background shading when modal floating layers are drawn. Returns previous setting.
Signature
SetEnableShadeModal(intb)
 :int
Arguments
intb–
Returns
int–

 
→ top of page
Function SetEnableSliderMouseGrab
Signature
SetEnableSliderMouseGrab(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableSpaceBarClicks
Signature
SetEnableSpaceBarClicks(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableTextViewHiDPIFont
Signature
SetEnableTextViewHiDPIFont(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableTouchMode
Signature
SetEnableTouchMode(intbEnabled)
Arguments
intbEnabled–

 
→ top of page
Function SetEnableTransparentLayers
Enable transparent layers
Signature
SetEnableTransparentLayers(intb)
Arguments
intb–

 
→ top of page
Function SetEnableVSyncKeyRepeat
Signature
SetEnableVSyncKeyRepeat(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetEnableWindowCornerToolTips
Signature
SetEnableWindowCornerToolTips(intbEnable)
Arguments
intbEnable–

 
→ top of page
Function SetFontScaling
Signature
SetFontScaling(floatzoom)
Arguments
floatzoom–

 
→ top of page
Function SetForcedTextColor32
Signature
SetForcedTextColor32(intc32)
Arguments
intc32–

 
→ top of page
Function SetFrameRate
Signature
SetFrameRate(floatfpsLo,
  floatfpsHi 
  )  
Arguments
floatfpsLo–
floatfpsHi–

 
→ top of page
Function SetGlobalPaintFlag
Signature
SetGlobalPaintFlag(intmode)
Arguments
intmode–

 
→ top of page
Function SetGlobalRedrawMode
Signature
SetGlobalRedrawMode(intmode,
  intnumFrames 
  )  
Arguments
intmode–
intnumFrames–

 
→ top of page
Function SetIconScaling
Signature
SetIconScaling(floatzoom)
Arguments
floatzoom–

 
→ top of page
Function SetKbdFocusSelectionModeBehaviour
Signature
SetKbdFocusSelectionModeBehaviour(intbHoldKey)
Arguments
intbHoldKey–

 
→ top of page
Function SetKeyboardFocus
Signature
SetKeyboardFocus(ui::Layerl)
Arguments
ui::Layerl–

 
→ top of page
Function SetKeyboardFocusEx
Signature
SetKeyboardFocusEx(ui::Layerl,
  intbAllowMouseFocus 
  )  
Arguments
ui::Layerl–
intbAllowMouseFocus–

 
→ top of page
Function SetKeyboardFocusListener
Signature
SetKeyboardFocusListener(ui::KeyboardFocusListenerlistener)
Arguments

 
→ top of page
Function SetKeyboardFocusQuiet
Signature
SetKeyboardFocusQuiet(Objectl)
Arguments
Objectl–

 
→ top of page
Function SetKeyboardTabFocus
Signature
SetKeyboardTabFocus(Objectl)
Arguments
Objectl–

 
→ top of page
Function SetLocalToRawKeyTableByName
Signature
SetLocalToRawKeyTableByName(Stringdomain)
 :int
Arguments
Stringdomain–
Returns
int–

 
→ top of page
Function SetLogger
Signature
SetLogger(ui::Loggerlogger)
Arguments
ui::Loggerlogger–

 
→ top of page
Function SetLookAndFeel
Set default look and feel (colors, fonts, timeouts, insets etc..)
Signature
SetLookAndFeel(Stringname)
Arguments
Stringname–

 
→ top of page
Function SetLookAndFeelByIdx
Signature
SetLookAndFeelByIdx(intlnfIdx)
Arguments
intlnfIdx–

 
→ top of page
Function SetLookAndFeelResetCustomColors
Signature
SetLookAndFeelResetCustomColors(Stringname)
Arguments
Stringname–

 
→ top of page
Function SetMinimumSize
Signature
SetMinimumSize(intw,
  inth 
  )  
Arguments
intw–
inth–

 
→ top of page
Function SetMouseFocus
Signature
SetMouseFocus(Objectl)
Arguments
Objectl–

 
→ top of page
Function SetOnDrawPostProcessHook
Signature
SetOnDrawPostProcessHook(Functionfun)
Arguments
Functionfun–

 
→ top of page
Function SetPadScaling
Signature
SetPadScaling(floatzoom)
Arguments
floatzoom–

 
→ top of page
Function SetPostFBOColorGrading256x16ByCycleIdx
Signature
SetPostFBOColorGrading256x16ByCycleIdx(intidx)
Arguments
intidx–

 
→ top of page
Function SetPostFBOColorGrading256x16FromLocalFile
Signature
SetPostFBOColorGrading256x16FromLocalFile(StringlocalPathname)
Arguments
StringlocalPathname–

 
→ top of page
Function SetPostFBOColorGradingAmount
Signature
SetPostFBOColorGradingAmount(floatf)
Arguments
floatf–

 
→ top of page
Function SetPostFBOColorGradingCycleCbk
Signature
SetPostFBOColorGradingCycleCbk(Functionf)
Arguments
Functionf–

 
→ top of page
Function SetPostFBOColorGradingCycleList
Signature
SetPostFBOColorGradingCycleList(StringArraygradientPathNames,
  Stringdir 
  )  
Arguments
StringArraygradientPathNames–
Stringdir–

 
→ top of page
Function SetPreferredMouseLayer
Signature
SetPreferredMouseLayer(Objectl)
Arguments
Objectl–

 
→ top of page
Function SetRootForm
Signature
SetRootForm(ui::FormnewRootForm)
Arguments
ui::FormnewRootForm–

 
→ top of page
Function SetRootLayer
Signature
SetRootLayer(ObjectnewRootLayer)
Arguments
ObjectnewRootLayer–

 
→ top of page
Function SetTableMinimumColumnWidthScaling
Signature
SetTableMinimumColumnWidthScaling(floats)
Arguments
floats–

 
→ top of page
Function SetTextViewFontScaling
Signature
SetTextViewFontScaling(floatzoom)
Arguments
floatzoom–

 
→ top of page
Function SetToolTipFastOpenDelay
Signature
SetToolTipFastOpenDelay(intms)
Arguments
intms–

 
→ top of page
Function SetToolTipFastOpenTimeout
Signature
SetToolTipFastOpenTimeout(intms)
Arguments
intms–

 
→ top of page
Function SetToolTipShowDelay
Signature
SetToolTipShowDelay(intms)
Arguments
intms–

 
→ top of page
Function SetToolTipStage2Delay
Signature
SetToolTipStage2Delay(intms)
Arguments
intms–

 
→ top of page
Function SetViewport
Signature
SetViewport(intx,
  inty,
  intw,
  inth 
  )  
Arguments
intx–
inty–
intw–
inth–

 
→ top of page
Function SetWindowBorderScaling
Signature
SetWindowBorderScaling(floats)
Arguments
floats–

 
→ top of page
Function SetZoom
Set overall UI zoom level. Must be called before opening the window/screen.
Signature
SetZoom(floatzoomX,
  floatzoomY 
  )  
Arguments
floatzoomX–
floatzoomY–

 
→ top of page
Function ShowCursor
Select named cursor shape
Signature
ShowCursor(Stringname)
 :int
Arguments
Stringname–
Returns
int–

 
→ top of page
Function ShowCursorIf
Signature
ShowCursorIf(StringlastName,
  StringnewName 
  )  
 :int
Arguments
StringlastName–
StringnewName–
Returns
int–

 
→ top of page
Function ShowCursorIfNot
Signature
ShowCursorIfNot(StringlastName,
  StringnewName 
  )  
 :int
Arguments
StringlastName–
StringnewName–
Returns
int–

 
→ top of page
Function StartMouseFocusWheelTimeOut
Signature
StartMouseFocusWheelTimeOut()

 
→ top of page
Function StartOrContinueKeyRepeat
Signature
StartOrContinueKeyRepeat(Keyk)
Arguments
Keyk–

 
→ top of page
Function Stop
Signature
Stop()

 
→ top of page
Function StopKeyRepeat
Signature
StopKeyRepeat(Keyk)
Arguments
Keyk–

 
→ top of page
Function TintColor32
Signature
TintColor32(inta,
  intb 
  )  
 :int
Arguments
inta–
intb–
Returns
int–

 
→ top of page
Function TintColor32Alpha
Signature
TintColor32Alpha(inta,
  intb,
  inta 
  )  
 :int
Arguments
inta–
intb–
inta–
Returns
int–

 
→ top of page
Function ToggleKbdFocusSelectionMode
Signature
ToggleKbdFocusSelectionMode()

 
→ top of page
Function TogglePostFBOColorGrading
Signature
TogglePostFBOColorGrading()

 
→ top of page
Function UngrabMouse
Ungrab mouse
Signature
UngrabMouse()

 
→ top of page
Function UnlockRedraw
Re-enable UI redraws
Signature
UnlockRedraw()

 
→ top of page
Function UnregisterAllShaders
Signature
UnregisterAllShaders()

 
→ top of page
Function UnregisterShaderClass
Signature
UnregisterShaderClass(Objectclass)
Arguments
Objectclass–

 
→ top of page
Function UnsetMouseFocus
Make the current mouse layer lose the focus. Generates onMouseLeave event.
Signature
UnsetMouseFocus(ui::MouseEventev)
Arguments

 
→ top of page
Function UpdateCursors
Signature
UpdateCursors()

 
→ top of page
Function UpdateFrameRate
Signature
UpdateFrameRate(intbHigh)
Arguments
intbHigh–

 
→ top of page
Function UpdateMarkedRegion
Signature
UpdateMarkedRegion(ui::Rectangle2fregion)
Arguments
ui::Rectangle2fregion–

 
→ top of page
Constant MAX_DIRTY_AND_DEFERRED_REGIONS (int)
Maximum number of dirty regions for optimized drawing. If this number is exceeded, all layers will be redrawn.
Description
also: Maximum number of regions that may request redraw() during redraw().
Constant MOUSE_LAYER_LOCK_TIMEOUT_TICKS (int)
Constant PAINT_ALL (int)
Constant PAINT_DIRTY (int)
Constant PAINT_NONE (int)
Constant QUEUE_MODE_FULLSCREEN_TOGGLE (int)
Constant QUEUE_MODE_NONE (int)
Constant QUEUE_MODE_REOPEN (int)
Constant REDRAW_ALL (int)
Constant REDRAW_COMPOSITE (int)
Constant REDRAW_DIRTY (int)

 

Project Modules:MAbstractXMLForm , MAcceleratorKey , MAcceleratorList , MAction , MActionConsumer , MActionProvider , MBezier01Edit , MBezierEdit , MButton , MCharFilter , MCharFilterBinary255Expr , MCharFilterFloat , MCharFilterFloatExpr , MCharFilterHex , MCharFilterHexExpr , MCharFilterHexShort , MCharFilterHexShortExpr , MCharFilterUFix16 , MCheckBox , MChoiceDialog , MCmdProvider , MColorBox , MColorButton , MComboBox , MComboBoxPopup , MComboBoxTM , MComboField , MComposite , MControl , MCursorShapes , MDial , MDialog , MDragHandleLabel , MDynamicPopupMenuAction , MFBO , MFloatAction , MFloatField , MFloatingLayer , MFloatParam , MFloatParamDialog , MFloatParamEditor , MFlowLayout , MFont , MFontCache , MFontResource , MForm , MFT2Face , MFT2FontResource , MFT2Glyph , MGeometry4f , MGraph , MGraphForm , MGridLayout , MHiddenPanel , MHSVColorPicker , MIcon , MIconCache , MInfoDialog , MIntAction , MKeyAction , MKeyboardMonitor , MKeyHelpDialog , MLabel , MLayer , MLayerSwitch , MLayout , MLogger , MLookAndFeel , MLookAndFeel_Dark , MLookAndFeel_Light , MLookAndFeel_Mono , MMouseEvent , MObjectAction , MOpaquePanel , MPanel , MPNGIcon , MPopupMenu , MPopupMenuBar , MPopupMenuBarButton , MPopupMenuButton , MPopupMenuCheckButton , MPopupMenuFolderButton , MPopupMenuSeparator , MPopupMenuWindowDock , MRadioButton , MRadioButtonGroup , MRectangle2f , MRepeatButton , MScroller , MScrollPane , MShader , MShader_ColorGrading , MShader_GradientH , MShader_GradientR , MShader_GradientV , MShader_InvertColor , MShader_PatternFill , MShader_PatternGradientH , MShader_PatternGradientR , MShader_PatternGradientV , MShader_SharpenFilter , MShader_SharpenFilterAndColorGrading , MShape , MShapePolyline , MSizeGroup , MSizeGroupX , MSizeGroupXY , MSizeGroupY , MSlider , MSpacer , MSplitPane , MStatusBar , MStringAction , MStringDialog , MSuperBorderLayout , MTableCellEditor , MTableCellEditorCheckBox , MTableCellEditorComboBox , MTableCellEditorFloatParam , MTableCellEditorString , MTableModel , MTableView , MTableViewData , MTableViewHeader , MTabSwitch , MTextEdit , MTextEditDialog , MTextField , MTextFieldIncDec , MTextInputDialog , MTextView , MTimerAction , MTitledPanel , MToolTip , MTransparentPanel , MTreeTableModel , MTreeTableNode , MUI , MUIConstants , MUIPluginLoader , MUIRenderer , MUserDataContainer , MValueAction , MView , MViewPane , MWindow , MWindowDock , MWindowTitleBar , MXFMObject , MXMLForm , MXYPad 
Project Classes:CmdProvider , ColorBox , graph::AttribsBase , graph::BBox , graph::Canvas , graph::Cell , graph::Edge , graph::GR , graph::Graph , graph::GRGradient , graph::GRPalette , graph::GRParseContext , graph::GRStyle , graph::GRUtils , graph::Node , graph::Port , graph::PortsBase , HSVColorPicker , ui::AbstractXMLForm , ui::AcceleratorKey , ui::AcceleratorList , ui::Action , ui::ActionConsumer , ui::ActionProvider , ui::Bezier01Edit , ui::BezierEdit , ui::BezierEditState , ui::BezierHistory , ui::BezierLUT01 , ui::BorderLayout , ui::Button , ui::CharFilter , ui::CharFilterBinary255Expr , ui::CharFilterFloat , ui::CharFilterFloatExpr , ui::CharFilterHex , ui::CharFilterHexExpr , ui::CharFilterHexShort , ui::CharFilterHexShortExpr , ui::CharFilterUFix16 , ui::CheckBox , ui::ChoiceDialog , ui::ColorButton , ui::ComboBox , ui::ComboBoxPopup , ui::ComboBoxTM , ui::ComboField , ui::Composite , ui::Control , ui::CursorShapes , ui::Dial , ui::Dialog , ui::DragHandleLabel , ui::DynamicPopupMenuAction , ui::FBO , ui::FloatAction , ui::FloatField , ui::FloatingLayer , ui::FloatParam , ui::FloatParamDialog , ui::FloatParamEditor , ui::FlowLayout , ui::Font , ui::FontCache , ui::FontResource , ui::Form , ui::FT2Face , ui::FT2FontResource , ui::FT2Glyph , ui::FT2LocalFileFontResource , ui::FT2PakFileFontResource , ui::Geometry4f , ui::GraphEdge , ui::GraphEdgeArrow , ui::GraphForm , ui::GraphPortButton , ui::GridLayout , ui::HiddenPanel , ui::Icon , ui::IconCache , ui::InfoDialog , ui::IntAction , ui::KeyAction , ui::KeyboardFocusListener , ui::KeyboardMonitor , ui::KeyboardMonitorEntry , ui::KeyHelpButton , ui::KeyHelpDialog , ui::KeyHelpToolTip , ui::KeyRepeatAction , ui::KeyRepeatConsumer , ui::Label , ui::Layer , ui::LayerSwitch , ui::Layout , ui::Logger , ui::LookAndFeel , ui::LookAndFeelDefs , ui::LookAndFeel_Dark , ui::LookAndFeel_Light , ui::LookAndFeel_Mono , ui::MouseEvent , ui::MouseHoldAction , ui::MouseHoldConsumer , ui::ObjectAction , ui::OpaquePanel , ui::Panel , ui::PNGIcon , ui::PopupMenu , ui::PopupMenuBar , ui::PopupMenuBarButton , ui::PopupMenuButton , ui::PopupMenuCheckButton , ui::PopupMenuFolderButton , ui::PopupMenuRadioButton , ui::PopupMenuSeparator , ui::PopupMenuWindowDock , ui::RadioButton , ui::RadioButtonGroup , ui::Rectangle2f , ui::RepeatButton , ui::Scroller , ui::ScrollPane , ui::Shader , ui::Shader_ColorGrading , ui::Shader_GradientH , ui::Shader_GradientR , ui::Shader_GradientV , ui::Shader_InvertColor , ui::Shader_PatternFill , ui::Shader_PatternGradientH , ui::Shader_PatternGradientR , ui::Shader_PatternGradientV , ui::Shader_SharpenFilter , ui::Shader_SharpenFilterAndColorGrading , ui::Shape , ui::ShapePolyline , ui::SizeGroup , ui::SizeGroupX , ui::SizeGroupXY , ui::SizeGroupY , ui::Slider , ui::Spacer , ui::SplitPane , ui::StatusBar , ui::StatusBarListener , ui::StatusBarMessage , ui::StringAction , ui::StringDialog , ui::StringDialogTextField , ui::SuperBorderLayout , ui::TableCellEditor , ui::TableCellEditorCheckBox , ui::TableCellEditorComboBox , ui::TableCellEditorFloatParam , ui::TableCellEditorString , ui::TableGraphPanel , ui::TableModel , ui::TableView , ui::TableViewData , ui::TableViewHeader , ui::TabSwitch , ui::TabSwitchLabelPanel , ui::TextEdit , ui::TextEditDialog , ui::TextEditPlugin , ui::TextEditUndoEntry , ui::TextField , ui::TextFieldIncDec , ui::TextInputDialog , ui::TextView , ui::TextViewSyntaxHighlighter , ui::TimerAction , ui::TitledPanel , ui::ToolTip , ui::TransparentPanel , ui::TreeTableModel , ui::TreeTableNode , ui::TriadKeyConsumer , ui::UI , ui::UIConstants , ui::UIRenderer , ui::UserDataContainer , ui::ValueAction , ui::View , ui::ViewPane , ui::Window , ui::WindowDock , ui::WindowTitleBar , ui::XFMObject , ui::XMLForm , ui::XYPad 
Project Functions:getTableViewStepCoarse , Screen_onApplicationActive , Screen_onClose , Screen_onDrainEventQueue , Screen_onDraw , Screen_onDropFiles , Screen_onExpose , Screen_onInputFocusActive , Screen_onKeyboard , Screen_onMouse , Screen_onMouseFocusActive , Screen_onMoveWindow , Screen_onOpen , Screen_onResize , Screen_onTimer , SetDebugLevel , SetDebugLevel , SetEnableProfiling 
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 


auto-generated by "DOG", the TkScript document generator. Tue, 3/Mar/2026 18:10:18