Class: Wx::ComboBox

Inherits:
ControlWithItems show all
Includes:
TextEntry
Defined in:
lib/wx/doc/gen/combo_box.rb

Overview

A combobox is like a combination of an edit control and a listbox.

It can be displayed as static list with editable or read-only text field; or a drop-down list with text field; or a drop-down list without a text field depending on the platform and presence of CB_READONLY style. A combobox permits a single selection only. Combobox items are numbered from zero. If you need a customized combobox, have a look at ComboCtrl, OwnerDrawnComboBox, ComboPopup and the ready-to-use BitmapComboBox. Please refer to TextEntry documentation for the description of methods operating with the text entry part of the combobox and to ItemContainer for the methods operating with the list of strings. Notice that at least under MSW ComboBox doesn’t behave correctly if it contains strings differing in case only so portable programs should avoid adding such strings to this control.

Styles

This class supports the following styles:

  • CB_SIMPLE: Creates a combobox with a permanently displayed list. Windows only.

  • CB_DROPDOWN: Creates a combobox with a drop-down list. MSW and Motif only.

  • CB_READONLY: A combobox with this style behaves like a Choice (and may look in the same way as well, although this is platform-dependent), i.e. it allows the user to choose from the list of options but doesn't allow to enter a value not present in the list.

  • CB_SORT: Sorts the entries in the list alphabetically.

  • TE_PROCESS_ENTER: The control will generate the event EVT_TEXT_ENTER that can be handled by the program. Otherwise, i.e. either if this style not specified at all, or it is used, but there is no event handler for this event or the event handler called Event#skip to avoid overriding the default handling, pressing Enter key is either processed internally by the control or used to activate the default button of the dialog, if any.

Events emitted by this class

The following event-handler methods redirect the events to member method or handler blocks for CommandEvent events. Event handler methods for events emitted by this class:

Category: Controls <div class=‘appearance’><span class=‘appearance’>Appearance:</span><table><tr><td> WXMSW Appearance </td><td> WXGTK Appearance </td><td> WXOSX Appearance </td></tr></table></div>

See Also:

Requires:

  • USE_COMBOBOX

Direct Known Subclasses

BitmapComboBox

Instance Method Summary collapse

Methods included from TextEntry

#append_text, #auto_complete, #auto_complete_directories, #auto_complete_file_names, #can_copy, #can_cut, #can_paste, #can_redo, #can_undo, #change_value, #clear, #copy, #cut, #force_upper, #get_hint, #get_last_position, #get_margins, #get_range, #get_value, #is_editable, #is_empty, #paste, #redo_, #remove, #replace, #select_all, #select_none, #set_editable, #set_hint, #set_insertion_point, #set_insertion_point_end, #set_margins, #set_max_length, #undo, #write_text

Methods inherited from ControlWithItems

#append, #clear, #delete, #detach_client_object, #each_string, #get_client_data, #get_client_object, #get_list_selection, #get_list_string_selection, #get_strings, #has_client_data, #has_client_object_data, #insert, #is_empty, #is_sorted, #select, #set, #set_client_data, #set_client_object, #set_list_selection, #set_list_string_selection, #set_string_selection

Methods inherited from Control

#command, ellipsize, escape_mnemonics, #get_label, #get_label_text, #get_size_from_text, #get_size_from_text_size, remove_mnemonics, #set_label, #set_label_markup, #set_label_text

Methods inherited from Window

#accepts_focus, #accepts_focus_from_keyboard, #accepts_focus_recursively, #add_child, #adjust_for_layout_direction, #always_show_scrollbars, #begin_repositioning_children, #cache_best_size, #can_accept_focus, #can_accept_focus_from_keyboard, #can_scroll, #can_set_transparent, #capture_mouse, #center, #center_on_parent, #centre, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_style_flag, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #hit_test, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_frozen, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #line_down, #line_up, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_font, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_style_flag, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::ComboBox #initialize(parent, id, value = (''), pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Wx::ComboBox #initialize(parent, id, value, pos, size, choices, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Wx::ComboBox

Returns a new instance of ComboBox.

