Module MUI

Functions

• Screen_onApplicationActive() (MUI) - 
• Screen_onClose() (MUI) - 
• Screen_onDrainEventQueue() (MUI) - 
• Screen_onDraw() (MUI) - 
• Screen_onDropFiles() (MUI) - 
• Screen_onExpose() (MUI) - 
• Screen_onInputFocusActive() (MUI) - 
• Screen_onKeyboard() (MUI) - 
• Screen_onMouse() (MUI) - 
• Screen_onMouseFocusActive() (MUI) - 
• Screen_onMoveWindow() (MUI) - 
• Screen_onOpen() (MUI) - 
• Screen_onResize() (MUI) - 
• Screen_onTimer() (MUI) - 

Classes

• ui::KeyboardFocusListener - 
    Methods:
  • handleKeyboardFocusChanged(Object newKeyboardLayer) - 
  
  
• ui::KeyRepeatAction - 
   
  
• ui::KeyRepeatConsumer - 
    Methods:
  • consumeAction(ui::Action ac) - 
  
  
• ui::MouseHoldAction - 
   
  
• ui::MouseHoldConsumer - 
    Methods:
  • consumeAction(ui::Action ac) - 
  
  
• ui::TriadKeyConsumer - 
    Methods:
  • consumeAction(ui::Action ac) - 
  
  
