BlitzMax/Modules/MaxGUI/MaxGUI

The MaxGUI module contains commands to create and control user interfaces for developing applications in BlitzMax.

Users should be familiar with the WaitEvent command and BlitzMax events which provide the basic communication mechanism between user interface and program when developing MaxGUI applications.

=Gadgets= MaxGUI provides numerous types of gadgets that can be created and arranged for the purposes of providing a user interface to BlitzMax applications.

The position of gadgets in relation to their group (parent) gadget can be controlled with the SetGadgetShape command and monitored with the GadgetX, GadgetY, GadgetWidth and GadgetHeight commands. Gadgets that can act as group gadgets (such as Windows, Tabbers and Panels) have an inner client region that contains their children, with an area that can be found using ClientWidth and ClientHeight.

Gadgets can be made to automatically reposition themselves when their group gadget changes size with the SetGadgetLayout command.

A gadget's group, or parent, gadget can be retrieved using the GadgetGroup command. A gadget can be shown with ShowGadget, hidden with HideGadget, its visibility found with the GadgetHidden function and removed completely from the system with the FreeGadget command. It is now also possible to determine a gadget's class/type using the GadgetClass command.

EnableGadget, DisableGadget and GadgetDisabled control and determine if a gadget is currently enabled.

ActivateGadget will set a particular gadget as active so that it is highlighted and receives any keyboard events while ActiveGadget returns which gadget (if any) is currently active.

SetGadgetText, SetGadgetFont, SetGadgetColor and SetGadgetTextColor change the appearance of many of the MaxGUI gadgets.

Those wanting to store their own object with gadget can do so using the SetGadgetExtra command - a reference to your object will be stored inside the TGadget type and is retrievable using the matching GadgetExtra command. The object reference will be overwritten by future calls to SetGadgetExtra or when FreeGadget is called.

Recently, SetGadgetTooltip and GadgetTooltip have been added to MaxGUI to allow tooltips to be set on standard non list-based gadgets, including Buttons, Labels, TextFields etc.

Tooltips are set on an item-by-item basis for gadgets such as ListBoxes and Tabbers etc. Attempting to set an overall gadget tooltip on an list-based gadget will simply mean the function will fail silently, without throwing a runtime exception.

Finally, a more generic SetGadgetPixmap command has been added which will eventually allow you to set pixmaps for many gadgets (not just for panels), depending on your platform.

Events
Gadgets that allow user-interaction emit events that can be caught and processed in your main application loop (typically with the WaitEvent command). The events a gadget can generate will be listed under the corresponding CreateGadget documentation.

It is important to note, however, that events are only emitted when the user interacts with, or changes the state, of a gadget. Any changes made to gadget through MaxGUI command calls (such as SelectGadgetItem) should not result in events being emitted.

Windows
A Window is used to contain a collection of gadgets that make up the user interface of an application. The CreateWindow command creates a Window of a specified size that can then be used as the group parameter for the other gadget creation commands.

The WindowMenu command returns a handle that can be used as the parent parameter of the CreateMenu command to add menus to a Window. UpdateWindowMenu should be called after adding/changing a Windows menu for the changes to take effect. A window can be activated (bring the window to the top of the screen, and give focus) with the ActivateWindow command. The text displayed in a Window's optional status-bar can be modified the SetStatusText command.

If a Window is resizable (created with the WINDOW_RESIZABLE style) its size can be restrained with SetMinWindowSize and SetMaxWindowSize and it can be minimized, maximized and restored with the MinimizeWindow, MaximizeWindow and RestoreWindow commands. The minimized and maximized state of a Window can be found using the WindowMinimized and WindowMaximized commands respectively.

Menus
The CreateMenu command is used to create menu items. Menus can be attached to a Window's menu bar by parenting them to a WindowMenu or can popup at the current mouse location if used with the PopupWindowMenu command.

FreeMenu removes a menu from its parent, SetMenuText modifies a Menu's text label, CheckMenu adds a check to a Menu item and UncheckMenu removes it. EnableMenu allows a Menu item to be selected while DisableMenu will "gray out" a Menu item. MenuText returns a Menu's current text label, while MenuChecked and MenuEnabled return the state of the specified Menu.

Buttons
The CreateButton command is used to add buttons to an application's user interface. Buttons can be normal push buttons that emit an event when pushed, or they can be created with the BUTTON_CHECKBOX or BUTTON_RADIO styles in which case they can be selected or deselected by the user (or programatically with the SetButtonState command). Their current state can be found with the help of the ButtonState function.

Panels
The CreatePanel command is used to create a Panel gadget. Panels can be used to group other gadgets together and can optionally have a background color or image using the SetPanelColor or SetPanelPixmap commands. Panels can feature a border and may generate mouse/key events with the optional PANEL_BORDER and PANEL_ACTIVE styles respectively.

Text Fields
A Text-Field allows the users to enter a single line of text. The CreateTextField command creates a Text-Field at the specified location, an optional TEXTFIELD_PASSWORD style can be used to create a password style entry field (all input is masked with a single character). The TextFieldText command can be used to retrieve the current contents of the Text Field gadget.

Text Areas
Text Areas can display and optionally allow the editing of multiple lines of text. The CreateTextArea command creates a Text Area with optional TEXTAREA_WORDWRAP and TEXTAREA_READONLY styles, SetTextAreaText inserts or overwrites text in a Text Area, while AddTextAreaText appends text to the end of a Text Area gadget.

TextAreaText returns either a portion or the entire contents of a Text Area while TextAreaLen returns either the number of characters or lines currently contained in a Text Area.

The cursor position and selection length can be found with the TextAreaCursor and TextAreaSelLen commands and controlled with the SelectTextAreaText command.

SetTextAreaTabs controls the tab size of a Text Area gadget while SetTextAreaFont and SetTextAreaColor affect the style and appearance of the text displayed in a Text Area. LockTextArea and UnlockTextArea lock and unlock a Text Area gadget for improved performance when formatting a Text Area's contents with the FormatTextAreaText command.

TextAreaChar finds the character position of a given line in a Text Area gadget, while the line of a given character position in a TextArea gadget can be found with the TextAreaLine command.

It is now also possible to find the x,y coordinates of a character position in a TextArea gadget using the TextAreaCharX and TextAreaCharY commands.

Combo Boxes
Combo-boxes provide a dropdown list of options to the user with an optional style that allows the user to enter their own text in a similar manner to the TextField gadget. CreateComboBox creates a ComboBox and the standard list based gadget commands ClearGadgetItems, AddGadgetItem, ModifyGadgetItem, RemoveGadgetItem, SelectGadgetItem, SelectedGadgetItem, CountGadgetItems and GadgetItemText can be used to manage the items contained by the ComboBox gadget.

List Boxes
List-boxes are similar to ComboBoxes but features a scrolling list rather than a drop-down selection mechanism. The CreateListBox command is used to create a ListBox gadget while the standard list based gadget commands listed in the previous ComboBox section are used to manage the items.

Toolbars
ToolBars feature a list of icons and optional Tips that popup when the user holds the mouse over an icon. The CreateToolBar command creates a window toolbar using a previously loaded TIconStrip or using a specified image file containing a strip of icons.

EnableGadgetItem and DisableGadgetItem control the interactive state of individual items while SetToolBarTips assigns a list of meaningful strings to the toolbar items.

The recommended icon size for toolbars is 24x24 pixels which seems to work well on most platforms. Using a different image size may result in the pixmaps being scaled before being set depending on the OS.

It is important to note that ToolBars should only ever be added to Windows - adding ToolBars to other group gadgets may cause your program to crash on some platforms.

Tabbers
The CreateTabber command creates a tab control gadget commonly used to group gadgets into a collection of pages. The standard list based gadget commands ClearGadgetItems, AddGadgetItem, ModifyGadgetItem, RemoveGadgetItem, SelectGadgetItem, SelectedGadgetItem, CountGadgetItems and GadgetItemText can be used to manage the items contained in a Tabber gadget.

TreeViews
A TreeView is used to display hierarchical data where items are contained in nodes that can be children of other nodes. The CreateTreeView command creates a new TreeView gadget that provides a TreeViewRoot used to create a tree of nodes.

AddTreeViewNode, InsertTreeViewNode, ModifyTreeViewNode, ExpandTreeViewNode, CollapseTreeViewNode and FreeTreeViewNode provide commands to control the contents of a TreeView.

SelectedTreeViewNode and SelectTreeViewNode return and set the currently highlighted node in a TreeView while CountTreeViewNodes returns the number of nodes contained in a single TreeViewNode. FreeTreeViewNode and ClearTreeView can be used to remove nodes previously added to a TreeView gadget.

HtmlViews
An HTMLView is a gadget containing a complete web browser display. The CreateHTMLView command creates an HTMLView gadget while HtmlViewGo, HtmlViewBack and HtmlViewForward control the page being displayed.

HtmlViewStatus and HtmlViewCurrentURL provide extended information about the state of an HTMLView gadget while HtmlViewRun allows scripts (i.e. javascript) to be run (on some platforms).

Labels
Labels are read-only regions of text on a user interface that do not have a background and are created with the CreateLabel command.

Sliders
Sliders allow the user to control a numerical value by dragging a control inside a container. CreateSlider can create both a ScrollBar type slider (where the size of the knob represents the portion of the document being viewed) and TrackBar style sliders (where the knob is a fixed size and SetSliderRange controls the minimum and maximum values allowed by the control).

SetSliderValue and SliderValue set and retrieve the position of a Slider control.

Progress Bars
CreateProgBar creates a progress bar gadget commonly used to display the progress state of an operation. The UpdateProgBar command is used to update the progress bar with a floating point value between 0.0 and 1.0 and are typically used to represent how complete the current operation is.

Desktop
A gadget representing the user's desktop is returned by the Desktop command. The Desktop gadget is particularly useful for finding screen and desktop resolutions using GadgetWidth / GadgetHeight or ClientWidth / ClientHeight respectively.

=Functions=

SetHotKeyEvent
Function SetHotKeyEvent:THotKey( key,mods,event:TEvent=Null,owner=0 )

Description: Set a hotkey event.

Information: When the specified hotkey combination is selected by the user, the specified event will be emitted using EmitEvent.

If event is Null, an event with an id equal to EVENT_HOTKEYHIT, data equal to key and mods equal to mods will be emitted.

SetHotKeyEvent will overwrite any existing hotkey event with the same key, mods and owner.

Please refer to the Key Codes module for valid key and modifier codes.

RemoveHotKey
Function RemoveHotKey(hotkey:THotKey)

Description: Remove a hotkey event.

Information: Clears a hotkey object created with SetHotKeyEvent.

RequestColor
Function RequestColor(r,g,b)

Description: Prompts the user for a color.

Returns: True if a color is selected, False if the requester was cancelled.

Information: The parameters red, green, blue are the initial color to display in the requester, with components in the range 0 to 255.

After a color is selected, use the RequestedRed, RequestedGreen And RequestedBlue functions to determine the color chosen by the user.

