Class: Wx::RadioBox

Inherits:
Control show all
Defined in:
lib/wx/doc/gen/radio_box.rb,
lib/wx/doc/radio_box.rb

Overview

A radio box item is used to select one of number of mutually exclusive choices.

It is displayed as a vertical column or horizontal row of labelled buttons.

Styles

This class supports the following styles:

  • RA_SPECIFY_ROWS: The major dimension parameter refers to the maximum number of rows.

  • RA_SPECIFY_COLS: The major dimension parameter refers to the maximum number of columns.

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_RADIOBOX

Instance Method Summary collapse

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::RadioBox #initialize(parent, id, label, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Wx::RadioBox #initialize(parent, id, label, pos, size, choices, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Wx::RadioBox

Returns a new instance of RadioBox.

Overloads:

  • #initialize ⇒ Wx::RadioBox

    Default constructor.

    See Also:

  • #initialize(parent, id, label, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Wx::RadioBox

    Constructor, creating and showing a radiobox.

    Parameters:

    • parent (Wx::Window) —

      Parent window. Must not be NULL.

    • id (Integer) —

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

    • label (String) —

      Label for the static box surrounding the radio buttons.

    • 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 a default size is chosen.

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

      An array of choices with which to initialize the radiobox.

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

      Specifies the maximum number of rows (if style contains Wx::RA_SPECIFY_ROWS) or columns (if style contains Wx::RA_SPECIFY_COLS) for a two-dimensional radiobox. The default value of 0 means to use the number of items, i.e. n.

    • style (Integer) (defaults to: Wx::RA_SPECIFY_COLS) —

      Window style. See Wx::RadioBox.

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

      Window validator.

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

      Window name.

    See Also:

  • #initialize(parent, id, label, pos, size, choices, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Wx::RadioBox

    Constructor, creating and showing a radiobox.

    Parameters:

    • parent (Wx::Window) —

      Parent window. Must not be NULL.

    • id (Integer) —

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

    • label (String) —

      Label for the static box surrounding the radio buttons.

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

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

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

      Window size. If DEFAULT_SIZE is specified then a default size is chosen.

    • choices (Array<String>) —

      An array of choices with which to initialize the radiobox.

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

      Specifies the maximum number of rows (if style contains Wx::RA_SPECIFY_ROWS) or columns (if style contains Wx::RA_SPECIFY_COLS) for a two-dimensional radiobox. The default value of 0 means to use the number of items, i.e. number of elements in choices.

    • style (Integer) (defaults to: Wx::RA_SPECIFY_COLS) —

      Window style. See Wx::RadioBox.

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

      Window validator.

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

      Window name.

    See Also:



80
 
# File 'lib/wx/doc/gen/radio_box.rb', line 80

def initialize(*args) end

Instance Method Details

#create(parent, id, label, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Boolean #create(parent, id, label, pos, size, choices, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Boolean

Overloads:

  • #create(parent, id, label, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, choices = nil, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Boolean

    Creates the radiobox for two-step construction.

    See radio_box for further details.

    Parameters:

    • parent (Wx::Window)
    • id (Integer)
    • label (String)
    • 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: nil)
    • majorDimension (Integer) (defaults to: 0)
    • style (Integer) (defaults to: Wx::RA_SPECIFY_COLS)
    • validator (Wx::Validator) (defaults to: Wx::DEFAULT_VALIDATOR)
    • name (String) (defaults to: Wx::RADIO_BOX_NAME_STR)

    Returns:

    • (Boolean)
  • #create(parent, id, label, pos, size, choices, majorDimension = 0, style = Wx::RA_SPECIFY_COLS, validator = Wx::DEFAULT_VALIDATOR, name = Wx::RADIO_BOX_NAME_STR) ⇒ Boolean

    Creates the radiobox for two-step construction.

    See radio_box for further details.

    Parameters:

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

    Returns:

    • (Boolean) 


112
 
# File 'lib/wx/doc/gen/radio_box.rb', line 112

def create(*args) end

#enable_item(item, enable = true) ⇒ true, false

Enables od disables individual buttons. true if the item has been enabled or disabled or false if nothing was done because it already was in the requested state.

Parameters:

  • item (Integer) —

    The zero-based position of the button to enable or disable.

  • enable (true, false) (defaults to: true) —

    true to enable, false to disable.

Returns:

  • (true, false)

See Also:



18
 
# File 'lib/wx/doc/radio_box.rb', line 18

def enable_item(item, enable=true) end

#find_string(string, bCase = false) ⇒ Integer

Finds a button matching the given string, returning the position if found, or NOT_FOUND if not found.

Parameters:

  • string (String) —

    The string to find.

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

    Should the search be case-sensitive?

Returns:

  • (Integer) 


118
 
# File 'lib/wx/doc/gen/radio_box.rb', line 118

def find_string(string, bCase=false) end

#get_column_count ⇒ Integer Also known as: column_count

Returns the number of columns in the radiobox.

Returns:

  • (Integer) 


122
 
# File 'lib/wx/doc/gen/radio_box.rb', line 122

def get_column_count; end

#get_count ⇒ Integer Also known as: count

Returns the number of items in the control.

Returns:

  • (Integer)

See Also:



204
 
# File 'lib/wx/doc/gen/radio_box.rb', line 204

def get_count; end

#get_item_from_point(pt) ⇒ Integer Also known as: item_from_point

Returns a radio box item under the point, a zero-based item index, or NOT_FOUND if no item is under the point.

Parameters:

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

    Point in client coordinates.

Returns:

  • (Integer) 


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

def get_item_from_point(pt) end

#get_item_help_text(item) ⇒ String Also known as: item_help_text

