Table of Contents

Controls

A List of controls available in wxWidgets


  • proc add_item( atom combo, sequence text )   
  • proc clear_items( atom control )   
  • proc delete_item( atom control, integer item )   
  • proc destroy( atom this )   
  • proc enable( object control, integer bool )   
  • func find_string( atom control, sequence string )   
  • func get_handle( atom this )   
  • func get_label( atom control )   
  • func get_list_string( atom list, integer item )   
  • func get_rect( atom win )   
  • func get_selection( atom control )   
  • func get_string_selection( atom list )   
  • func get_string_selection( atom list )   
  • func is_visible( atom window )   
  • proc set_cursor( atom window, atom cursor )   
  • proc set_focus( atom window )   
  • proc set_selection( atom control, object item )   
  • proc set_size( atom win, integer cx, integer cy )   
  • proc set_string( atom control, integer item, sequence string )   
  • proc set_tip( atom this, sequence tip )     
     
    Subtopics:
  • IDs
  • wxBitmapButton
  • wxButton
  • wxCalendarCtrl
  • wxCheckBox
  • wxChoice
  • wxColourDialog
  • wxComboBox
  • wxControl
  • wxControlWithItems
  • wxCursor
  • wxDefButton
  • wxFrame
  • wxGrid
  • wxHtmlWindow
  • wxListBox
  • wxListCtrl
  • wxMDIChildFrame
  • wxMDIClientWindow
  • wxMDIParentFrame
  • wxNotebook
  • wxPanel
  • wxRadioBox
  • wxRadioButton
  • wxSlider
  • wxSpinCtrl
  • wxSplashScreen
  • wxSplitterWindow
  • wxStaticText
  • wxStatusBar
  • wxTextCtrl
  • wxToggleButton
  • wxToolBar
  • wxTreeCtrl
  • wxWindow
  • wxWizard
  • wxWizardPage


    Table of Contents

    [proc]
    add_item
    ( atom combo, sequence text )

    Category: Controls

    Used to add an item into a wxListBox, wxComboBox or wxChoice.

    See Also: clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [proc]
    clear_items
    ( atom control )

    Category: Controls

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

    See Also: add_item, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [proc]
    delete_item
    ( atom control, integer item )

    Category: Controls

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

    See Also: add_item, clear_items, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    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).

    See Also: add_item, clear_items, delete_item, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [proc]
    enable
    ( object control, integer bool )

    Category: Controls

    See Also: add_item, clear_items, delete_item, destroy, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    find_string
    ( atom control, sequence string )

    Category: Controls

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

    See Also: add_item, clear_items, delete_item, destroy, enable, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_handle
    ( atom this )

    Category: Controls

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

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_label
    ( atom control )

    Category: Controls

    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.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_list_string
    ( atom list, integer item )

    Category: Controls

    This function works for both wxListCtrl and wxListBox.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_rect
    ( atom win )

    Category: Controls

    Returns the size and position of the control.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_selection
    ( atom control )

    Category: Controls

    Used to get the index of the selected item of a wxListBox, wxListCtrl, wxComboBox or wxChoice. For the case of a wxListBox, 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.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_string_selection
    ( atom list )

    Returns: Text of selected item

    Category: Controls

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

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    get_string_selection
    ( atom list )

    Returns: Text of selected item

    Category: Controls

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

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [func]
    is_visible
    ( atom window )

    Category: Controls

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, set_cursor, set_focus, set_selection, set_size, set_string, set_tip



    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.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_focus, set_selection, set_size, set_string, set_tip



    Table of Contents

    [proc]
    set_focus
    ( atom window )

    Category: Controls

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_selection, set_size, set_string, set_tip



    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}.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_size, set_string, set_tip



    Table of Contents

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

    Category: Controls

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_string, set_tip



    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.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_tip



    Table of Contents

    [proc]
    set_tip
    ( atom this, sequence tip )

    Category: Controls

    Sets the tooltip for an object derived from class wxWindow.

    See Also: add_item, clear_items, delete_item, destroy, enable, find_string, get_handle, get_label, get_list_string, get_rect, get_selection, get_string_selection, get_string_selection, is_visible, set_cursor, set_focus, set_selection, set_size, set_string