Example: ' requestcolor.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local panel:TGadget Local red,green,blue

window=CreateWindow("RequestColor",40,40,320,240) panel=CreatePanel(20,20,32,32,window,PANEL_ACTIVE|PANEL_BORDER)

While True WaitEvent Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_MOUSEDOWN If RequestColor(red,green,blue) red=RequestedRed green=RequestedGreen blue=RequestedBlue SetPanelColor panel,red,green,blue EndIf End Select Wend

RequestedRed
Function RequestedRed

Description: Get the red component of the color previously chosen by the user.

Information: See RequestColor for more information.

RequestedGreen
Function RequestedGreen

Description: Get the green component of the color previously chosen by the user.

Information: See RequestColor for more information.

RequestedBlue
Function RequestedBlue

Description: Get the blue component of the color previously chosen by the user.

Information: See RequestColor for more information.

RequestFont
Function RequestFont:TGuiFont(font:TGuiFont=Null)

Description: Prompts the user to select a system font.

Returns: A TGuiFont object, or Null if no font was selected.

Information: Prompts the user for a font and returns an object that can then be used with the SetGadgetFont command.

See Also: LoadGuiFont, LookupGuiFont, FontName, FontSize and FontStyle

Example: ' requestfont.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local button:TGadget Local label:TGadget Local font:TGuiFont

window=CreateWindow("RequestFont",30,20,200,250) label=CreateLabel("font example",4,4,192,132,window) button=CreateButton("Select Font",4,140,100,20,window)

While WaitEvent Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_GADGETACTION font=RequestFont(font) If font SetGadgetFont label,font SetGadgetText label,FontName(font)+":"+FontSize(font) EndIf End Select Wend

LoadGuiFont
Function LoadGuiFont:TGuiFont(name$,height:Double,bold=False,italic=False,underline=False,strikethrough=False)

Description: Load a system font by name.

Returns: A TGuiFont object, or Null if a suitable matching font was not found on the system.

Information: Loads a system font by name and returns an object that can then be used with the SetGadgetFont command.

Depending on the platform, some gadgets may not respond to all or any of the attributes specified in the function parameters.

See Also: RequestFont, LookupGuiFont, FontName, FontSize and FontStyle

LookupGuiFont
Function LookupGuiFont:TGuiFont( pFontType% = GUIFONT_SYSTEM, pFontSize:Double = 0, pFontStyle% = 0 )

Description: Loads a suitable GUI font that best matches the supplied font characteristics.

Returns: A new TGuiFont instance chosen using the supplied parameters.

Information: If the current MaxGUI driver doesn't return a suitable GUI font, then a hard-coded fall-back font is returned instead, depending upon the platform.

pFontType can take one of the following constants:

pFontSize specifies the point size the font should be loaded with. If this value is less than or equal to 0, then a suitable size is automatically chosen, or a hard-coded alternative is used (usually between 8-13pt).

pFontStyle should specify any additional font styles that the font should be loaded with. A combination of any of the following flags can be used:

Note: FONT_STRIKETHROUGH isn't fully supported by all gadgets/platforms.

See Also: RequestFont, FontName, FontSize and FontStyle

Example: ' lookupguifont.bmx

Strict

Import MaxGUI.Drivers

AppTitle = "LookupGuiFont Example"

Const strSampleText$ = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla eget mauris quis dolor "+.. "ullamcorper dapibus. Duis facilisis ullamcorper metus. Pellentesque eget enim. Vivamus auctor hendrerit turpis. " + .. "Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Vivamus tincidunt leo quis urna."

Const intWindowFlags% = WINDOW_TITLEBAR|WINDOW_RESIZABLE|WINDOW_STATUS|WINDOW_CLIENTCOORDS

Global wndMain:TGadget = CreateWindow( AppTitle, 100, 100, 500, 300, Null, intWindowFlags ) SetMinWindowSize( wndMain, ClientWidth(wndMain), ClientHeight(wndMain) ) Global lstFontTypes:TGadget = CreateListBox(0,0,200,ClientHeight(wndMain),wndMain) SetGadgetLayout lstFontTypes,EDGE_ALIGNED,EDGE_CENTERED,EDGE_ALIGNED,EDGE_ALIGNED AddGadgetItem lstFontTypes, "GUIFONT_SYSTEM", GADGETITEM_DEFAULT, -1, "Default OS font.", LookupGuiFont(GUIFONT_SYSTEM) AddGadgetItem lstFontTypes, "GUIFONT_SERIF", 0, -1, "Serif font.", LookupGuiFont(GUIFONT_SERIF) AddGadgetItem lstFontTypes, "GUIFONT_SANSSERIF", 0, -1, "Sans serif font.", LookupGuiFont(GUIFONT_SANSSERIF) AddGadgetItem lstFontTypes, "GUIFONT_SCRIPT", 0, -1, "Script/handwriting font.", LookupGuiFont(GUIFONT_SCRIPT) AddGadgetItem lstFontTypes, "GUIFONT_MONOSPACED", 0, -1, "Fixed width/coding font.", LookupGuiFont(GUIFONT_MONOSPACED)

Global txtPreview:TGadget = CreateTextArea(200,0,300,ClientHeight(wndMain),wndMain,TEXTAREA_WORDWRAP|TEXTAREA_READONLY) SetGadgetLayout txtPreview,EDGE_ALIGNED,EDGE_ALIGNED,EDGE_ALIGNED,EDGE_ALIGNED SetTextAreaText( txtPreview, strSampleText )

Global strFontString$

ChooseFont( LookupGuiFont )

Repeat Select WaitEvent Case EVENT_APPTERMINATE, EVENT_WINDOWCLOSE;End Case EVENT_GADGETACTION, EVENT_GADGETSELECT Select EventSource Case lstFontTypes If EventData >= 0 Then ChooseFont( TGuiFont(GadgetItemExtra( lstFontTypes, EventData )) ) EndIf EndSelect EndSelect SetStatusText( wndMain, strFontString + "~t~t" + CurrentEvent.ToString + "  " ) Forever

Function ChooseFont( pFont:TGuiFont ) SetGadgetFont( txtPreview, pFont ) strFontString$ = FontName(pFont) + ", " + Int(FontSize(pFont)) + "pt" EndFunction

FontName
Function FontName$(font:TGuiFont)

Description: Retrieves the corresponding property from the TGuiFont type instance.

Returns: A string representing the name of the font.

Information: See Also: LoadGuiFont, LookupGuiFont, RequestFont, FontSize and FontStyle

FontSize
Function FontSize:Double(font:TGuiFont)

Description: Retrieves the corresponding property from the TGuiFont type instance.

Returns: A double representing the size (in points) of the font.

Information: See Also: LoadGuiFont, LookupGuiFont, RequestFont, FontName and FontStyle

FontStyle
Function FontStyle(font:TGuiFont)

Description: Retrieves the corresponding property from the TGuiFont type instance.

Returns: An integer representing the style of the font (e.g. Bold, Underlined, Italics, Strikethrough).

Information: The returned value will be a combination of the following bit flags:

Note: FONT_STRIKETHROUGH isn't fully supported by all gadgets/platforms.

See Also: LoadGuiFont, RequestFont, FontName and FontSize

SetPointer
Function SetPointer(shape)

Description: Changes the applcation's mouse cursor.

Information: The shape of the system mouse pointer can be one of the following:

Note: Some pointers may not be supported on all platforms.

Example: ' setpointer.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local combo:TGadget

window=CreateWindow("SetPointer",40,40,320,240,,WINDOW_TITLEBAR)

CreateLabel "Select a pointer shape:",10,10,200,20,window

combo=CreateComboBox(10,30,200,24,window) AddGadgetItem combo,"POINTER_DEFAULT" AddGadgetItem combo,"POINTER_ARROW" AddGadgetItem combo,"POINTER_IBEAM" AddGadgetItem combo,"POINTER_WAIT" AddGadgetItem combo,"POINTER_CROSS" AddGadgetItem combo,"POINTER_UPARROW" AddGadgetItem combo,"POINTER_SIZENWSE" AddGadgetItem combo,"POINTER_SIZENESW" AddGadgetItem combo,"POINTER_SIZEWE" AddGadgetItem combo,"POINTER_SIZENS" AddGadgetItem combo,"POINTER_SIZEALL" AddGadgetItem combo,"POINTER_NO" AddGadgetItem combo,"POINTER_HAND" AddGadgetItem combo,"POINTER_APPSTARTING" AddGadgetItem combo,"POINTER_HELP"

SelectGadgetItem combo,0

While True WaitEvent Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_GADGETACTION SetPointer EventData End Select Wend

FreeGadget
Function FreeGadget( gadget:TGadget )

Description: Remove a gadget and free its resources.

ClientWidth
Function ClientWidth( gadget:TGadget )

Description: Client area dimensions of a gadget.

Returns: The width of the client area (in pixels) of the specified container gadget.

ClientHeight
Function ClientHeight( gadget:TGadget )

Description: Client area dimensions of a gadget.

Returns: The height of the client area (in pixels) of the specified container gadget.

GadgetX
Function GadgetX( gadget:TGadget )

Description: Horizontal position of gadget.

Returns: The horizontal position (in pixels) of a gadget relative to the top-left corner of the parent's client area.

GadgetY
Function GadgetY( gadget:TGadget )

Description: Vertical position of gadget.

Returns: The vertical position (in pixels) of a gadget relative to the top-left corner of the parent's client area.

GadgetWidth
Function GadgetWidth( gadget:TGadget )

Description: Gadget width.

Returns: The current width (in pixels) of a gadget.

GadgetHeight
Function GadgetHeight( gadget:TGadget )

Description: Gadget height.

Returns: The current height (in pixels) of a gadget.

GadgetGroup
Function GadgetGroup:TGadget( gadget:TGadget )

Description: Return a gadget's group or parent.

Returns: The TGadget instance of the parent or group gadget.

GadgetClass
Function GadgetClass( gadget:TGadget )

Description: Returns an integer representing a gadget's class.

Information: The returned integer will match one of the following constants:

Example: Strict

Import MaxGUI.Drivers

AppTitle = "GadgetClass Example" Global wndMain:TGadget = CreateWindow(AppTitle,100,100,220,200,Null,WINDOW_TITLEBAR|WINDOW_CLIENTCOORDS|WINDOW_STATUS)

Global btnTest:TGadget = CreateButton("Push Button",10,10,200,30,wndMain,BUTTON_PUSH) Global chkTest:TGadget = CreateButton("Check Button",10,40,200,30,wndMain,BUTTON_CHECKBOX) Global cmbTest:TGadget = CreateComboBox(10,70,200,30,wndMain) AddGadgetItem(cmbTest,"Item 1");AddGadgetItem(cmbTest,"Item 2",GADGETITEM_DEFAULT);AddGadgetItem(cmbTest,"Item 3") Global sldTest:TGadget = CreateSlider(10,100,200,30,wndMain,SLIDER_HORIZONTAL|SLIDER_TRACKBAR)

Repeat