Overloads:

  • #initialize ⇒ Wx::ComboBox

    Default constructor.

  • #initialize(parent, id, value = (''), pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Wx::ComboBox

    Constructor, creating and showing a combobox.

    Parameters:

    • parent (Wx::Window) —

      Parent window. Must not be NULL.

    • id (Integer) —

      Window identifier. The value StandardID::ID_ANY indicates a default value.

    • value (String) (defaults to: ('')) —

      Initial selection string. An empty string indicates no selection. Notice that for the controls with Wx::CB_READONLY style this string must be one of the valid choices if it is not empty.

    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION) —

      Window position. If DEFAULT_POSITION is specified then a default position is chosen.

    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE) —

      Window size. If DEFAULT_SIZE is specified then the window is sized appropriately.

    • choices (Array<String>) (defaults to: nil) —

      An array of strings with which to initialise the control.

    • style (Integer) (defaults to: 0) —

      Window style. See Wx::ComboBox.

    • validator (Wx::Validator) (defaults to: Wx::DEFAULT_VALIDATOR) —

      Window validator.

    • name (String) (defaults to: Wx::COMBO_BOX_NAME_STR) —

      Window name.

    See Also:

  • #initialize(parent, id, value, pos, size, choices, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Wx::ComboBox

    Constructor, creating and showing a combobox.

    Parameters:

    • parent (Wx::Window) —

      Parent window. Must not be NULL.

    • id (Integer) —

      Window identifier. The value StandardID::ID_ANY indicates a default value.

    • value (String) —

      Initial selection string. An empty string indicates no selection.

    • pos (Array(Integer, Integer), Wx::Point) —

      Window position.

    • size (Array(Integer, Integer), Wx::Size) —

      Window size. If DEFAULT_SIZE is specified then the window is sized appropriately.

    • choices (Array<String>) —

      An array of strings with which to initialise the control.

    • style (Integer) (defaults to: 0) —

      Window style. See Wx::ComboBox.

    • validator (Wx::Validator) (defaults to: Wx::DEFAULT_VALIDATOR) —

      Window validator.

    • name (String) (defaults to: Wx::COMBO_BOX_NAME_STR) —

      Window name.

    See Also:



124
 
# File 'lib/wx/doc/gen/combo_box.rb', line 124

def initialize(*args) end

Instance Method Details

#create(parent, id, value = (''), pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = ((CONST Wx::STRING *) nil), style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Boolean #create(parent, id, value, pos, size, choices, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Boolean

Overloads:

  • #create(parent, id, value = (''), pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = ((CONST Wx::STRING *) nil), style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Boolean

    Creates the combobox for two-step construction.

    Derived classes should call or replace this function. See combo_box for further details.

    Parameters:

    • parent (Wx::Window)
    • id (Integer)
    • value (String) (defaults to: (''))
    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • choices (Array<String>) (defaults to: ((CONST Wx::STRING *) nil))
    • style (Integer) (defaults to: 0)
    • validator (Wx::Validator) (defaults to: Wx::DEFAULT_VALIDATOR)
    • name (String) (defaults to: Wx::COMBO_BOX_NAME_STR)

    Returns:

    • (Boolean)
  • #create(parent, id, value, pos, size, choices, style = 0, validator = Wx::DEFAULT_VALIDATOR, name = Wx::COMBO_BOX_NAME_STR) ⇒ Boolean

    Creates the combobox for two-step construction.

    Derived classes should call or replace this function. See combo_box for further details.

    Parameters:

    • parent (Wx::Window)
    • id (Integer)
    • value (String)
    • pos (Array(Integer, Integer), Wx::Point)
    • size (Array(Integer, Integer), Wx::Size)
    • choices (Array<String>)
    • style (Integer) (defaults to: 0)
    • validator (Wx::Validator) (defaults to: Wx::DEFAULT_VALIDATOR)
    • name (String) (defaults to: Wx::COMBO_BOX_NAME_STR)

    Returns:

    • (Boolean) 


87
 
# File 'lib/wx/doc/gen/combo_box.rb', line 87

def create(*args) end

#dismiss ⇒ void

This method returns an undefined value.

Hides the list box portion of the combo box.

Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa. Notice that calling this function will generate a EVT_COMBOBOX_CLOSEUP event except under WXOSX where generation of this event is not supported at all.



195
 
# File 'lib/wx/doc/gen/combo_box.rb', line 195

def dismiss; end

#find_string(string, caseSensitive = false) ⇒ Integer

Finds an item whose label matches the given string.

The zero-based position of the item, or NOT_FOUND if the string was not found.

Parameters:

  • string (String) —

    String to find.

  • caseSensitive (Boolean) (defaults to: false) —

    Whether search is case sensitive (default is not).

Returns:

  • (Integer) 


219
 
# File 'lib/wx/doc/gen/combo_box.rb', line 219

def find_string(string, caseSensitive=false) end

#get_count ⇒ Integer Also known as: count

Returns the number of items in the control.

Returns:

  • (Integer)

See Also:



251
 
# File 'lib/wx/doc/gen/combo_box.rb', line 251

def get_count; end

#get_current_selection ⇒ Integer Also known as: current_selection

Returns the item being selected right now.

This function does the same things as Wx::Choice#get_current_selection and returns the item currently selected in the dropdown list if it’s open or the same thing as Wx::ControlWithItems#get_selection otherwise.

