bmx-site/docs/api/maxgui/maxgui_gtk3maxgui.md

---

id: maxgui.gtk3maxgui title: MaxGUI.GTK3MaxGUI

sidebar_label: MaxGUI.GTK3MaxGUI

Types

Type	Description
TGTKDesktop	The Desktop.
TGTKContainer	This type handles "internal" widget containers for "Container" gadgets.
TGTKWindow	A Window
TGTKMenuItem	A menu item.
TGTKButton	Base type for button gadgets.
TGTKButtonPush	A push button
TGTKToggleButton	A button which has a toggle-type usage (radio / checkbox)
TGTKButtonRadio	A radio button.
TGTKButtonCheckbox	A checkbox button
TGTKLabel	A label.
TGTKEditable	Base type for editable gadgets (textfield / textarea).
TGTKTextField	A Text field.
TGTKList	A base for list gadgets.
TGTKComboBox	A combo box
TGTKListWithScrollWindow	A scrollable list.
TGTKListbox	List box
TGTKTreeViewNode	A node in the tree view.
TGTKTreeView	A tree view.
TGTKRange	A base-type for handling slider / range gadgets - ScrollBar and TrackBar
TGTKScrollBar	A scrollbar
TGTKTrackBar	A trackbar
TGTKProgressBar	A progress bar
TGTKToolbar	A Toolbar
TGTKTabber	A tabber.
TGTKPanel	A Panel
TGTKDefaultTextArea	A text area.
TGTKHTMLView	A base type for html view gadgets.
TGTKTextArea	A base type for text area gadgets.

Methods

Method SetShow:Int(truefalse:Int)

Show or hide the gadget.

Method setToolTip:Int(tip:String)

Set the gadget tooltip.

Method Activate:Int(cmd:Int)

Perform an activation command on the gadget.

Method ClientWidth:Int()

Return the gadget's client width.

Method ClientHeight:Int()

Return the gadget's client height.

Method State:Int()

Return the gadget state.

Method SetProp:Int(value:Int)

Sets the value on the slider.

Method GetProp:Int()

Returns the current slider value.

Method SetRange:Int(visible:Int, total:Int)

Sets the slider range.

Method SetClipboardText(text:String)

Sets the clipboard with the current text

Method ClipboardText:String()

Gets the text from the clipboard

Functions

Function OnFocusLost:Int(widget:Byte Ptr, event:Byte Ptr, obj:Object)

Callback for focus lost.

Function SetAppIcon(pix:TPixmap)

Sets the application icon.

Note: Until BRL add app icon functionality, consider this function API volatile.

Function SetButtonPixmap(gadget:TGadget, pixmap:TPixmap)

Sets the button image using the specified pixmap.

Note: Until BRL add button image functionality, consider this function API volatile.

Function GetWindowPointerPos(window:TGadget, x:Int Var, y:Int Var)

Returns pointer coordinates relative to window.

Function GetScreenPointerPos(x:Int Var, y:Int Var)

Returns pointer coordinates relative to the screen.