WaitEvent SetStatusText wndMain, CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE;End Case EVENT_GADGETACTION, EVENT_GADGETSELECT, EVENT_WINDOWMOVE, EVENT_WINDOWSIZE Select GadgetClass(TGadget(EventSource)) Case GADGET_WINDOW;Print "Window Event" Case GADGET_BUTTON;Print "Button Event" Case GADGET_COMBOBOX;Print "ComboBox Event" Case GADGET_SLIDER;Print "Slider Event" EndSelect EndSelect Forever

ShowGadget
Function ShowGadget( gadget:TGadget )

Description: Make a gadget visible.

Information: See Also: HideGadget and GadgetHidden.

HideGadget
Function HideGadget( gadget:TGadget )

Description: Hide a gadget.

Information: See Also: ShowGadget and GadgetHidden.

EnableGadget
Function EnableGadget( gadget:TGadget )

Description: Enable a gadget, allowing user interaction.

Information: See Also: DisableGadget and GadgetDisabled.

DisableGadget
Function DisableGadget( gadget:TGadget )

Description: Disable a gadget, blocking user interaction.

Information: See Also: EnableGadget and GadgetDisabled.

GadgetHidden
Function GadgetHidden( gadget:TGadget, recursive% = False )

Description: Determines whether a gadget is marked as hidden.

Returns: True if the gadget is set to be hidden, False otherwise.

Information: If the optional recursive parameter is set to True, the function will only return False if the gadget and all of its ancestors are visible, otherwise the function simply returns the property of the individual gadget.

See Also: ShowGadget and HideGadget.

GadgetDisabled
Function GadgetDisabled( gadget:TGadget, recursive% = False )

Description: Determines whether a gadget is marked as enabled.

Returns: True if the gadget is set to be disabled, False otherwise.

Information: If the optional recursive parameter is set to True, the function will only return False if the gadget and all of its ancestors are enabled, otherwise the function simply returns the property of the individual gadget.

See Also: EnableGadget and DisableGadget.

SetGadgetShape
Function SetGadgetShape( gadget:TGadget,x,y,w,h )

Description: Set a gadget's size and position.

Information: The position and size should be given in pixels, and are relative to the upper-left corner of its parent's client-area.

The w and h parameters set the gadget width or height, unless the gadget concerned is a window with the WINDOW_CLIENTCOORDS flag, in which case, they represent the client-area dimensions.

SetGadgetLayout
Function SetGadgetLayout( gadget:TGadget,Left,Right,Top,Bottom )

Description: Set the layout rules for a gadget when its parent is resized.

Information: SetGadgetLayout lets you control the automatic layout of a gadget in the event that its parent is resized.

This will happen either if a window is resized, or if SetGadgetShape is called on a group gadget.

Each edge of a Gadget has an alignment setting that fixes it in place in the following manner:

The default behaviour may vary between platforms, so it is highly recommended that you set this for gadgets on resizable windows.

SetGadgetSensitivity
Function SetGadgetSensitivity( gadget:TGadget, flags )

Description: Sets whether a standard MaxGUI gadget emits events from the keyboard or mouse.

Information: This functions attempts to provide similar functionality for all gadgets to that of Panels created with the PANEL_ACTIVE flag.

The flags parameter can be any combination of the following:

SENSITIZE_MOUSE: The gadget will emit the following events:

SENSITIZE_KEYS: The gadget will emit the following events:

SENSITIZE_ALL: Exactly the same as combining SENSITIZE_MOUSE and SENSITIZE_KEYS.

Gadgets that have been disabled should not emit key events, although they may still emit mouse events.

Not all gadgets will be able to emit all of the events, particularly those that don't receive typical focus such as labels or htmlviews, but even this may differ depending on the platform.

Warning: This is a powerful new function that possibly involves hooking into the system's message queue ''to ask for mouse/key events before they are processed even by the OS's GUI library. As such, using this function'' ''on certain controls may cause them to be behave differently. In addition, care should be taken when using'' this function to avoid infinite loops, for example repositioning gadgets in an event hook that processes the message as it is received. As a result, it is to be recommended that this function is only used by advanced MaxGUI users.

See Also: GadgetSensitivity

GadgetSensitivity
Function GadgetSensitivity( gadget:TGadget )

Description: Returns flags specifying whether a gadget emits events from the keyboard or mouse.

Information: The function will return a combination of the following flags:


 * SENSITIZE_MOUSE: The gadget will emit mouse events.
 * SENSITIZE_KEYS: The gadget will emit keyboard events.

See SetGadgetSensitivity for more information.

SetGadgetExtra
Function SetGadgetExtra( gadget:TGadget, extra:Object )

Description: Stores a pointer to a related object, that can later be retrieved using GadgetExtra.

Information: This function has many uses - you may want to store a custom type instance to the treeview node that represents it, or you may want to store a hidden string value that represents a gadget's action.

However, it is important to note that this function will result in a pointer being stored to that object which will only be released when a new object or Null is passed to this function, or when the gadget is freed using FreeGadget.

GadgetExtra
Function GadgetExtra:Object( gadget:TGadget )

Description: Retrieves the object instance previously stored using SetGadgetExtra.

ActivateGadget
Function ActivateGadget( gadget:TGadget )

Description: Request focus for a gadget.

Information: See Also: ActiveGadget

ActiveGadget
Function ActiveGadget:TGadget

Description: Return the currently active gadget.

Returns: The gadget that currently has the keyboard focus. Returns Null if no MaxGUI gadget has focus.

Information: See Also: ActivateGadget.

GadgetCut
Function GadgetCut( gadget:TGadget )

Description: Perform a cut operation on a gadget.

Information: This is most commonly used on TextAreas to cut text that is currently selected.

GadgetCopy
Function GadgetCopy( gadget:TGadget )

Description: Perform a copy operation on a gadget.

Information: This is most commonly used on TextAreas to copy text that is currently selected.

GadgetPaste
Function GadgetPaste( gadget:TGadget )

Description: Perform a paste operation on a gadget.

Information: This is most commonly used on TextAreas to paste text into the gadget from the clipboard.

GadgetPrint
Function GadgetPrint( gadget:TGadget )

Description: Perform a print operation on a gadget.

Information: This function is currently only supported on TextAreas and HTMLViews.

RedrawGadget
Function RedrawGadget( gadget:TGadget )

Description: Redraws a gadget.

Information: The RedrawGadget command requests that the gadget should be redrawn by the underlying Operating System but is not necessarily guaranteed to happen immediately.

In the case of a Canvas gadget an EVENT_GADGETPAINT event is emitted when the Operating System begins the actual redraw. The following example illustrates how to manage this feature:

Example: ' redrawgadget.bmx

' version 2 - improved TApplet behavior ' moved AddHook from New to Run, as firing OnEvent ' before object has been initialized was problematic

Import MaxGui.Drivers

Strict

Type TApplet

Method OnEvent(Event:TEvent) Abstract

Method Run AddHook EmitEventHook,eventhook,Self End Method

Function eventhook:Object(id,data:Object,context:Object) Local event:TEvent = TEvent(data) Local app:TApplet = TApplet(context) app.OnEvent( event	 ) End Function

End Type

Type TSpinningApplet Extends TApplet Global image:TImage Field timer:TTimer Field window:TGadget, canvas:TGadget Method Draw SetGraphics CanvasGraphics(canvas) SetViewport 0,0,GraphicsWidth,GraphicsHeight SetBlend( ALPHABLEND ) SetRotation( MilliSecs*.1 ) SetClsColor( 255, 0, 0 ) Cls DrawImage( image, GraphicsWidth/2, GraphicsHeight/2 ) Flip End Method Method OnEvent(Event:TEvent) If Not event Then Return Select event.id		Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE End Case EVENT_TIMERTICK RedrawGadget( canvas ) Case EVENT_GADGETPAINT If event.source = canvas Then Draw End Select End Method Method Create:TSpinningApplet(name$) Local	w,h If Not image Then image = LoadImage( "fltkwindow.png" ) window = CreateWindow( name, 20, 20, 512, 512 ) w = ClientWidth(window) h = ClientHeight(window) canvas = CreateCanvas( 0, 0, w, h, window ) SetGadgetLayout( canvas, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED ) timer = CreateTimer( 100 ) Run Return Self End Method End Type

AutoMidHandle True

Local spinner:TSpinningApplet = New TSpinningApplet.Create("Spinning Applet")

Repeat WaitSystem Forever

SetGadgetColor
Function SetGadgetColor( gadget:TGadget,r,g,b,bg=True )

Description: Set a gadget's background color.

Information: By passing False as the value for the bg parameter, the function call has exactly the same effect as calling the dedicated SetGadgetTextColor command.

SetGadgetPixmap
Function SetGadgetPixmap( gadget:TGadget, pixmap:TPixmap, flags% = GADGETPIXMAP_ICON )

Description: Set a gadget's pixmap.

Information: This is a more generic form of old backwards-compatible SetPanelPixmap function which now allows icons to be set for other gadgets as well as just backgrounds for panels.

For setting background pixmaps on panels, flags should still be one of the following:

Alternatively, to set a push-button or menu's icon, use the following constants:

Each platform allows slightly different maximum icon sizes for their menus. Therefore, the recommended size for menu icons is 12x12 pixels, which appears to work well on all supported platforms.

Note: At present, OK buttons cannot have an icon set as a cross-platform solution is unavailable.

The function can be passed Null as the parameter for pixmap, in which case the pixmap will be removed.