Returns:

  • (Integer) 


130
 
# File 'lib/wx/doc/gen/combo_box.rb', line 130

def get_current_selection; end

#get_insertion_point ⇒ Integer Also known as: insertion_point

Same as TextEntry#get_insertion_point.

Note:

Under WXMSW, this function always returns 0 if the combobox doesn't have the focus.

Returns:

  • (Integer) 


141
 
# File 'lib/wx/doc/gen/combo_box.rb', line 141

def get_insertion_point; end

#get_selection ⇒ Integer Also known as: selection

Returns the index of the selected item or NOT_FOUND if no item is selected.

The position of the current selection.

Returns:

  • (Integer)

See Also:



203
 
# File 'lib/wx/doc/gen/combo_box.rb', line 203

def get_selection; end

#get_string(n) ⇒ String Also known as: string

Returns the label of the item with the given index.

The index must be valid, i.e. less than the value returned by #get_count, otherwise an assert is triggered. Notably, this function can’t be called if the control is empty.

The label of the item.

Parameters:

  • n (Integer) —

    The zero-based index.

Returns:

  • (String) 


228
 
# File 'lib/wx/doc/gen/combo_box.rb', line 228

def get_string(n) end

#get_string_selection ⇒ String Also known as: string_selection

Gets the text currently selected in the control.

If there is no selection, the returned string is empty.

Returns:

  • (String) 


235
 
# File 'lib/wx/doc/gen/combo_box.rb', line 235

def get_string_selection; end

#get_text_selection_range ⇒ Array(Integer,Integer) Also known as: text_selection_range

Gets the current selection span.

If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other TextCtrl methods but don’t necessarily represent the correct indices into the string returned by TextEntry#get_value for multiline controls under Windows (at least,) you should use #get_string_selection to get the selected text.

Returns:

  • (Array(Integer,Integer)) 


210
 
# File 'lib/wx/doc/gen/combo_box.rb', line 210

def get_text_selection_range; end

#is_list_empty ⇒ Boolean Also known as: list_empty?

Returns true if the list of combobox choices is empty.

Use this method instead of (not available in this class) TextEntry#is_empty to test if the list of items is empty.

Returns:

  • (Boolean) 


148
 
# File 'lib/wx/doc/gen/combo_box.rb', line 148

def is_list_empty; end

#is_text_empty ⇒ Boolean Also known as: text_empty?

Returns true if the text of the combobox is empty.

Use this method instead of (not available in this class) TextEntry#is_empty to test if the text currently entered into the combobox is empty.

Returns:

  • (Boolean) 


155
 
# File 'lib/wx/doc/gen/combo_box.rb', line 155

def is_text_empty; end

#popup ⇒ void

This method returns an undefined value.

Shows the list box portion of the combo box.

Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa. Notice that calling this function will generate a EVT_COMBOBOX_DROPDOWN event except under WXOSX where generation of this event is not supported at all.



188
 
# File 'lib/wx/doc/gen/combo_box.rb', line 188

def popup; end

#set_selection(n) ⇒ void Also known as: selection=

This method returns an undefined value.

Sets the selection to the given item n or removes the selection entirely if n == NOT_FOUND.

Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.

Parameters:

  • n (Integer) —

    The string position to select, starting from zero.

See Also:



171
 
# File 'lib/wx/doc/gen/combo_box.rb', line 171

def set_selection(n) end

#set_string(n, text) ⇒ void

This method returns an undefined value.

Changes the text of the specified combobox item.

Notice that if the item is the currently selected one, i.e. if its text is displayed in the text part of the combobox, then the text is also replaced with the new text.

Parameters:

  • n (Integer)
  • text (String) 


244
 
# File 'lib/wx/doc/gen/combo_box.rb', line 244

def set_string(n, text) end

#set_text_selection_range(from, to) ⇒ void

This method returns an undefined value.

Same as TextEntry#set_selection.

Parameters:

  • from (Integer)
  • to (Integer) 


162
 
# File 'lib/wx/doc/gen/combo_box.rb', line 162

def set_text_selection_range(from, to) end

#set_value(text) ⇒ void Also known as: value=

This method returns an undefined value.

Sets the text for the combobox text field.

For normal, editable comboboxes with a text entry field calling this method will generate a EVT_TEXT event, consistently with TextEntry#set_value behaviour, use TextEntry#change_value if this is undesirable. For controls with Wx::CB_READONLY style the method behaves somewhat differently: the string must be in the combobox choices list (the check for this is case-insensitive) and EVT_TEXT is not generated in this case.

Parameters:

  • text (String) —

    The text to set.



180
 
# File 'lib/wx/doc/gen/combo_box.rb', line 180

def set_value(text) end