Class: Wx::VListBox

Inherits:
VScrolledWindow show all
Defined in:
lib/wx/doc/gen/v_list_box.rb,
lib/wx/doc/v_list_box.rb

Overview

VListBox is a ListBox-like control with the following two main differences from a regular ListBox: it can have an arbitrarily huge number of items because it doesn’t store them itself but uses the #on_draw_item callback to draw them (so it is a virtual listbox) and its items can have variable height as determined by #on_measure_item (so it is also a listbox with the lines of variable height).

Also, as a consequence of its virtual nature, it doesn’t have any methods to append or insert items in it as it isn’t necessary to do it: you just have to call #set_item_count to tell the control how many items it should display. Of course, this also means that you will never use this class directly because it has pure virtual functions, but will need to derive your own class from it (for example, HTML::HtmlListBox). However it emits the same events as ListBox and the same event macros may be used with it. Since VListBox does not store its items itself, the events will only contain the index, not any contents such as the string of an item.

Category: Controls

See Also:

Direct Known Subclasses

HTML::HtmlListBox

Instance Method Summary collapse

Methods inherited from VScrolledWindow

#calc_scrolled_position, #calc_unscrolled_position, #enable_physical_scrolling, #get_row_count, #get_target_window, #get_visible_begin, #get_visible_end, #get_visible_rows_begin, #get_visible_rows_end, #is_row_visible, #is_visible, #refresh_all, #refresh_row, #refresh_rows, #scroll_row_pages, #scroll_rows, #scroll_to_row, #set_row_count, #set_target_window, #update_scrollbar, #virtual_hit_test

Methods inherited from Panel

#accepts_focus, #init_dialog, #layout, #on_sys_colour_changed, #set_focus, #set_focus_ignoring_children

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::VListBox #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::V_LIST_BOX_NAME_STR) ⇒ Wx::VListBox

Returns a new instance of VListBox.

Overloads:

  • #initialize ⇒ Wx::VListBox

    Default constructor, you must call #create later.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::V_LIST_BOX_NAME_STR) ⇒ Wx::VListBox

    Normal constructor which calls #create internally.

    Parameters:

    • parent (Wx::Window)
    • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • style (Integer) (defaults to: 0)
    • name (String) (defaults to: Wx::V_LIST_BOX_NAME_STR) 


49
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 49

def initialize(*args) end

Instance Method Details

#clear ⇒ void

This method returns an undefined value.

Deletes all items from the control.



53
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 53

def clear; end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::V_LIST_BOX_NAME_STR) ⇒ Boolean

Creates the control.

To finish creating it you also should call #set_item_count to let it know about the number of items it contains. The only special style which may be used with Wx::VListBox is LB_MULTIPLE which indicates that the listbox should support multiple selection. true on success or false if the control couldn’t be created.

Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: 0)
  • name (String) (defaults to: Wx::V_LIST_BOX_NAME_STR)

Returns:

  • (Boolean) 


67
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 67

def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::V_LIST_BOX_NAME_STR) end

#deselect_all ⇒ Boolean

Deselects all the items in the listbox.

This method is only valid for multi selection listboxes. true if any items were changed, i.e. if there had been any selected items before, or false if all the items were already deselected.

Returns:

  • (Boolean)

See Also:



76
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 76

def deselect_all; end

#each_selected {|sel| ... } ⇒ Enumerator, Object

Iterate selected items. Returns Enumerator if no block given.

Yield Parameters:

  • sel (Integer) —

    selected item index

Returns:

  • (Enumerator, Object) —

    if block given returns last return value of block, Enumerator otherwise



15
 
# File 'lib/wx/doc/v_list_box.rb', line 15

def each_selected; end

#get_item_count ⇒ Integer Also known as: item_count

Get the number of items in the control.

Returns:

  • (Integer)

See Also:



83
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 83

def get_item_count; end

#get_item_rect(item) ⇒ Wx::Rect Also known as: item_rect

Returns the rectangle occupied by this item in physical coordinates.

If the item is not currently visible, returns an empty rectangle.

Parameters:

  • item (Integer)

Returns:



99
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 99

def get_item_rect(item) end

#get_margins ⇒ Wx::Point Also known as: margins

Returns the margins used by the control.

The x field of the returned point is the horizontal margin and the y field is the vertical one.

Returns:

See Also:



91
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 91

def get_margins; end

#get_selected_count ⇒ Integer Also known as: selected_count

Returns the number of the items currently selected.

It is valid for both single and multi selection controls. In the former case it may only return 0 or 1 however.

Returns:

  • (Integer)

See Also:



109
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 109

def get_selected_count; end

#get_selection ⇒ Integer Also known as: selection

Get the currently selected item or NOT_FOUND if there is no selection.

Returns:

  • (Integer) 


114
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 114

def get_selection; end

#get_selection_background ⇒ Wx::Colour, ... Also known as: selection_background

Returns the background colour used for the selected cells.

By default the standard system colour is used.

Returns:

See Also:



123
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 123

def get_selection_background; end

#has_multiple_selection ⇒ Boolean Also known as: has_multiple_selection?

