SourceForge.net Controls

Controls

Table of Contents
Controls
Common widgets available in wxEuphoria
Functions/Procedures
Subtopics

Controls

Table of Contents

[proc]
add_item ( atom combo, sequence text )

Category: Controls

Used to add one or more strings into a wxListBox, wxComboBox, or wxChoice. text can be either a string, or a sequence of strings, in which case all of the items will be added.

This is also used to enter one or more string, bitmap sequences into a wxBitmapComboBox.

Controls

Table of Contents

[proc]
clear_items ( atom control )

Category: Controls

Clears all items from a wxListBox, wxListCtrl, wxChoice or wxComboBox.

Controls

Table of Contents

[func]
client_to_screen ( atom window, atom x, atom y )

Category: Controls

Converts from client to screen window coordinates.

Controls

Table of Contents

[proc]
delete_item ( atom control, integer item )

Category: Controls

Delete an item from a wxListBox, wxListCtrl, wxComboBox or wxChoice.

Controls

Table of Contents

[proc]
destroy ( atom this )

Category: Controls

You should use this instead of delete_instance to destroy any object that handles events (generally, any control or window).

Controls

Table of Contents

[proc]
enable ( object control, integer bool )

Category: Controls

If bool is equal to 0, then the specified control will be frozen and changes will not be allowed to be made to it or any controls made upon it. If bool is equal to 1 then it reverses the effect. You can also use a sequence to enable or disable multiple windows at once with control.

Controls

Table of Contents

[proc]
enable_tooltips ( integer enable )

Category: Controls

Enables or disables tooltips globally.

This procedure does not work under GTK2.12 or later.

Controls

Table of Contents

[func]
find_string ( atom control, sequence string )

Category: Controls

ret Index of specified item string

Returns the item number of the item in the list with the specified string.

Controls

Table of Contents

[func]
get_children ( atom window )

Category: Controls

Returns a sequence of the window's children.

Controls

Table of Contents

[func]
get_desktop_window ()

Category: Controls

Returns the desktop's window handle.

Controls

Table of Contents

[func]
get_handle ( atom this )

Category: Controls

ret Object handle of the window

Returns the platform specific handle for objects derived from class wxWindow.

Controls

Table of Contents

[func]
get_label ( atom control )

Category: Controls

ret Text label of the control

Returns the default label associated with the control. This would be the caption for a wxFrame or the label on a wxButton or the text of a wxStaticText. To get the text in a wxTextCtrl, you should use get_text_value.

Controls

Table of Contents

[func]
get_list_string ( atom list, integer item )

Category: Controls

ret Text label of the list item

This function works for both wxListCtrl and wxListBox.

Controls

Table of Contents

[func]
get_parent ( atom window )

Category: Controls

Returns the parent of the window, or NULL if there is no parent.

Controls

Table of Contents

[func]
get_rect ( atom win )

Category: Controls

ret {x, y, width, height}

Returns the size and position of the control.

Controls

Table of Contents

[func]
get_selection ( atom control )

Category: Controls

ret Selected index(es) of the control

Used to get the index of the selected item of a wxListBox, wxListCtrl, wxComboBox wxChoice, or wxMultiChoiceDialog. For the case of a wxListBox or wxMultiChoiceDialog. The return is always a sequence, or an empty sequence, if nothing is selected. The other types of controls return -1 is no item is selected.

Controls

Table of Contents

[func]
get_string_selection ( atom list )

Category: Controls

ret Text of selected item

Used to get the text of the selected item of a wxListBox, wxComboBox or wxChoice.

Controls

Table of Contents

[func]
hit_test ( atom window, atom x, atom y, atom flags )

Category: Controls

Hit-tests a wxListCtrl, wxTreeCtrl, or wxTextCtrl.

Note: flags is unused for wxTextCtrl.

See also:

Controls

Table of Contents

[proc]
insert_item ( atom list, integer position, sequence text )

Category: Controls

Inserts the item into the list before position. Not valid for wxLB_SORT or wxCB_SORT styles, use add_item instead.

Controls

Table of Contents

[func]
is_visible ( atom window )

Category: Controls

ret Visible state of the window

Returns a 1 if the window is visible, or a zero if it is not. You can use show_window to toggle a window's visibility.

Controls

Table of Contents

[proc]
move ( atom win, integer x, integer y )

Category: Controls

Moves the window to the given position.

Controls

Table of Contents

[func]
screen_to_client ( atom window, atom x, atom y )

Category: Controls

Converts from screen to client window coordinates.

Controls

Table of Contents

[proc]
set_cursor ( atom window, atom cursor )

Category: Controls

Changes the mouse cursor for the specified window to be the specified cursor.

See wxCursor for the available cursor shapes.

Controls

Table of Contents

[proc]
set_focus ( atom window )

Category: Controls

Sets the cursor to the specified window as if it had clicked on it. If it is a text control, the blinking cursor will appear at the beginning of the control where text can be entered. If it is a control, then the top selection will be highlighted. If it is a wxTreeCtrl, then the root will be highlighted.

Controls

Table of Contents

[proc]
set_selection ( atom control, object item )

Category: Controls

To unselect a wxListBox item, the item parameter should be a sequence: {item_number, -1}. To unselect a wxListCtrl item, item should be {item_number, 0}. To select items for a wxMultiChoiceDialog, item should be either an index number starting from zero, or a sequence of indexes.

Controls

Table of Contents

[proc]
set_size ( atom win, integer cx, integer cy )

Category: Controls

This sets the size of the control to the designated values. cx is the size from left to right and cy is the size from top to bottom.

Controls

Table of Contents

[proc]
set_string ( atom control, integer item, sequence string )

Category: Controls

Set the string of an item in a wxListBox, wxComboBox or wxChoice.

Controls

Table of Contents

[proc]
set_tip ( atom this, sequence tip )

Category: Controls

Sets the tooltip for an object derived from class wxWindow. To create multi-line tooltips, use \n under Linux/BSD, and \r\n under Windows.

Controls

Table of Contents

[proc]
set_tooltip_delay ( integer msec )

Category: Controls

Set the delay (in milliseconds) after with tooltips display.

This procedure does not work under GTK2.12 or later.