Class: Wx::IntegerValidator

Inherits:

Validator

• Object
• Object
• EvtHandler
• Validator
• Wx::IntegerValidator

Defined in:

lib/wx/doc/num_validator.rb

Overview

Validator for text entries used for integer entry.

This validator can be used with Wx::TextCtrl or Wx::ComboBox (and potentially any other class implementing Wx::TextEntry interface) to check that only valid integer values can be entered into them.

By default this validator accepts any signed integer values in the 64 bit range. This range can be restricted further by calling #set_min and #set_max or #set_range methods inherited from the base class.

When the validator displays integers with thousands separators, the character used for the separators (usually “.” or “,”) depends on the locale set with Wx::Locale (note that you shouldn’t change locale with setlocale() as this can result in a mismatch between the thousands separator used by Wx::Locale and the one used by the run-time library).

Examples:

A simple example of using this class:

class MyDialog < Wx::Dialog

  def initialize
    super(...)
    ...
    # Allow integers and display them with thousands
    # separators.
    @value = 0
    val = Wx::IntegerValidator.new(Wx::NUM_VAL_THOUSANDS_SEPARATOR)
    val.on_transfer_to_window { @value }
    val.on_transfer_from_window { |val| @value = val }

    # If the would like to accept only positive integers we could
    # call val.set_min(0) or alternatively use {Wx::UnsignedValidator}.

    # Associate it with the text control:
    Wx::TextCtrl.new(self, ..., val)
  end

end

See Also:

• Validator
• GenericValidator
• TextValidator
• UnsignedValidator
• FloatValidator

Requires:

• USE_VALIDATORS

Instance Method Summary

• #get_max ⇒ Integer (also: #max)

  Gets the maximum value accepted by the validator.

• #get_min ⇒ Integer (also: #min)

  Gets the minimal value accepted by the validator.

• #get_range ⇒ Array<Integer,Integer> (also: #range)

  Gets both minimal and maximal values accepted by the validator.

• #get_value ⇒ Integer (also: #value)

  Returns the value store attribute.

• #initialize(*arg) ⇒ IntegerValidator constructor

  A new instance of IntegerValidator.

• #set_max(max) ⇒ Object (also: #max=)

  Sets the maximal value accepted by the validator.

• #set_min(min) ⇒ Object (also: #min=)

  Sets the minimal value accepted by the validator.

• #set_range(min, max) ⇒ Object (also: #range=)

  Sets both minimal and maximal values accepted by the validator.

• #set_style(style) ⇒ Object (also: #style=)

  Change the validator style.

• #set_value(val) ⇒ Object (also: #value=)

  Sets the value store attribute.

Methods inherited from Validator

#clone, #do_transfer_from_window, #do_transfer_to_window, #get_window, is_silent, suppress_bell_on_error, #validate

Methods included from Validator::Binding

#do_on_transfer_from_window, #do_on_transfer_to_window, #on_transfer_from_window, #on_transfer_to_window

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(style = Wx::NumValidatorStyle::NUM_VAL_DEFAULT) ⇒ Wx::IntegerValidator #initialize(min, max, style = Wx::NumValidatorStyle::NUM_VAL_DEFAULT) ⇒ Wx::IntegerValidator #initialize(other) ⇒ Wx::IntegerValidator

Returns a new instance of IntegerValidator.

Overloads:

• #initialize(style = Wx::NumValidatorStyle::NUM_VAL_DEFAULT) ⇒ Wx::IntegerValidator

  Constructor.

  Parameters:

  • style (Wx::NumValidatorStyle) (defaults to: Wx::NumValidatorStyle::NUM_VAL_DEFAULT) —

    A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can’t be used here.

• #initialize(min, max, style = Wx::NumValidatorStyle::NUM_VAL_DEFAULT) ⇒ Wx::IntegerValidator

  Constructor with specified range.

  Parameters:

  • min (Integer) —

    The minimum value accepted by the validator.

  • max (Integer) —

    The maximum value accepted by the validator.

  • style (Wx::NumValidatorStyle) (defaults to: Wx::NumValidatorStyle::NUM_VAL_DEFAULT) —

    A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can’t be used here.

• #initialize(other) ⇒ Wx::IntegerValidator

  Copy constructor.

  Parameters:

  • other (Wx::IntegerValidator)

# File 'lib/wx/doc/num_validator.rb', line 70

def initialize(*arg) end

Instance Method Details

#get_max ⇒ Integer Also known as: max

Gets the maximum value accepted by the validator.

Returns:

• (Integer)

# File 'lib/wx/doc/num_validator.rb', line 93

def get_max; end

#get_min ⇒ Integer Also known as: min

Gets the minimal value accepted by the validator.

Returns:

• (Integer)

# File 'lib/wx/doc/num_validator.rb', line 81

def get_min; end

#get_range ⇒ Array<Integer,Integer> Also known as: range

Gets both minimal and maximal values accepted by the validator.

Returns an array with [min, max]

Returns:

• (Array<Integer,Integer>)

# File 'lib/wx/doc/num_validator.rb', line 108

def get_range; end

#get_value ⇒ Integer Also known as: value

Returns the value store attribute. Initially 0.

Returns:

• (Integer)

# File 'lib/wx/doc/num_validator.rb', line 120

def get_value; end

#set_max(max) ⇒ Object Also known as: max=

Sets the maximal value accepted by the validator.

This value is inclusive, i.e. the value equal to max is accepted.

Parameters:

• max (Integer)

# File 'lib/wx/doc/num_validator.rb', line 88

def set_max(max) end

#set_min(min) ⇒ Object Also known as: min=

Sets the minimal value accepted by the validator.

This value is inclusive, i.e. the value equal to min is accepted.

Parameters:

• min (Integer)

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

def set_min(min) end

#set_range(min, max) ⇒ Object Also known as: range=

Sets both minimal and maximal values accepted by the validator.

Calling this is equivalent to calling both #set_min and #set_max.

Parameters:

• min (Integer)
• max (Integer)

# File 'lib/wx/doc/num_validator.rb', line 101

def set_range(min, max) end

#set_style(style) ⇒ Object Also known as: style=

Change the validator style.

Can be used to change the style of the validator after its creation.

Parameters:

• style (Wx::NumValidatorStyle) —

  A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can’t be used here.

# File 'lib/wx/doc/num_validator.rb', line 115

def set_style(style) end

#set_value(val) ⇒ Object Also known as: value=

Sets the value store attribute.

Parameters:

• val (Integer)

# File 'lib/wx/doc/num_validator.rb', line 125

def set_value(val) end