SetGadgetAlpha
Function SetGadgetAlpha( gadget:TGadget,alpha# )

Description: Set the transparency of a gadget.

Information: Alpha should be in the range 0.0 (invisible) to 1.0 (solid). Very few gadgets support this functionality, but some Mac OS X gadgets do, in addition to Windows when running Windows XP+. In certain circumstances, window transparency may be disabled (for example, when a canvas is added to a window) to prevent redraw issues on some platforms.

Using the function on windows with Canvases on them may cause undesired effects, particularly on Windows 2000/XP because of conflicts between the software based window manager and the hardware accelerated graphics contexts.

SetGadgetText
Function SetGadgetText( gadget:TGadget,text$ )

Description: Sets a gadget's text.

Information: For the Label, Button, TextField, ComboBox, TextArea and Group Panel gadgets, the contents of the gadget are replaced with the new text$.

For a Window gadget, SetGadgetText changes the title. For Windows with a status bar, SetStatusText should be used to independently set the status bar text.

This command will automatically delocalize the gadget - to set localized gadget text, see LocalizeGadget.

GadgetText
Function GadgetText$( gadget:TGadget )

Description: Returns a gadget's text.

Information: For the Label, Button, TextField, ComboBox, TextArea and Group Panel gadgets, the contents of the gadget are returned with the new gadget's text.

For a Window gadget, GadgetText returns the title of the Window.

SetGadgetToolTip
Function SetGadgetToolTip( gadget:TGadget, tip$ )

Description: Set a gadget's tooltip.

Information: Sets the tooltip for a non-item based positionable MaxGUI gadget. This function will have no effect on the following gadget types:


 * Windows
 * Menus
 * Tree-view nodes
 * List-boxes
 * Toolbars
 * Tabbers
 * Desktops

This command will automatically delocalize the gadget - to set a localized gadget tooltip, see LocalizeGadget.

See Also: GadgetTooltip

GadgetTooltip
Function GadgetTooltip$( gadget:TGadget )

Description: Returns the gadget tooltip previously set with SetGadgetTooltip.

Information: Returns the tooltip for a non-item based positionable MaxGUI gadget. As such, this function will have no effect on the following gadget types:


 * Windows
 * Menus
 * Tree-view nodes
 * List-boxes
 * Toolbars
 * Tabbers
 * Desktops

See Also: SetGadgetTooltip

SetGadgetFont
Function SetGadgetFont( gadget:TGadget,font:TGuiFont )

Description: Set a gadget's font.

Information: See LoadGuiFont and RequestFont for creating a TGuiFont.

SetGadgetTextColor
Function SetGadgetTextColor( gadget:TGadget,r,g,b )

Description: Set a gadget's foreground color.

Information: The red, green and blue components should be in the range 0 to 255.

SetGadgetHotKey
Function SetGadgetHotKey( gadget:TGadget,hotkey,modifier )

Description: Set the hot-key combination for a gadget.

SetGadgetFilter
Function SetGadgetFilter( gadget:TGadget,callback(event:TEvent,context:Object)

Description: Attaches an event filter function to a MaxGUI gadget.

Information: The filter function supplied is called by the gadget with a TEvent and optional user context object. If the function returns zero the event is filtered and not processed further by the system whereas a non zero return indicates event processing should proceed as normal.

The TextArea/TextField events currently supported:

Currently only the EVENT_KEYDOWN, EVENT_KEYCHAR events produced by TextArea and TextField gadgets can be filtered with the SetGadgetFilter command.

Example: ' setgadgetfilter.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Global textarea:TGadget

window=CreateWindow("My Window",30,20,320,240)

textarea=CreateTextArea(0,24,ClientWidth(window),ClientHeight(window)-24,window)

SetGadgetLayout textarea,1,1,1,1 SetGadgetText textarea,"A textarea gadget that filters out down arrows~nand tab keys." ActivateGadget textarea

SetGadgetFilter textarea,filter

Print "KEY_TAB="+KEY_TAB

Function filter(event:TEvent,context:Object) Select event.id		Case EVENT_KEYDOWN Print "filtering keydown:"+event.data+","+event.mods If event.data=KEY_DOWN Return 0 If event.data=13 Return 0 Case EVENT_KEYCHAR Print "filtering charkey:"+event.data+","+event.mods If event.data=KEY_TAB Return 0 End Select Return 1 End Function

While WaitEvent Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

LocalizeGadget
Function LocalizeGadget( gadget:TGadget, localizationtext$, localizationtooltip$ = "" )

Description: Localize a gadget using the supplied localization strings.

Information: The function will use the supplied localization strings to localize a gadget and its text. The gadget will also be marked so that changing the language will update the text. Calling DelocalizeGadget or SetGadgetText will disable this behaviour.

Localization strings and their structure are described in LocalizeString function documentation.

Item-based gadgets should mark any items, whose strings are also wanted to be localized, with the GADGETITEM_LOCALIZED flag. See the flags parameter of the AddGadgetItem / InsertGadgetItem / ModifyGadgetItem calls.

See Also: GadgetLocalized, SetLocalizationMode and SetLocalizationLanguage.

GadgetLocalized
Function GadgetLocalized:Int( gadget:TGadget )

Description: Determines whether a gadget is registered as being 'localized'.

Information: See LocalizeGadget and SetLocalizationMode for more information.

DelocalizeGadget
Function DelocalizeGadget( gadget:TGadget )

Description: Delocalizes a gadget so that it's no longer updated if the localization language/mode changes.

Information: See Also: LocalizeGadget, SetLocalizationLanguage and SetLocalizationMode.

CreateMenu
Function CreateMenu:TGadget( text$,tag,parent:TGadget,hotkey=0,modifier=0 )

Description: Creates a new menu item.

Information: Menu gadgets should be attached to either a WindowMenu, other Menu gadgets or used with the PopupWindowMenu command. The tag field should be a unique identifier that will be present in the EventData field of EVENT_MENUACTION events.

Keyboard shortcuts can be associated with a Menu by using the optional hotKey and modifier parameters.

Please refer to the key codes module for valid key and modifier codes. The MODIFIER_COMMAND value should be used instead of MODIFIER_CONTROL with Menu hotkeys for best crossplatform compatibility.

Menus now also support icons on most platforms through the use of SetGadgetPixmap.

See Also: FreeMenu, SetMenuText, CheckMenu, UncheckMenu, EnableMenu, DisableMenu, MenuText, MenuChecked, MenuEnabled and SetGadgetPixmap.

Example: ' createmenu.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local filemenu:TGadget Local editmenu:TGadget Local helpmenu:TGadget

Const MENU_NEW=101 Const MENU_OPEN=102 Const MENU_SAVE=103 Const MENU_CLOSE=104 Const MENU_EXIT=105

Const MENU_CUT=106 Const MENU_COPY=107 Const MENU_PASTE=108

Const MENU_ABOUT=109

window=CreateWindow("My Window",40,40,320,240)

filemenu=CreateMenu("&File",0,WindowMenu(window)) CreateMenu"&New",MENU_NEW,filemenu,KEY_N,MODIFIER_COMMAND CreateMenu"&Open",MENU_OPEN,filemenu,KEY_O,MODIFIER_COMMAND CreateMenu"&Close",MENU_CLOSE,filemenu,KEY_W,MODIFIER_COMMAND CreateMenu"",0,filemenu CreateMenu"&Save",MENU_SAVE,filemenu,KEY_S,MODIFIER_COMMAND CreateMenu"",0,filemenu CreateMenu"E&xit",MENU_EXIT,filemenu,KEY_F4,MODIFIER_COMMAND

editmenu=CreateMenu("&Edit",0,WindowMenu(window)) CreateMenu "Cu&t",MENU_CUT,editmenu,KEY_X,MODIFIER_COMMAND CreateMenu "&Copy",MENU_COPY,editmenu,KEY_C,MODIFIER_COMMAND CreateMenu "&Paste",MENU_PASTE,editmenu,KEY_V,MODIFIER_COMMAND

helpmenu=CreateMenu("&Help",0,WindowMenu(window)) CreateMenu "&About",MENU_ABOUT,helpmenu

UpdateWindowMenu window

While True WaitEvent Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_MENUACTION Select EventData Case MENU_EXIT End Case MENU_ABOUT Notify "Incrediabler~n(C)2005 Incredible Software" End Select End Select Wend

FreeMenu
Function FreeMenu( menu:TGadget )

Description: Remove a menu.

Information: This function has been superseded by FreeGadget, but is available for backwards compatibility.

SetMenuText
Function SetMenuText( menu:TGadget,text$ )

Description: Modify a menu's text.

Information: This function has been superseded by SetGadgetText, but is available for backwards compatibility.

CheckMenu
Function CheckMenu( menu:TGadget )

Description: Set a menu's checked state.

Information: UpdateWindowMenu should be called where appropriate after changing a menu's state for the changes to become visible.

UncheckMenu
Function UncheckMenu( menu:TGadget )

Description: Clear a menu's checked state.

Information: UpdateWindowMenu should be called where appropriate after changing a menu's state for the changes to become visible.

EnableMenu
Function EnableMenu( menu:TGadget )

Description: Enable a menu for selection.

Information: UpdateWindowMenu should be called where appropriate after changing a menu's status for the changes to become visible.

DisableMenu
Function DisableMenu( menu:TGadget )

Description: Disable a menu so it cannot be selected.

Information: UpdateWindowMenu should be called where appropriate after changing a menu's status for the changes to become visible.

MenuText
Function MenuText$( menu:TGadget )

Description: Return a menu's text.

Information: This function has been superseded by GadgetText, but is available for backwards compatibility.

MenuChecked
Function MenuChecked( menu:TGadget )

Description: Return a menu's checked state.

MenuEnabled
Function MenuEnabled( menu:TGadget )

Description: Return a menu's enabled state.

Desktop
Function Desktop:TGadget

Description: Return a gadget representing the system's desktop.

Information: This is particularly useful for finding the resolution of the desktop using GadgetWidth / ClientWidth or GadgetHeight / ClientHeight.

CreateWindow
Function CreateWindow:TGadget( titletext$,x,y,w,h,group:TGadget=Null,style=WINDOW_DEFAULT )

Description: Create a Window gadget.

Information: A Window is the primary gadget of MaxGUI. Windows should be used as the primary group gadgets in MaxGUI applications to contain the gadgets that make up the program's user interface.

The following style flags are supported when creating a Window. Any of the style flags can be combined using the bitwise operator '|'.

Note: For cross-platform projects, it is highly recommended that the WINDOW_CLIENTCOORDS style is used to maintain similar layouts with different operating systems and window managers.

The default window style (WINDOW_DEFAULT) is equivalent to WINDOW_TITLEBAR | WINDOW_RESIZABLE | WINDOW_MENU | WINDOW_STATUS.

A Window emits the following events:

See Also: WindowMenu, UpdateWindowMenu, PopupWindowMenu, ActivateWindow, SetStatusText, SetMinWindowSize, SetMaxWindowSize, MinimizeWindow, MaximizeWindow, RestoreWindow, WindowMinimized and WindowMaximized.

Example: ' createwindow.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget

window=CreateWindow("My Window",40,40,320,240)

While True WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

WindowMenu
Function WindowMenu:TGadget( window:TGadget )

Description: Returns a window's main-menu handle.

Information: Required when a root menu is to be added to a window using CreateMenu. This function should not be used for sub-menus - the sub-menu should be parented directly to its parent menu.

It should also be mentioned that this function isn't required when creating popup menus - Null should instead be passed as the parent of the root menu. See Also: CreateMenu and UpdateWindowMenu

UpdateWindowMenu
Function UpdateWindowMenu( window:TGadget )

Description: Update a window's menu hierarchy.

Information: Required after changing a window's menu properties/structure for the changes to become visible. See Also: WindowMenu and CreateMenu

PopupWindowMenu
Function PopupWindowMenu( window:TGadget,menu:TGadget,extra:Object=Null )

Description: Display a popup menu.

Information: A popup context-menu is displayed on the screen at the user's current mouse position. See Also: CreateMenu

Example: Strict

Import MaxGui.Drivers

Local menu:TGadget Local window:TGadget Local panel:TGadget

menu=CreateMenu("popup",0,Null) CreateMenu("Load",101,menu) CreateMenu("Save",102,menu)

window=CreateWindow("Test PopupWindowMenu",20,20,200,200)

' create a panel to capture some mouse events

panel=CreatePanel(0,0,ClientWidth(window),ClientHeight(window),window,PANEL_ACTIVE)

While True WaitEvent Select EventID Case EVENT_MOUSEDOWN If EventData=2 PopupWindowMenu window,menu Case EVENT_WINDOWCLOSE End Case EVENT_MENUACTION Print "EVENT_MENUACTION: eventdata="+EventData End Select Wend

ActivateWindow
Function ActivateWindow( window:TGadget )

Description: Activate a window gadget.

Information: This function has been superseded by ActivateGadget, but is available for backwards compatibility.

SetStatusText
Function SetStatusText( window:TGadget,text$ )

Description: Set a window's status bar text.

Information: Can only be used with windows created with the WINDOW_STATUS flag (see CreateWindow). Use tab characters to delimit between the three alignments of text. For example:

SetStatusText( window, "Left Aligned Only" ) SetStatusText( window, "Left Aligned~tCenter Aligned~tRight Aligned" ) SetStatusText( window, "~tCenter Aligned Only" ) SetStatusText( window, "~t~tRight Aligned Only" )

SetMinWindowSize
Function SetMinWindowSize( window:TGadget,w,h )

Description: Set a window's minimum size.

Information: Only useful for resizable windows (i.e. windows created with the WINDOW_RESIZABLE flag, see CreateWindow).

SetMaxWindowSize
Function SetMaxWindowSize( window:TGadget,w,h )

Description: Set a window's maximum size.

Information: Only useful for resizable windows (i.e. windows created with the WINDOW_RESIZABLE flag, see CreateWindow).

Calling this function will disable the Maximize button window hint on Windows, and will limit the window zoom size on Mac OS X.

MinimizeWindow
Function MinimizeWindow( window:TGadget )

Description: Minimize a window.

Information: A minimized window can be restored by the user to its previous state, typically by clicking on the icon representation of the window in the taskbar or dock. The same effect can be obtained programatically by calling RestoreWindow.

See Also: WindowMinimized.

MaximizeWindow
Function MaximizeWindow( window:TGadget )

Description: Maximize a window.

Information: Maximizing a window makes the window visible and sizes it to fill the current desktop. RestoreWindow can be used to programatically restore a window to its previous unmaximized state, although the window will still remain unhidden.

See Also: WindowMaximized.

RestoreWindow
Function RestoreWindow( window:TGadget )

Description: Restore a window from a minimized or maximized state.

Information: See Also: MinimizeWindow and MaximizeWindow.

WindowMinimized
Function WindowMinimized( window:TGadget )

Description: Detect if a window is minimized.

Returns: True if the window is currently minimized, False if not.

WindowMaximized
Function WindowMaximized( window:TGadget )

Description: Detect if a window is maximized.

Returns: True if the window is currently maximized, False if not.

Information: A maximized window fills the entire desktop. A window may be maximized with the MaximizeWindow command or by the user if CreateWindow was called with the WINDOW_RESIZABLE flag.

CreateButton
Function CreateButton:TGadget(label$,x,y,w,h,group:TGadget,style=BUTTON_PUSH)

Description: Create a Button gadget.

Information: A Button generates an EVENT_GADGETACTION TEvent whenever it is pushed.

On certain platforms, the BUTTON_PUSH flag can be combined with either BUTTON_CHECKBOX or BUTTON_RADIO to obtain a button looking similar to standard push-buttons, but mimicking the behaviour of the checkbox or radio button.

See Also: SetGadgetText, SetButtonState, ButtonState and SetGadgetPixmap.

Example: ' createbutton.bmx

Import MaxGui.Drivers

Strict

Global window:TGadget = CreateWindow("MaxGUI Buttons",40,40,400,330,Null,WINDOW_TITLEBAR|WINDOW_CLIENTCOORDS) CreateButton("Std. Button",10,10,120,30,window,BUTTON_PUSH) CreateButton("OK Button",140,10,120,30,window,BUTTON_OK) CreateButton("Cancel Button",270,10,120,30,window,BUTTON_CANCEL)

Global panel:TGadget[4] panel[0]=CreatePanel(10,50,380,60,window,PANEL_GROUP,"Checkbox") FillPanelWithButtons(panel[0], BUTTON_CHECKBOX, "Checkbox") panel[1]=CreatePanel(10,120,380,60,window,PANEL_GROUP,"Checkbox (with Push Button Style)") FillPanelWithButtons(panel[1], BUTTON_CHECKBOX|BUTTON_PUSH, "Toggle") panel[2]=CreatePanel(10,190,380,60,window,PANEL_GROUP,"Radio Buttons") FillPanelWithButtons(panel[2], BUTTON_RADIO, "Option ") panel[3]=CreatePanel(10,260,380,60,window,PANEL_GROUP,"Radio Buttons (with Push Button Style)") FillPanelWithButtons(panel[3], BUTTON_RADIO|BUTTON_PUSH, "Option")

Repeat Select WaitEvent Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE End Case EVENT_GADGETACTION Print "EVENT_GADGETACTION~n" + .. "GadgetText: ~q" + GadgetText(TGadget(EventSource)) + "~q ~t " + .. "ButtonState: "+ ButtonState(TGadget(EventSource)) EndSelect Forever

Function FillPanelWithButtons( pPanel:TGadget, pStyle%, pText$ = "Button" ) Local buttonwidth% = (pPanel.width-10)/3 For Local i% = 0 Until 3 CreateButton( pText + " " + (i+1), 5+(i*buttonwidth), 5, buttonwidth-10, 26, pPanel, pStyle ) Next EndFunction

SetButtonState
Function SetButtonState( button:TGadget,checked )

Description: Set a button's state.

Information: Buttons created with the BUTTON_CHECKBOX and BUTTON_RADIO styles are able to show a selected state. In addition, the BUTTON_CHECKBOX style may also be able to distinguish an indeterminate state from that of a checked state through the use of the CHECK_INDETERMINATE (-1) constant, depending on the platform.

See Also: CreateButton, SetGadgetText, ButtonState and SetGadgetPixmap.

ButtonState
Function ButtonState( button:TGadget )

Description: Retrieve a button's state.

Information: Returns a non-zero value if a checkbox or radio button is selected or false if it isn't. On certain platforms, if a checkbox is set using SetButtonState to have an indeterminant state (CHECK_INDETERMINATE), then this function will return CHECK_INDETERMINATE too. See Also: CreateButton, SetGadgetText, SetButtonState and SetGadgetPixmap.

CreatePanel
Function CreatePanel:TGadget(x,y,w,h,group:TGadget,style=0,title$="")

Description: Create a Panel gadget.

Information: A Panel is a general purpose gadget that can be used to group other gadgets.

Background colours and images can be set using SetGadgetColor and SetPanelPixmap.

A panel can be created with either one of the following optional styles:

The PANEL_ACTIVE flag can be combined with any other style flags, or specified on its own, to generate mouse and key events (equivalent to calling SetGadgetSensitivity immediately after creation):

Note: The PANEL_BORDER and PANEL_GROUP style flags cannot be used together.

See Also: SetPanelColor and SetPanelPixmap.

Example: ' createpanel.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local panel:TGadget Local panel2:TGadget Local group:TGadget

window=CreateWindow("My Window",40,40,320,240)

' create a purple panel that occupies entire window client area

panel=CreatePanel(0,0,ClientWidth(window),ClientHeight(window),window,PANEL_ACTIVE) SetGadgetLayout panel,1,1,1,1 'SetGadgetColor panel,100,0,200

' and a smaller box

panel2=CreatePanel(10,10,100,100,panel,PANEL_ACTIVE|PANEL_BORDER) SetGadgetColor(panel2,160,255,160)

' and a group panel with a child button

group=CreatePanel(120,10,100,100,panel,PANEL_GROUP,"Panel Group") CreateButton("Hello",0,0,ClientWidth(group),26,group)

While True WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

SetPanelColor
Function SetPanelColor( panel:TGadget,r,g,b )

Description: Set the color of a Panel.

Information: This function has been superseded by SetGadgetColor, but is available for backwards compatibility. See Also: CreatePanel and SetPanelPixmap

SetPanelPixmap
Function SetPanelPixmap( panel:TGadget,pixmap:TPixmap,flags=PANELPIXMAP_TILE)

Description: Set panel's background image to a pixmap.

Information: This function has been superseded by SetGadgetPixmap, but is available for backwards compatibility.

The function can be passed 'Null' as the parameter for pixmap, in which case the pixmap should be removed.

See Also: CreatePanel and SetPanelColor

CreateTextField
Function CreateTextField:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a TextField gadget.

Information: A TextField is a single line text entry gadget and currently has only one style flag:

Irrespective of the flag used, the TextField gadget will emit the following event(s):

It is also possible to validate any typed input before it reaches the TextArea using the SetGadgetFilter command.

See Also: GadgetText, SetGadgetText, SetGadgetFilter.

Example: ' createtextfield.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local textfield:TGadget Local button:TGadget

window=CreateWindow("My Window",30,20,320,200)

textfield=CreateTextField(4,4,120,22,window) SetGadgetText( textfield,"A textfield gadget" )

' we need an OK button to catch return key

button=CreateButton("OK",130,4,80,24,window,BUTTON_OK)

ActivateGadget textfield

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_GADGETACTION Select EventSource Case textfield Print "textfield updated" Case button Print "return key / OK button pressed" End Select Case EVENT_WINDOWCLOSE End End Select Wend

TextFieldText
Function TextFieldText$( textfield:TGadget )

Description: Get the current text in a TextField gadget.

Information: This function has been superseded by GadgetText, but is available for backwards compatibility. See Also: CreateTextField and SetGadgetText

CreateTextArea
Function CreateTextArea:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a TextArea gadget.

Information: A TextArea gadget is a multiline text editor with commands that allow control over the contents, style and selection of the text it contains.

A TextArea gadget may have the following optional styles:

A TextArea gadget can generate the following events:

It is also possible to validate any typed input before it reaches the TextArea using the SetGadgetFilter command.

See Also: SetTextAreaText, AddTextAreaText, TextAreaText, TextAreaLen, LockTextArea, UnlockTextArea, SetTextAreaTabs, SetGadgetFont, SetGadgetColor, TextAreaCursor, TextAreaSelLen, FormatTextAreaText, SelectTextAreaText, TextAreaChar, TextAreaLine, TextAreaCharX and TextAreaCharY.

Example: ' createtextarea.bmx

Import MaxGui.Drivers

Strict

Global window:TGadget = CreateWindow( "My Window", 130, 20, 200, 200 )

Global textarea:TGadget = CreateTextArea( 0, 0, ClientWidth(window), ClientHeight(window), window ) SetGadgetLayout( textarea, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED ) SetGadgetText( textarea, "A TextArea gadget. :-)~n~nOne line...~n...and then another!")	ActivateGadget( textarea )

' Select the entire third (index: 2 [base-0]) line. SelectTextAreaText( textarea, 2, 1, TEXTAREA_LINES )

' Output the properties of the current text selection (should be 1, 1 as set above). Print "TextAreaCursor: " + TextAreaCursor( textarea, TEXTAREA_LINES ) Print "TextAreaSelLen: " + TextAreaSelLen( textarea, TEXTAREA_LINES )

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_APPTERMINATE End End Select Wend

SetTextAreaText
Function SetTextAreaText( textarea:TGadget,text$,pos=0,length=TEXTAREA_ALL,units=TEXTAREA_CHARS )

Description: Set the contents of a TextArea gadget.

Information: See Also: CreateTextArea, AddTextAreaText and SetGadgetText

AddTextAreaText
Function AddTextAreaText( textarea:TGadget,text$ )

Description: Append text to the contents of a TextArea gadget.

Information: See Also: CreateTextArea, SetTextAreaText and SetGadgetText

TextAreaText
Function TextAreaText$( textarea:TGadget,pos=0,length=TEXTAREA_ALL,units=TEXTAREA_CHARS )

Description: Get the contents of a TextArea gadget.

Information: See Also: CreateTextArea, AddTextAreaText, SetTextAreaText and SetGadgetText

TextAreaLen
Function TextAreaLen( textarea:TGadget,units=TEXTAREA_CHARS )

Description: Get the number of characters in a TextArea gadget.

Information: See Also: CreateTextArea

LockTextArea
Function LockTextArea( textarea:TGadget )

Description: Lock a TextArea gadget for improved performance when formatting.

Information: See Also: UnlockTextArea and CreateTextArea

UnlockTextArea
Function UnlockTextArea( textarea:TGadget )

Description: Unlock a previously locked TextArea gadget.

Information: See Also: LockTextArea and CreateTextArea

SetTextAreaTabs
Function SetTextAreaTabs( textarea:TGadget,tabs )

Description: Set the tab size of a TextArea gadget.

Information: See Also: CreateTextArea

SetTextAreaFont
Function SetTextAreaFont( textarea:TGadget,font:TGuiFont )

Description: Set the font of a TextArea gadget.

Information: This function has been superseded by SetGadgetFont, but is available for backwards compatibility. See Also: CreateTextArea

SetTextAreaColor
Function SetTextAreaColor( textarea:TGadget,r,g,b,bg=False )

Description: Set the background or foreground colors of a TextArea gadget.

Information: This function has been superseded by SetGadgetColor, but is available for backwards compatibility. See Also: CreateTextArea

TextAreaCursor
Function TextAreaCursor( textarea:TGadget,units=TEXTAREA_CHARS )

Description: Find the position of the cursor in a TextArea gadget.

Information: Use the default TEXTAREA_CHARS units argument to find out which character (column) in the line the cursor is on and use TEXTAREA_LINES to find out which line (row) the cursor is on.

See Also: TextAreaSelLen and CreateTextArea

TextAreaSelLen
Function TextAreaSelLen( textarea:TGadget,units=TEXTAREA_CHARS )

Description: Find the size of the selected text in a TextArea gadget.

Information: The TEXTAREA_CHARS option returns the number of characters currently highlighted by the user where as TEXTAREA_LINES will specify the function returns the number of lines selected.

See Also: TextAreaCursor and CreateTextArea

FormatTextAreaText
Function FormatTextAreaText( textarea:TGadget,r,g,b,flags,pos=0,length=TEXTAREA_ALL,units=TEXTAREA_CHARS )

Description: Format the color and style of some text in a TextArea gadget.

Information: The r, g and b parameters represent the red, green and blue components (0..255) which, when combined, represent the new text color for the sepecified region of characters.

The flags parameter can be a combination of the following values:

Depending on the value of the units parameter the position and length parameters specify the character position and number of characters or the starting line and the number of lines that FormatTextAreaText will modify.

See Also: LockTextArea and CreateTextArea

SelectTextAreaText
Function SelectTextAreaText( textarea:TGadget,pos=0,length=TEXTAREA_ALL,units=TEXTAREA_CHARS )

Description: Select a range of text in a TextArea gadget.

Information: Depending on the value of the units the position and length parameters specify the character position and number of characters or the starting line and the number of lines that SelextTextAreaText will highlight.

See Also: TextAreaCursor, TextAreaSelLen and CreateTextArea

TextAreaChar
Function TextAreaChar( textarea:TGadget,line )

Description: Find the character position of a given line in a TextArea gadget.

TextAreaLine
Function TextAreaLine( textarea:TGadget,index )

Description: Find the line of a given character position in a TextArea gadget.

TextAreaCharX
Function TextAreaCharX( textarea:TGadget, char )

Description: Find the x-coordinate of a textarea character position, relative to the upper left corner of the gadget.

Information: The returned value may be greater than the width of the gadget (or even negative) if the specified character index is positioned outside the immediately visible area of a scrollable TextArea.

TextAreaCharY
Function TextAreaCharY( textarea:TGadget, char )

Description: Find the y-coordinate of a textarea character position, relative to the upper left corner of the gadget.

Information: The returned value may be greater than the height of the gadget (or even negative) if the specified character index is positioned outside the immediately visible area of a scrollable TextArea.

CreateComboBox
Function CreateComboBox:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a ComboBox gadget.

Information: A ComboBox gadget provides a dropdown list of items to the user.

The ComboBox supports the following styles:

And emits the following events:

See Also: AddGadgetItem, ClearGadgetItems, ModifyGadgetItem, SelectGadgetItem, RemoveGadgetItem, SelectedGadgetItem and SetGadgetIconStrip.

Example: ' createcombobox.bmx

Strict

Import MaxGui.Drivers

AppTitle = "ComboBox Style Example"

Global window:TGadget = CreateWindow( AppTitle, 100, 100, 300, 200, Null, WINDOW_TITLEBAR|WINDOW_STATUS ) CreateLabel( "0: ", 5, 5, ClientWidth(window)-10, 24, window, LABEL_LEFT ) Global stdComboBox:TGadget = CreateComboBox( 5, 29, ClientWidth(window)-10, 26, window, 0 ) AddGadgetItem stdComboBox, "Short" AddGadgetItem stdComboBox, "Medium" AddGadgetItem stdComboBox, "Fat", True AddGadgetItem stdComboBox, "Humungous" CreateLabel( "COMBOBOX_EDITABLE: ", 5, 59, ClientWidth(window)-10, 24, window, LABEL_LEFT ) Global editcombobox:TGadget = CreateComboBox( 5, 83, ClientWidth(window)-10, 26, window, COMBOBOX_EDITABLE ) AddGadgetItem editcombobox, "United Kingdom" AddGadgetItem editcombobox, "United States", True

Local tmpText$

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE;End 'Combobox Event(s) 'EventData holds the index of the selected item (or -1 if none are selected) Case EVENT_GADGETACTION Select EventSource Case stdComboBox tmpText = "" If EventData > -1 Then tmpText = GadgetItemText(TGadget(EventSource), EventData) EndIf SetStatusText window, "Weight chosen: " + tmpText Case editComboBox tmpText = "" If EventData > -1 Then tmpText = GadgetItemText(TGadget(EventSource), EventData) Else tmpText = GadgetText(TGadget(EventSource)) + " [user text]" EndIf SetStatusText window, "Country chosen: " + tmpText EndSelect End Select Wend

CreateListBox
Function CreateListBox:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a ListBox gadget.

Information: A ListBox gadget displays a scrollable list of items and generates the following events:

See Also: AddGadgetItem, ClearGadgetItems, ModifyGadgetItem, SelectGadgetItem, RemoveGadgetItem, SelectedGadgetItem, SelectedGadgetItems and SetGadgetIconStrip.

Example: ' createlistbox.bmx

Strict

Import MaxGui.Drivers

AppTitle = "ListBox Example"

Global window:TGadget = CreateWindow( AppTitle, 100, 100, 200, 200, Null, WINDOW_TITLEBAR|WINDOW_STATUS|WINDOW_RESIZABLE ) Global listbox:TGadget = CreateListBox( 0, 0, ClientWidth(window), ClientHeight(window), window ) SetGadgetLayout listbox, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED SetGadgetIconStrip listbox, LoadIconStrip("toolbar.png") AddGadgetItem listbox, "New", False, 0, "Create something." AddGadgetItem listbox, "Open", False, 1, "Open something." AddGadgetItem listbox, "Save", False, 2, "Save something.", "Extra Item Object!" AddGadgetItem listbox, "No Icon", False, -1, "This should not have an icon set."

SelectGadgetItem listbox, 2

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE;End 'ListBox Event(s) 'EventData holds the index of the corresponding listbox item. Case EVENT_GADGETSELECT SetStatusText window, "Selected Item Index: " + EventData Case EVENT_GADGETACTION SetStatusText window, "Double-Clicked Item Index: " + EventData Case EVENT_GADGETMENU SetStatusText window, "Right-Clicked Item Index: " + EventData End Select Wend

CreateTabber
Function CreateTabber:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a Tabber gadget.

Information: A Tabber gadget shows a list of tabs above a client area, typically used for handling multiple documents/panels.

Event extra for both events point to the GadgetItemExtra object set for the corresponding tab item index in the latest call to AddGadgetItem / InsertGadgetItem or ModifyGadgetItem.

It is important to note also that, similar to SelectedGadgetItem, either event may be emitted with the event data set to '-1'. This either means that somehow the user has deselected a tab, or that the user has right-clicked on an area of the tabber which doesn't represent a particular tab item index. As such, your MaxGUI applications should check the value before proceeding to use it with any of the standard GadgetItemText, GadgetItemExtra etc. commands.

See Also: AddGadgetItem, ClearGadgetItems, ModifyGadgetItem, SelectGadgetItem, RemoveGadgetItem, SelectedGadgetItem and SetGadgetIconStrip.

Example: ' createtabber.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local tabber:TGadget Local document:TGadget[3] Local currentdocument:TGadget

' CreateDocument creates a hidden panel that fills entire tabber client area

Function CreateDocument:TGadget(tabber:TGadget) Local	panel:TGadget panel=CreatePanel(0,0,ClientWidth(tabber),ClientHeight(tabber),tabber) SetGadgetLayout panel,1,1,1,1 HideGadget panel Return panel End Function

' create a default window with a tabber gadget that fills entire client area

window=CreateWindow("My Window",30,20,400,300)

tabber=CreateTabber(0,0,ClientWidth(window),ClientHeight(window),window) SetGadgetLayout tabber,1,1,1,1

' add three items and corresponding document panels to the tabber

AddGadgetItem tabber,"Document 0",False,-1,"" AddGadgetItem tabber,"Document 1",False,-1,"Tabber Tip 1" AddGadgetItem tabber,"Document 2",False,-1,"tips 4 2"

document[0]=CreateDocument(tabber) document[1]=CreateDocument(tabber) document[2]=CreateDocument(tabber)

SetPanelColor document[0],255,200,200 SetPanelColor document[1],200,255,200 SetPanelColor document[2],200,200,255

' our documents start off hidden so make first one current and show

currentdocument=document[0] ShowGadget currentdocument

' standard message loop with special tabber EVENT_GADGETACTION and EVENT_GADGETMENU handling

While WaitEvent Select EventID Case EVENT_GADGETACTION If EventSource=tabber HideGadget currentdocument currentdocument=document[EventData] ShowGadget currentdocument EndIf Case EVENT_GADGETMENU If EventSource=tabber Notify "You right clicked the tab with index " + EventData + "!" EndIf Case EVENT_WINDOWCLOSE End End Select Wend

ClearGadgetItems
Function ClearGadgetItems(gadget:TGadget)

Description: Remove all items added to a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

AddGadgetItem
Function AddGadgetItem(gadget:TGadget,text$,flags=0,icon=-1,tip$="",extra:Object=Null)

Description: Add an item to a list based gadget.

Information: An item can be added to the ComboBox, ListBox, Tabber and Toolbar list based gadgets.

Its text parameter is used as its label.

The flags parameter can be a combination of the following values:

The tip$ parameter attaches an optional tooltip to the item.

The optional icon parameter specifies an icon from the gadget's IconStrip (see SetGadgetIconStrip).

The extra parameter is supplied in the EventExtra field of any Event generated by the Item.

See Also: InsertGadgetItem, CreateComboBox, CreateListBox, CreateTabber, CreateToolbar and SetGadgetIconStrip.

InsertGadgetItem
Function InsertGadgetItem(gadget:TGadget,index,text$,flags=0,icon=-1,tip$="",extra:Object=Null)

Description: Inserts an item in a list based gadget at the specified index.

Information: An item can be inserted in a ComboBox, ListBox, Tabber and Toolbar list based gadgets.

See AddGadgetItem for a description of the parameters.

See Also: CreateComboBox, CreateListBox, CreateTabber and CreateToolbar

ModifyGadgetItem
Function ModifyGadgetItem( gadget:TGadget,index,text$,flags=0,icon=-1,tip$="",extra:Object=Null )

Description: Modify the properties of a gadget-item.

Information: See AddGadgetItem for a description of the parameters.

See Also: CreateComboBox, CreateListBox, CreateTabber and CreateToolbar

RemoveGadgetItem
Function RemoveGadgetItem( gadget:TGadget,index )

Description: Remove a gadget-item from a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateTabber and CreateToolbar

EnableGadgetItem
Function EnableGadgetItem( gadget:TGadget,index )

Description: Enable a particular item in a list based gadget.

Information: Typically, this can only be used on toolbars. See Also: CreateToolbar

DisableGadgetItem
Function DisableGadgetItem( gadget:TGadget,index )

Description: Disable a particular item in a list based gadget.

Information: Typically, this can only be used on toolbars. See Also: CreateToolbar

SelectGadgetItem
Function SelectGadgetItem(gadget:TGadget,index)

Description: Select an item in a list based gadget.

Information: See Also: DeselectGadgetItem, ToggleGadgetItem, CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

DeselectGadgetItem
Function DeselectGadgetItem(gadget:TGadget,index)

Description: Deselect an item in a list based gadget.

Information: See Also: SelectGadgetItem, ToggleGadgetItem, CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

ToggleGadgetItem
Function ToggleGadgetItem(gadget:TGadget,index)

Description: Invert the selected state of an item in a list based gadget.

Information: See Also: SelectGadgetItem, DeselectGadgetItem and CreateToolbar

SelectedGadgetItem
Function SelectedGadgetItem(gadget:TGadget)

Description: Get the index of the first selected item in a list based gadget.

Information: SelectedGadgetItem will return -1 if the list based gadget has no selected items.

See Also: CreateComboBox, CreateListBox and CreateTabber

SelectedGadgetItems
Function SelectedGadgetItems[](gadget:TGadget)

Description: Returns an integer array of the selected item indexes in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox and CreateTabber

CountGadgetItems
Function CountGadgetItems( gadget:TGadget )

Description: Get the number of items in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateTabber and CreateToolbar

GadgetItemText
Function GadgetItemText$( gadget:TGadget,index )

Description: Get the text of a given item in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

GadgetItemTooltip
Function GadgetItemTooltip$( gadget:TGadget,index )

Description: Get the tooltip of a given item in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

GadgetItemIcon
Function GadgetItemIcon( gadget:TGadget,index )

Description: Get the icon of a given item in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

GadgetItemExtra
Function GadgetItemExtra:Object( gadget:TGadget,index )

Description: Get the extra data of a given item in a list based gadget.

Information: See Also: CreateComboBox, CreateListBox, CreateToolbar and CreateTabber

GadgetItemFlags
Function GadgetItemFlags( gadget:TGadget,index )

Description: Get the flags parameter of a given item in a list based gadget.

Information: See Also: AddGadgetItem

CreateToolbar
Function CreateToolbar:TGadget(source:Object,x,y,w,h,window:TGadget,style=0)

Description: Creates a window toolbar.

Information: A Toolbar is created from an iconstrip - an image that contains a row of equally shaped icons. Any images in the row left blank are treated as Toolbar separators.

Toolbars are positioned along the top of the window and either the client-area and/or window frame will be resized so that the client area of the window will begin just below the toolbar.

At present, MaxGUI windows only support one toolbar at a time.

A Toolbar generates the following events:

The source parameter can be a previously loaded TIconStrip, a TPixmap or a URL to an image file which CreateToolBar will attempt to load an icon-strip from automatically.

The recommended icon size is 24x24 pixels which seems to work well on most platforms. Using a different icon size may result in the pixmaps being scaled before being set depending on the OS.

The x, y, w, h parameters are all ignored and are simply there to make the CreateToolbar system call consistent with the other CreateGadget calls.

The toolbar can be alterted during runtime using the ClearGadgetItems, InsertGadgetItem, ModifyGadgetItem etc. functions. Use the GADGETICON_SEPARATOR constant as an item's icon if you want it to be a separator, or GADGETICON_BLANK if you would like a blank square icon instead.

''IMPORTANT: Toolbars should only be parented to window gadgets. Parenting a toolbar to a panel is not'' ''officially supported - users are strongly advised to instead use push-buttons with pixmap icons set. Debug builds'' will output a warning message to standard error if toolbars are parented otherwise.

See Also: AddGadgetItem, EnableGadgetItem, DisableGadgetItem and SetToolbarTips.

Example: ' createtoolbar.bmx

Strict

Import MaxGui.Drivers

AppTitle = "ToolBar Example"

Global window:TGadget = CreateWindow( AppTitle, 100, 100, 400, 32, Null, WINDOW_TITLEBAR|WINDOW_STATUS|WINDOW_RESIZABLE|WINDOW_CLIENTCOORDS )

Global toolbar:TGadget = CreateToolBar( "toolbar.png", 0, 0, 0, 0, window ) DisableGadgetItem toolbar, 2 SetToolBarTips toolbar, ["New", "Open", "Save should be disabled."] AddGadgetItem toolbar, "", 0, GADGETICON_SEPARATOR	'Add a separator. AddGadgetItem toolbar, "Toggle", GADGETITEM_TOGGLE, 2, "This toggle button should change to a light bulb when clicked." Global button:TGadget = CreateButton( "Show/Hide Toolbar", 2, 2, 180, 28, window ) SetGadgetLayout button, EDGE_ALIGNED, EDGE_CENTERED, EDGE_ALIGNED, EDGE_CENTERED While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE, EVENT_APPTERMINATE;End 'ToolBar Event(s) 'EventData holds the index of the toolbar item clicked. Case EVENT_GADGETACTION Select EventSource Case button If GadgetHidden(toolbar) Then ShowGadget(toolbar) Else HideGadget(toolbar) Case toolbar SetStatusText window, "Toolbar Item Clicked: " + EventData EndSelect End Select Wend

SetToolbarTips
Function SetToolbarTips( toolbar:TGadget,tips$[] )

Description: Attach a list of tips to a Toolbar gadget.

Information: Simply provides a quick way to set the tooltips of a toolbar's items after them being added. See Also: CreateToolbar

CreateTreeView
Function CreateTreeView:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create a TreeView gadget.

Information: A TreeView provides a view of an expandable list of nodes populated with the AddTreeViewNode command. TreeView nodes can themselves contain nodes providing a flexible method of displaying a hierarchy of information.

Each event will have the containing TreeView gadget as the event source and the concerned node gadget in the EventExtra field of the TEvent.

See Also: AddTreeViewNode, InsertTreeViewNode, ModifyTreeViewNode, TreeViewRoot, SelectedTreeViewNode and CountTreeViewNodes, SelectTreeViewNode, ExpandTreeViewNode, CollapseTreeViewNode and FreeTreeViewNode.

Example: ' createtreeview.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget=CreateWindow("My Window",50,50,240,240,Null,WINDOW_TITLEBAR|WINDOW_CLIENTCOORDS) Local treeview:TGadget=CreateTreeView(5,5,ClientWidth(window)-10,ClientHeight(window)-10,window)

SetGadgetLayout treeview, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED, EDGE_ALIGNED

Local root:TGadget=TreeViewRoot(treeview)

Local help:TGadget=AddTreeViewNode("Help",root) AddTreeViewNode "Topic 1",help AddTreeViewNode "Topic 2",help AddTreeViewNode "Topic 3",help

Local projects:TGadget=AddTreeViewNode("Projects",root) AddTreeViewNode("Sub Project",AddTreeViewNode("Project 1",projects)) AddTreeViewNode("Project 2",projects) AddTreeViewNode("Project 3",projects)

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

AddTreeViewNode
Function AddTreeViewNode:TGadget( text$,node:TGadget,icon=-1 )

Description: Add a node to a TreeView gadget.

Information: See Also: CreateTreeView

InsertTreeViewNode
Function InsertTreeViewNode:TGadget( index,text$,node:TGadget,icon=-1 )

Description: Insert a node at a given index in a TreeView gadget.

Information: See Also: CreateTreeView

ModifyTreeViewNode
Function ModifyTreeViewNode( node:TGadget,text$,icon=-1 )

Description: Modify a node.

Information: See Also: CreateTreeView

ClearTreeView
Function ClearTreeView( treeview:TGadget )

Description: Frees all the nodes of a TreeView.

Information: See Also: CreateTreeView

TreeViewRoot
Function TreeViewRoot:TGadget( treeview:TGadget )

Description: Get the root node of a TreeView gadget.

Information: This is required to parent the first nodes of a blank treeview to.

A treeview's root node can also be used to deselect any currently selected nodes (see SelectTreeViewNode for more information).

See Also: CreateTreeView

SelectedTreeViewNode
Function SelectedTreeViewNode:TGadget( treeview:TGadget )

Description: Get the node currently selected in a TreeView gadget.

Information: Will return Null if there aren't any nodes currently selected.

See Also: CreateTreeView, SelectTreeViewNode

CountTreeViewNodes
Function CountTreeViewNodes( node:TGadget )

Description: Get the number of children of a Node gadget.

Information: See Also: CreateTreeView

SelectTreeViewNode
Function SelectTreeViewNode( node:TGadget )

Description: Selects/highlights a treeview node.

Information: It is possible to deselect a selection by selecting a treeview's root node. For example:

SelectTreeViewNode( TreeViewRoot( myTree ) )

See Also: CreateTreeView, SelectedTreeViewNode

ExpandTreeViewNode
Function ExpandTreeViewNode( node:TGadget )

Description: Expands a treeview node in a TreeView gadget.

Information: See Also: CreateTreeView, CollapseTreeViewNode

CollapseTreeViewNode
Function CollapseTreeViewNode( node:TGadget )

Description: Collapses a treeview node in a TreeView gadget.

Information: See Also: CreateTreeView, ExpandTreeViewNode

FreeTreeViewNode
Function FreeTreeViewNode( node:TGadget )

Description: Removes a treeview node from a TreeView gadget.

Information: This function has been superseded by FreeGadget, but is available for backwards compatibility.

See Also: CreateTreeView

CreateHTMLView
Function CreateHTMLView:TGadget(x,y,w,h,group:TGadget,style=0)

Description: Create an HTMLView gadget.

Information: The HTMLView is a complete web browser object inside a MaxGUI gadget. The HTML page displayed is controlled with the HTMLViewGo command or from the user navigating from within the currently viewed page.

CreateHTMLView supports the following styles:

Note: EVENT_GADGETACTION requires the HTMLVIEW_NONAVIGATE style flag.

See Also: HtmlViewGo, HtmlViewBack, HtmlViewForward, HtmlViewStatus and HtmlViewCurrentURL.

Example: ' createhtmlview.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget Local htmlview:TGadget

window=CreateWindow("My Window",30,20,600,440,,15|WINDOW_ACCEPTFILES)

htmlview=CreateHTMLView(0,0,ClientWidth(window),ClientHeight(window),window) SetGadgetLayout htmlview,1,1,1,1

HtmlViewGo htmlview,"www.blitzmax.com"

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

HtmlViewGo
Function HtmlViewGo( view:TGadget,url$ )

Description: Direct the HTMLView gadget to a new URL.

Information: See Also: CreateHTMLView

HtmlViewBack
Function HtmlViewBack( view:TGadget )

Description: Go back a page in an HTMLView gadget.

Information: See Also: CreateHTMLView

HtmlViewForward
Function HtmlViewForward( view:TGadget )

Description: Go forward a page in an HTMLView gadget.

Information: See Also: CreateHTMLView

HtmlViewStatus
Function HtmlViewStatus( view:TGadget )

Description: Get the status of an HTMLView gadget.

Information: See Also: CreateHTMLView

HtmlViewCurrentURL
Function HtmlViewCurrentURL$( view:TGadget )

Description: Get the current URL of an HTMLView gadget.

Information: See Also: CreateHTMLView

HtmlViewRun
Function HtmlViewRun$( view:TGadget,script$ )

Description: Run a script in an HTMLView gadget.

Information: See Also: CreateHTMLView

CreateLabel
Function CreateLabel:TGadget( name$,x,y,w,h,group:TGadget,style=LABEL_LEFT )

Description: Create a Label gadget.

Information: A Label gadget is used to place static text or frames in a MaxGUI user interface. They do not generate any events.

Labels support these optional styles:

See Also: SetGadgetText, SetGadgetTextColor, SetGadgetFont and SetGadgetColor.

Example: ' createlabel.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget

window=CreateWindow("My Window",30,20,320,480)

CreateLabel("A plain label",10,10,280,52,window) CreateLabel("A label with LABEL_FRAME",10,80,280,60,window,LABEL_FRAME) CreateLabel("A label with LABEL_SUNKENFRAME",10,150,280,60,window,LABEL_SUNKENFRAME) CreateLabel("not applicable",10,220,280,54,window,LABEL_SEPARATOR)

While WaitEvent<>EVENT_WINDOWCLOSE Wend

CreateSlider
Function CreateSlider:TGadget( x,y,w,h,group:TGadget,style=0 )

Description: Create a Slider gadget.

Information: A Slider gadget supports the following styles:

A slider only emits one type of event:

See Also: SetSliderRange, SetSliderValue and SliderValue

Example: ' createslider.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget=CreateWindow("My Window",0,0,240,240,,WINDOW_TITLEBAR)

Local slider:TGadget[3]

' standard vertical and horizontal scroll bars

slider[0]=CreateSlider(10,10,16,100,window,SLIDER_VERTICAL) slider[1]=CreateSlider(30,10,100,16,window,SLIDER_HORIZONTAL)

' a horizontal trackbar

slider[2]=CreateSlider(30,30,100,24,window,SLIDER_HORIZONTAL|SLIDER_TRACKBAR)

' a row of vertical trackbars

Local trackbar:TGadget[5]

For Local i=0 To 4 trackbar[i]=CreateSlider(30+i*20,50,16,60,window,SLIDER_VERTICAL|SLIDER_TRACKBAR) Next

' a single stepper

Local stepper:TGadget stepper=CreateSlider(10,120,24,24,window,SLIDER_STEPPER)

SetSliderValue stepper,4 Print SliderValue(stepper)

While WaitEvent Print CurrentEvent.ToString Select EventID Case EVENT_WINDOWCLOSE End End Select Wend

SetSliderRange
Function SetSliderRange( slider:TGadget,range0,range1 )

Description: Set the range of a Slider gadget.

Information: For the default SLIDER_SCROLLBAR style the range0,range1 parameters are treated as a visible / total ratio which dictates both the size of the knob and it's maximum value. The default value is 1,10 which displays a Slider with a knob that occupies 1/10th the area and with a SliderValue range of 0..9.

For the SLIDER_TRACKBAR and SLIDER_STEPPER styles the range0,range1 parameters are treated as the minimum and maximum SliderValue range inclusive.

See Also: CreateSlider, SliderValue and SetSliderValue

SetSliderValue
Function SetSliderValue( slider:TGadget,value )

Description: Set the position of a Slider gadget.

Information: See Also: CreateSlider, SetSliderRange and SliderValue

SliderValue
Function SliderValue( slider:TGadget )

Description: Get the position of a Slider gadget.

Information: See Also: CreateSlider, SetSliderRange and SetSliderValue

CreateProgBar
Function CreateProgBar:TGadget( x,y,w,h,group:TGadget,style=0 )

Description: Create a Progress Bar gadget.

Information: Similar to Labels, Progress Bar gadgets do not generate any events themselves. See Also: UpdateProgBar

Example: ' createprogbar.bmx

Import MaxGui.Drivers

Strict

Local window:TGadget=CreateWindow("My Window",50,50,240,100,,WINDOW_TITLEBAR)

Local progbar:TGadget=CreateProgBar(10,10,200,20,window)

CreateLabel "Please Wait",10,40,200,20,window

CreateTimer 10

While WaitEvent Select EventID Case EVENT_WINDOWCLOSE End Case EVENT_TIMERTICK Local t=EventData If t=50 End UpdateProgBar progbar,t/50.0 End Select Wend

UpdateProgBar
Function UpdateProgBar( progbar:TGadget,value# )

Description: Update the display of a ProgressBar gadget.

Information: See Also: CreateProgBar

LoadIconStrip
Function LoadIconStrip:TIconStrip( source:Object )

Description: Creates an icon strip from an image file.

Information: An icon strip is a series of small images that can be attached to item-based gadgets.

Icons must be square, and arranged in a single horizontal strip across the source image.

The number of icons in an iconstrip is determined by dividing the image width by its height. For example, an iconstrip 64 wide by 8 high is assumed to contain 64/8=8 icons.

Once an icon strip has been loaded, it can be attached to item-based gadgets using SetGadgetIconStrip.

See Also: SetGadgetIconStrip and PixmapFromIconStrip

SetGadgetIconStrip
Function SetGadgetIconStrip( gadget:TGadget,iconstrip:TIconStrip )

Description: Attaches an icon strip to an item-based gadget.

Information: Once attached, icons can be specified when items are added or modified with the AddGadgetItem, InsertGadgetItem and ModifyGadgetItem commands.

This command may only be used with the ComboBox, ListBox, Tabber and TreeNode gadgets.

Note: It is highly recommended that icon-strips are set before any items are added to a gadget.

See Also: LoadIconStrip

PixmapFromIconStrip
Function PixmapFromIconStrip:TPixmap( iconstrip:TIconStrip, index = -1 )

Description: Returns a pixmap containing either a copy of the original icon-strip or just the specified icon.

Information: iconstrip: The icon-strip to return a pixmap from.

index: The index (base 0) of the icon to extract. If this is negative, a copy of the original pixmap used to create the iconstrip is returned.

This function will return Null if no iconstrip is passed, or if the icon index is invalid.

See Also: LoadIconStrip

CreateCanvas
Function CreateCanvas:TGadget( x,y,w,h,group:TGadget,style=0 )

Description: Create a Canvas gadget.

Information: A Canvas provides a Graphics interface for realtime drawing purposes.

Once a Canvas is created, the CanvasGraphics Function can be used with the SetGraphics command to direct Max2D drawing commands to be drawn directly on the Canvas.

An EVENT_GADGETPAINT event is generated whenever the gadget must be redrawn by either the system (for instance when it is first shown) or due to the RedrawGadget command.

An EVENT_GADGETPAINT handler should always call SetGraphics with the canvas's Max2D graphics context to ensure the viewport and similar properties are in their correct state.

When a Canvas is active using either the ActivateGadget command or clicking on the Canvas when the application is running, the following events will also be sent from the Canvas:

See Also: ActivateGadget, RedrawGadget, CanvasGraphics

Example: ' createcanvas.bmx

Import MaxGui.Drivers

Strict

Global GAME_WIDTH=320 Global GAME_HEIGHT=240

' create a centered window with client size GAME_WIDTH,GAME_HEIGHT

Local wx=(ClientWidth(Desktop)-GAME_WIDTH)/2 Local wy=(ClientHeight(Desktop)-GAME_HEIGHT)/2

Local window:TGadget=CreateWindow("My Canvas",wx,wy,GAME_WIDTH,GAME_HEIGHT,Null,WINDOW_TITLEBAR|WINDOW_CLIENTCOORDS)

' create a canvas for our game

Local canvas:TGadget=CreateCanvas(0,0,240,240,window)

' create an update timer

CreateTimer 60

While WaitEvent Select EventID Case EVENT_TIMERTICK RedrawGadget canvas

Case EVENT_GADGETPAINT SetGraphics CanvasGraphics(canvas) SetOrigin 160,120 SetLineWidth 5 Cls Local t=MilliSecs DrawLine 0,0,120*Cos(t),120*Sin(t) DrawLine 0,0,80*Cos(t/60),80*Sin(t/60) Flip

Case EVENT_MOUSEMOVE Print "MOVE!"

Case EVENT_WINDOWCLOSE FreeGadget canvas End

Case EVENT_APPTERMINATE End End Select Wend

CanvasGraphics
Function CanvasGraphics:TGraphics( gadget:TGadget )

Description: Retrieve a Canvas gadget's Graphics context.

Information: The RedrawGadget example shows an alternative method for drawing to Canvas gadgets utilizing the EVENT_GADGETPAINT event.

See Also: CreateCanvas

QueryGadget
Function QueryGadget( gadget:TGadget,queryid )

Description: Return internal gadget handle.

Information: QueryGadget retrieves system handles for use with API specific functions.