Returns true if the listbox was created with LB_MULTIPLE style and so supports multiple selection or false if it is a single selection listbox.

Returns:

  • (Boolean) 


128
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 128

def has_multiple_selection; end

#is_current(item) ⇒ Boolean Also known as: current?

Returns true if this item is the current one, false otherwise.

The current item is always the same as selected one for the single selection listbox and in this case this method is equivalent to #is_selected but they are different for multi selection listboxes where many items may be selected but only one (at most) is current.

Parameters:

  • item (Integer)

Returns:

  • (Boolean) 


136
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 136

def is_current(item) end

#is_selected(item) ⇒ Boolean Also known as: selected?

Returns true if this item is selected, false otherwise.

Parameters:

  • item (Integer)

Returns:

  • (Boolean) 


142
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 142

def is_selected(item) end

#on_draw_background(dc, rect, n) ⇒ void (protected)

This method returns an undefined value.

This method is used to draw the item’s background and, maybe, a border around it.

The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current. TodoChange this function signature to non-const.

Parameters:



237
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 237

def on_draw_background(dc, rect, n) end

#on_draw_item(dc, rect, n) ⇒ void (protected)

This method returns an undefined value.

The derived class must implement this function to actually draw the item with the given index on the provided DC.

TodoChange this function signature to non-const.

Parameters:

  • dc (Wx::DC) —

    The device context to use for drawing.

  • rect (Wx::Rect) —

    The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function).

  • n (Integer) —

    The index of the item to be drawn.



227
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 227

def on_draw_item(dc, rect, n) end

#on_draw_separator(dc, rect, n) ⇒ void (protected)

This method returns an undefined value.

This method may be used to draw separators between the lines.

The rectangle passed to it may be modified, typically to deflate it a bit before passing to #on_draw_item. The base class version of this method doesn’t do anything.

TodoChange this function signature to non-const.

Parameters:

  • dc (Wx::DC) —

    The device context to use for drawing.

  • rect (Wx::Rect) —

    The bounding rectangle for the item.

  • n (Integer) —

    The index of the item.



249
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 249

def on_draw_separator(dc, rect, n) end

#on_measure_item(n) ⇒ Integer (protected)

The derived class must implement this method to return the height of the specified item (in pixels).

Parameters:

  • n (Integer)

Returns:

  • (Integer) 


254
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 254

def on_measure_item(n) end

#select(item, select = true) ⇒ Boolean

Selects or deselects the specified item which must be valid (i.e. not equal to NOT_FOUND).

true if the items selection status has changed or false otherwise.

This function is only valid for the multiple selection listboxes, use #set_selection for the single selection ones.

Parameters:

  • item (Integer)
  • select (Boolean) (defaults to: true)

Returns:

  • (Boolean) 


153
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 153

def select(item, select=true) end

#select_all ⇒ Boolean

Selects all the items in the listbox.

true if any items were changed, i.e. if there had been any unselected items before, or false if all the items were already selected.

This method is only valid for multi selection listboxes.

Returns:

  • (Boolean)

See Also:



163
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 163

def select_all; end

#select_range(from, to) ⇒ Boolean

Selects all items in the specified range which may be given in any order.

true if the items selection status has changed or false otherwise.

This method is only valid for multi selection listboxes.

Parameters:

  • from (Integer)
  • to (Integer)

Returns:

  • (Boolean)

See Also:



175
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 175

def select_range(from, to) end

#set_item_count(count) ⇒ void Also known as: item_count=

This method returns an undefined value.

Set the number of items to be shown in the control.

This is just a synonym for Wx::VScrolledWindow#set_row_count.

Parameters:

  • count (Integer) 


182
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 182

def set_item_count(count) end

#set_margins(pt) ⇒ void #set_margins(x, y) ⇒ void Also known as: margins=

Overloads:

  • #set_margins(pt) ⇒ void

    This method returns an undefined value.

    Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

    By default both margins are 0.

    Parameters:

  • #set_margins(x, y) ⇒ void

    This method returns an undefined value.

    Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

    By default both margins are 0.

    Parameters:

    • x (Integer)
    • y (Integer) 


34
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 34

def set_margins(*args) end

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

This method returns an undefined value.

Set the selection to the specified item, if it is -1 the selection is unset.

The selected item will be automatically scrolled into view if it isn’t currently visible. This method may be used both with single and multiple selection listboxes.

Parameters:

  • selection (Integer) 


191
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 191

def set_selection(selection) end

#set_selection_background(col) ⇒ void Also known as: selection_background=

This method returns an undefined value.

Sets the colour to be used for the selected cells background.

The background of the standard cells may be changed by simply calling Window#set_background_colour.

Note:

Using a non-default background colour may result in control having an appearance different from the similar native controls and should be avoided in general.

Parameters:

See Also:



206
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 206

def set_selection_background(col) end

#toggle(item) ⇒ void

This method returns an undefined value.

Toggles the state of the specified item, i.e. selects it if it was unselected and deselects it if it was selected.

This method is only valid for multi selection listboxes.

Parameters:

  • item (Integer)

See Also:



215
 
# File 'lib/wx/doc/gen/v_list_box.rb', line 215

def toggle(item) end