• ui::UI - 
    Functions:
  • ActivateFloatingLayer(ui::FloatingLayer w) : int - 
  • ActivateNextWindow() - 
  • ActivatePreviousWindow() - 
  • AddAcceleratorList(ui::AcceleratorList al) - 
  • AddCursor(String name, Cursor cursor) - Add a cursor resource
  • AddFloatingLayer(ui::FloatingLayer fl) - Adds a new layer on top of all other layers. Please notice that the layer (+children) geometry must already be set
  • AddFontAlias(String fontName, aliasFontName) - 
  • AddFontResource(ui::FontResource fr) : int - 
  • AddIcon(ui::Icon icon) - 
  • AddKbdFocusCandidates(ui::Layer c) - 
  • AddOverlay(Object l) - 
  • AddWindowXML(String xml) - 
  • AutoDetectLocalToRawKeyTable() : int - 
  • Backtrace() - 
  • BeginKbdFocusSelectionMode() - 
  • BeginMarkRegion(ui::Rectangle2f region, float bs) - 
  • BeginMouseDragOther(Object l, ui::MouseEvent ev) - 
  • CallOnUIActivate() - 
  • CallOnUIDeactivate() - 
  • CancelKbdFocusSelectionMode() - 
  • CancelKeyRepeat() - 
  • CancelSchedule(ui::TimerAction ta) : int - Cancel the given timeraction. Return true if a matching timer was found, false otherwise.
  • CancelSchedule2(List timerList, ui::TimerAction ta) - 
  • CancelScheduleFor(ui::ActionConsumer aac) - 
  • CancelScheduleFor2(List timerList, ui::ActionConsumer aac) - 
  • CancelTriadKeyTimer() - 
  • CheckAllAcceleratorLists(Key k) : int - 
  • Color32Alpha(int c32, a) : int - 
  • CompositeAll() - 
  • ConfigureGL(int bGLCore) - 
  • ConfigureHiDPI() - 
  • ConfigureKeyRepeat(int delay, rate) - 
  • ConfigureKeyRepeatFrames(int delay, rate) - 
  • ConfigureMultisampling(int numSamples, numBuffers) - 
  • ConfigureScaling(float s) - 
  • ConfigureSupersampling(int numSamples) - 
  • CreateColorGradingTexture256x16(String localPathname) : Texture - 
  • CreateCursors() - 
  • CreateLayerXML(String xml) - 
  • CycleLookAndFeel() - 
  • Debug(String msg) - 
  • Debug2(String msg) - 
  • DebugPrintC32(String prefix, int c32) - 
  • DebugPrintTimerList(List timerList) - 
  • DebugPrintTimers() - 
  • DestroyAllShaders() - 
  • DrainEventQueue() - 
  • DrawKbdFocusSelection() - 
  • DrawMarkedRegion() - 
  • EndKbdFocusSelectionMode() - 
  • EndMarkRegion() - 
  • Exit() - 
  • FindFloatingLayerAtXY(float x, y) : ui::Layer - Find floating layer / window resp. subwindow within that layer at (x;y) position
  • FindFloatingLayerBelowXY(float x, y) : ui::Layer - Find floating layer / window below window at (x;y) position (if any)
  • FindKbdFocusDown() - 
  • FindKbdFocusFirstTabRootMember() - 
  • FindKbdFocusLeft() - 
  • FindKbdFocusRight() - 
  • FindKbdFocusUp() - 
  • FindLayerAtDropXY() : ui::Layer - 
  • FindLayerAtMouseXY() : ui::Layer - 
  • FindLayerAtXY(float x, y) : ui::Layer - Find layer at absolute mouse coordinates.
  • FloatingLayerToFront(Object l) - 
  • FreeCursors() - 
  • GetAcceleratorChar(String s) : int - Extract accelerator key (prefixed by a) from string. Returns null if no accel key was found.
  • GetClipboard() - 
  • GetColorString(int c32) : String - 
  • GetEnableFontSmoothing() : int - 
  • GetEnableRedrawWindowMoveResize() - 
  • GetEnableString(int bEnabled) : String - 
  • GetEnableTransparentLayers() : int - Query whether transparent layers are currently enabled.
  • GetFontByName(String fontName_extendedStyleFlags_desiredSize) : ui::Font - 
  • GetFontByNameEx(String fontName_extendedStyleFlags_desiredSize, int bExactSizeMatch) : ui::Font - 
  • GetFontScaling() : float - 
  • GetFrontMostFloatingLayer() : ui::FloatingLayer - 
  • GetGLFramebufferId_RootFBO() : int - 
  • GetIcon(String name) : ui::Icon - 
  • GetIconScaling() : float - 
  • GetKeyboardFocus() : ui::Layer - 
  • GetKeyMod() : int - Query the current key modifier state.
  • GetLookAndFeel(String name) : ui::LookAndFeel - 
  • GetLookAndFeelIdx() : int - 
  • GetMouseFocus() : ui::Layer - 
  • GetMouseX() : float - 
  • GetMouseY() : float - 
  • GetNumFloatingLayers() : int - 
  • GetNumModalFloatingLayers() : int - 
  • GetPadScaling() : float - 
  • GetPluralString(int num) : String - 
  • GetRootLayer() : ui::Layer - 
  • GetShader(Object class) : ui::Shader - 
  • GetShaderByName(String name) : ui::Shader - 
  • GetWindowBorderScaling() : float - 
  • GrabMouse() - Grab mouse and adjust mouse_rel_x/mouse_rel_y fields accordingly
  • HandleKbdFocusSelectionKey(Key k) : int - 
  • HandleKeyboardFocusChanged() - 
  • HandleKeyRepeat() - 
  • HandleKeyRepeatEnd(Key k) - 
  • HandleLookAndFeelChanged() - 
  • HandleMouseEvent(Object layer, ui::MouseEvent ev) : int - 
  • HandleMouseHold() - 
  • HandleTriadKeyTimeout() - 
  • HSVTOARGB32(float h, s, v, int a) : int - 
  • IgnoreNextMouseRelease() - 
  • InitCallbacks() - 
  • Initialize(StringArray arguments) - 
  • IntToBinary255String(int val) : String - 
  • IsAutoFocusKey(Key k) : int - 
  • IsDark() : int - 
  • IsDarkOrMono() : int - 
  • IsHiDPI() : int - 
  • IsKeyboardFocusLocked() : int - 
  • IsLight() : int - 
  • IsLinux() : int - 
  • IsLoDPI() : int - 
  • IsMacOS() : int - 
  • IsMono() : int - 
  • IsMouseFocusAllowed(Object l) : int - 
  • IsMouseFocusLocked() : int - 
  • IsRunning() : int - 
  • IsWindows() : int - 
  • KeyModAlt() : int - 
  • KeyModAltOnly() : int - 
  • KeyModCtrl() : int - 
  • KeyModCtrlOnly() : int - 
  • KeyModNone() : int - 
  • KeyModShift() : int - 
  • KeyModShiftOnly() : int - 
  • LayoutRootLayer() - 
  • LockRedraw() - Disable UI redraws
  • LogDebug(String msg) - 
  • LogError(String msg) - 
  • LogFatal(String msg) - 
  • LogInfo(String msg) - 
  • LogInfoFast(String msg) - 
  • LogSuccess(String msg) - 
  • LogTrace(String msg) - 
  • LogVerbose(String msg) - 
  • LogWarning(String msg) - 
  • LookAndFeelForceFlat() - 
  • LoseKeyboardFocus() - Set keyboard focus to none. Do not generate events.
  • LoseKeyboardFocusIfWithin(ui::Layer l, int bQuiet) - Set keyboard focus to if it is currently set to _l or one of its child layers. Do not generate events.
  • LoseMouseFocusIfWithin(ui::Layer l) - Set mouse focus to null if it is currently set to _l or one of its child layers. Do not generate events.
  • MacOSGetInputSource() : String - 
  • MapShiftedScanCode(int code) : int - 
  • MixColor32(int x, y, float t) : int - 
  • NewObjectByFQName(String s) : Object - Allocate new object by fully qualified name.
  • OnApplicationActive(int b) - 
  • OnClose() - 
  • OnDrainEventQueue() - 
  • OnDraw() - 
  • OnDropFiles(int x, y, StringArray fileNames) - 
  • OnInputFocusActive(int b) - 
  • OnKeyboard(Key k) - 
  • OnMouse(ui::MouseEvent ev) - 
  • OnMouseFocusActive(int b) - 
  • OnMoveWindow(int x, y) - 
  • OnOpen() - 
  • OnTimer() - 
  • OpenFileDialog(String suggestedPath, suggestedFile, windowTitle, Object filterNames, filterStrings, int bMultiSel, bDirsOnly) - 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).
  • OpenWindow(int w, h) - 
  • PathNameToURL(String s) : String - 
  • PreferMonoIcons() : int - 
  • ProcessTimers(int bOnDraw) - 
  • QueueCustomResizePrefs(int w, h) - 
  • QueueReopen() - Queue screen mode change
  • QueueResize(int w, h) - Queue screen mode change
  • QueueToggleFullscreen() - Queue screen mode change (fullscreen)
  • RebindRootFBO() : ui::FBO - 
  • RecursiveHandleKey(Object c, Key k) : int - 
  • RecursiveRemoveLayerRefs(ui::Layer l) - 
  • RedrawAll() - Redraw the entire screen
  • RedrawDirty(Object l) - 
  • RegisterShaderClass(Object class) - 
  • RemoveAcceleratorList(ui::AcceleratorList al) - 
  • RemoveFloatingLayer(ui::FloatingLayer fl) - 
  • RemoveLayer(ui::Layer l) - 
  • RemoveOverlay(Object l) - 
  • ResetMouseClick() - 
  • RevertCursor() - 
  • RGB32TOHSV(int c32, Float h, s, v) - 
  • RootLayerResized() - 
  • Run() - 
  • SaveFileDialog(String suggestedPath, suggestedFile, windowTitle, Object filterNames, filterStrings, int bDirsOnly) : String - 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).
  • SaveScreenShotPNG(String pathName, int offX, offY, w, h) : int - 
  • Schedule(ui::TimerAction ta) - 
  • ScheduleTriadKeyTimer() - 
  • SelectMinDistKbdFocus() - 
  • SelectNextFBOColorGrading() - 
  • SelectPreviousFBOColorGrading() - 
  • SetClipboard(Object o) - 
  • SetCursorZoom(int zoom) - 
  • SetDefaultFBOColorGrading256x16FromLocalFile(String localPathname) - 
  • SetEnableFBO(int bEnabled) - 
  • SetEnableFBODepthBuffers(int bEnabled) - 
  • SetEnableFloatParamMouseGrab(int bEnable) - 
  • SetEnableFontSmoothing(int bEnable) - 
  • SetEnableForceHighFramerate(int bEnabled) - 
  • SetEnableForceMonoIcons(int bEnable, bInvert) - 
  • SetEnableForceUSUnicode(int bEnable) - 
  • SetEnableHeadless(int bEnable) - 
  • SetEnableHideAllOverlays(int bEnabled) - 
  • SetEnableKeyCmdCopyPaste(int bEnable) - 
  • SetEnableKeyMapSlashToLess(int bEnable) - 
  • SetEnableKeyRepeat(int bRepeat) - 
  • SetEnableLockKeyboardFocus(int bLocked) : int - Lock keyboard focus (careful here!!!)
  • SetEnableLockMouseFocus(int bLocked) - Lock mouse focus (careful here!!!)
  • SetEnableRedrawWindowMoveResize(int b) - 
  • SetEnableShadeModal(int b) : int - Enable background shading when modal floating layers are drawn. Returns previous setting.
  • SetEnableSliderMouseGrab(int bEnable) - 
  • SetEnableSpaceBarClicks(int bEnable) - 
  • SetEnableTextViewHiDPIFont(int bEnable) - 
  • SetEnableTouchMode(int bEnabled) - 
  • SetEnableTransparentLayers(int b) - Enable transparent layers
  • SetEnableVSyncKeyRepeat(int bEnable) - 
  • SetEnableWindowCornerToolTips(int bEnable) - 
  • SetFontScaling(float zoom) - 
  • SetForcedTextColor32(int c32) - 
  • SetFrameRate(float fpsLo, fpsHi) - 
  • SetGlobalPaintFlag(int mode) - 
  • SetGlobalRedrawMode(int mode, numFrames) - 
  • SetIconScaling(float zoom) - 
  • SetKbdFocusSelectionModeBehaviour(int bHoldKey) - 
  • SetKeyboardFocus(ui::Layer l) - 
  • SetKeyboardFocusEx(ui::Layer l, int bAllowMouseFocus) - 
  • SetKeyboardFocusListener(ui::KeyboardFocusListener listener) - 
  • SetKeyboardFocusQuiet(Object l) - 
  • SetKeyboardTabFocus(Object l) - 
  • SetLocalToRawKeyTableByName(String domain) : int - 
  • SetLogger(ui::Logger logger) - 
  • SetLookAndFeel(String name) - Set default look and feel (colors, fonts, timeouts, insets etc..)
  • SetLookAndFeelByIdx(int lnfIdx) - 
  • SetLookAndFeelResetCustomColors(String name) - 
  • SetMinimumSize(int w, h) - 
  • SetMouseFocus(Object l) - 
  • SetOnDrawPostProcessHook(Function fun) - 
  • SetPadScaling(float zoom) - 
  • SetPostFBOColorGrading256x16ByCycleIdx(int idx) - 
  • SetPostFBOColorGrading256x16FromLocalFile(String localPathname) - 
  • SetPostFBOColorGradingAmount(float f) - 
  • SetPostFBOColorGradingCycleCbk(Function f) - 
  • SetPostFBOColorGradingCycleList(StringArray gradientPathNames, String dir) - 
  • SetPreferredMouseLayer(Object l) - 
  • SetRootForm(ui::Form newRootForm) - 
  • SetRootLayer(Object newRootLayer) - 
  • SetTableMinimumColumnWidthScaling(float s) - 
  • SetTextViewFontScaling(float zoom) - 
  • SetToolTipFastOpenDelay(int ms) - 
  • SetToolTipFastOpenTimeout(int ms) - 
  • SetToolTipShowDelay(int ms) - 
  • SetToolTipStage2Delay(int ms) - 
  • SetViewport(int x, y, w, h) - 
  • SetWindowBorderScaling(float s) - 
  • SetZoom(float zoomX, zoomY) - Set overall UI zoom level. Must be called before opening the window/screen.
  • ShowCursor(String name) : int - Select named cursor shape
  • ShowCursorIf(String lastName, newName) : int - 
  • ShowCursorIfNot(String lastName, newName) : int - 
  • StartMouseFocusWheelTimeOut() - 
  • StartOrContinueKeyRepeat(Key k) - 
  • Stop() - 
  • StopKeyRepeat(Key k) - 
  • TintColor32(int a, b) : int - 
  • TintColor32Alpha(int a, b, a) : int - 
  • ToggleKbdFocusSelectionMode() - 
  • TogglePostFBOColorGrading() - 
  • UngrabMouse() - Ungrab mouse
  • UnlockRedraw() - Re-enable UI redraws
  • UnregisterAllShaders() - 
  • UnregisterShaderClass(Object class) - 
  • UnsetMouseFocus(ui::MouseEvent ev) - Make the current mouse layer lose the focus. Generates onMouseLeave event.
  • UpdateCursors() - 
  • UpdateFrameRate(int bHigh) - 
  • UpdateMarkedRegion(ui::Rectangle2f region) - 
  
    Constants:
  • int MAX_DIRTY_AND_DEFERRED_REGIONS - Maximum number of dirty regions for optimized drawing. If this number is exceeded, all layers will be redrawn.
  • int MOUSE_LAYER_LOCK_TIMEOUT_TICKS - 
  • int PAINT_ALL - 
  • int PAINT_DIRTY - 
  • int PAINT_NONE - 
  • int QUEUE_MODE_FULLSCREEN_TOGGLE - 
  • int QUEUE_MODE_NONE - 
  • int QUEUE_MODE_REOPEN - 
  • int REDRAW_ALL - 
  • int REDRAW_COMPOSITE - 
  • int REDRAW_DIRTY -