Returns the helptext associated with the specified item if any or EmptyString.

Parameters:

  • item (Integer) —

    The zero-based item index.

Returns:

  • (String)

See Also:



137
 
# File 'lib/wx/doc/gen/radio_box.rb', line 137

def get_item_help_text(item) end

#get_item_tool_tip(item) ⇒ Wx::ToolTip Also known as: item_tool_tip

Returns the tooltip associated with the specified item if any or NULL.

Parameters:

  • item (Integer)

Returns:

See Also:



147
 
# File 'lib/wx/doc/gen/radio_box.rb', line 147

def get_item_tool_tip(item) end

#get_row_count ⇒ Integer Also known as: row_count

Returns the number of rows in the radiobox.

Returns:

  • (Integer) 


152
 
# File 'lib/wx/doc/gen/radio_box.rb', line 152

def get_row_count; end

#get_selection ⇒ Integer Also known as: selection

Returns the index of the selected item.

As radio boxes always have a selected item, the return value is never NOT_FOUND for this class.

Returns:

  • (Integer) 


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

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) 


214
 
# File 'lib/wx/doc/gen/radio_box.rb', line 214

def get_string(n) end

#get_string_selection ⇒ String Also known as: string_selection

Returns the label of the selected item or an empty string if no item is selected.

Returns:

  • (String)

See Also:



259
 
# File 'lib/wx/doc/gen/radio_box.rb', line 259

def get_string_selection; end

#get_strings ⇒ Array<String> Also known as: strings

Returns the array of the labels of all items in the control.

Returns:

  • (Array<String>) 


240
 
# File 'lib/wx/doc/gen/radio_box.rb', line 240

def get_strings; end

#is_empty ⇒ Boolean Also known as: empty?

Returns true if the control is empty or false if it has some items.

Returns:

  • (Boolean)

See Also:



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

def is_empty; end

#is_item_enabled(n) ⇒ Boolean Also known as: item_enabled?

Returns true if the item is enabled or false if it was disabled using Enable(n, false).

This function is currently only implemented in WXMSW, WXGTK, QT and Universal and always returns true in the other ports.

Parameters:

  • n (Integer) —

    The zero-based button position.

Returns:

  • (Boolean) 


160
 
# File 'lib/wx/doc/gen/radio_box.rb', line 160

def is_item_enabled(n) end

#is_item_shown(n) ⇒ Boolean Also known as: item_shown?

Returns true if the item is currently shown or false if it was hidden using Show(n, false).

Note that this function returns true for an item which hadn’t been hidden even if the entire radiobox is not currently shown. This function is currently only implemented in WXMSW, WXGTK, QT and Universal and always returns true in the other ports.

Parameters:

  • n (Integer) —

    The zero-based button position.

Returns:

  • (Boolean) 


169
 
# File 'lib/wx/doc/gen/radio_box.rb', line 169

def is_item_shown(n) end

#select(n) ⇒ void

This method returns an undefined value.

This is the same as #set_selection and exists only because it is slightly more natural for controls which support multiple selection.

Parameters:

  • n (Integer) 


265
 
# File 'lib/wx/doc/gen/radio_box.rb', line 265

def select(n) end

#set_item_help_text(item, helptext) ⇒ void

This method returns an undefined value.

Sets the helptext for an item.

Empty string erases any existing helptext.

Parameters:

  • item (Integer) —

    The zero-based item index.

  • helptext (String) —

    The help text to set for the item.

See Also:



179
 
# File 'lib/wx/doc/gen/radio_box.rb', line 179

def set_item_help_text(item, helptext) end

#set_item_tool_tip(item, text) ⇒ void

This method returns an undefined value.

Sets the tooltip text for the specified item in the radio group.

This function is currently only implemented in WXMSW and WXGTK2 and does nothing in the other ports.

Parameters:

  • item (Integer) —

    Index of the item the tooltip will be shown for.

  • text (String) —

    Tooltip text for the item, the tooltip is removed if empty.

See Also:



189
 
# File 'lib/wx/doc/gen/radio_box.rb', line 189

def set_item_tool_tip(item, text) end

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

This method returns an undefined value.

Sets the selection to the given item.

Notice that a radio box always has selection, so n must be valid here and passing NOT_FOUND is not allowed.

Parameters:

  • n (Integer) 


196
 
# File 'lib/wx/doc/gen/radio_box.rb', line 196

def set_selection(n) end

#set_string(n, string) ⇒ void

This method returns an undefined value.

Sets the label for the given item.

Parameters:

  • n (Integer) —

    The zero-based item index.

  • string (String) —

    The label to set.



221
 
# File 'lib/wx/doc/gen/radio_box.rb', line 221

def set_string(n, string) end

#set_string_selection(string) ⇒ Boolean Also known as: string_selection=

Selects the item with the specified string in the control.

This method doesn’t cause any command events to be emitted. Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control case-insensitively and the first matching entry is selected, even if it doesn’t have exactly the same case as this string and there is an exact match afterwards.

true if the specified string has been selected, false if it wasn’t found in the control.

Parameters:

  • string (String) —

    The string to select.

Returns:

  • (Boolean) 


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

def set_string_selection(string) end

#show_item(item, show = true) ⇒ true, false

Shows or hides individual buttons. true if the item has been shown or hidden or false if nothing was done because it already was in the requested state.

Parameters:

  • item (Integer) —

    The zero-based position of the button to show or hide.

  • show (true, false) (defaults to: true) —

    true to show, false to hide.

Returns:

  • (true, false)

See Also:



26
 
# File 'lib/wx/doc/radio_box.rb', line 26

def show_item(item, show=true) end