Class: Wx::Dialog

Inherits:
TopLevelWindow show all
Defined in:
lib/wx/doc/gen/dialog.rb

Overview

A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen.

It can contain controls and other windows and is often used to allow the user to make some choice or to answer a question. Dialogs can be made scrollable, automatically, for computers with low resolution screens: please see Automatic Scrolled Dialogs for further details. Dialogs usually contain either a single button allowing to close the dialog or two buttons, one accepting the changes and the other one discarding them (such button, if present, is automatically activated if the user presses the “Esc” key). By default, buttons with the standard StandardID::ID_OK and StandardID::ID_CANCEL identifiers behave as expected. Starting with wxWidgets 2.7 it is also possible to use a button with a different identifier instead, see #set_affirmative_id and #set_escape_id. Also notice that the #create_button_sizer should be used to create the buttons appropriate for the current platform and positioned correctly (including their order which is platform-dependent).

Modal and Modeless

There are two kinds of dialog, modal and modeless. A modal dialog blocks program flow and user input on other windows until it is dismissed, whereas a modeless dialog behaves more like a frame in that program flow continues, and input in other windows is still possible. To show a modal dialog you should use the #show_modal method while to show a dialog modelessly you simply use #show, just as with frames. Note that dialogs need to be explicitly destroyed when closed and not used anymore. The traditional code for this would be like:

def ask_user
    dlg = MyAskDialog.new(...)
    if dlg.show_modal == Wx::ID_OK
      # ...
    #else: dialog was cancelled or some another button pressed
    end  
  
    dlg.destroy
  end

You can achieve the same result with dialogs by using simpler code:

def ask_user
    MyAskDialog(...) do |dlg|
      if dlg.show_modal == Wx::ID_OK
        # ...
      #else: dialog was cancelled or some another button pressed
      end  
    end
  end

An application can define a CloseEvent handler for the dialog to respond to system close events.

Styles

This class supports the following styles:

  • CAPTION: Puts a caption on the dialog box.

  • DEFAULT_DIALOG_STYLE: Equivalent to a combination of CAPTION, CLOSE_BOX and SYSTEM_MENU (the last one is not used under Unix).

  • RESIZE_BORDER: Display a resizable frame around the window.

  • SYSTEM_MENU: Display a system menu.

  • CLOSE_BOX: Displays a close box on the frame.

  • MAXIMIZE_BOX: Displays a maximize box on the dialog.

  • MINIMIZE_BOX: Displays a minimize box on the dialog.

  • THICK_FRAME: Display a thick frame around the window.

  • STAY_ON_TOP: The dialog stays on top of all other windows.

  • NO_3D: This style is obsolete and doesn't do anything any more, don't use it in any new code.

  • DIALOG_NO_PARENT: By default, a dialog created with a NULL parent window will be given the application's top level window as parent. Use this style to prevent this from happening and create an orphan dialog. This is not recommended for modal dialogs.

  • DIALOG_EX_CONTEXTHELP: Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a EVT_HELP event if the user clicked on an application window. Note that this is an extended style and must be set by calling Window#set_extra_style before Create is called (two-step construction).

  • DIALOG_EX_METAL: On macOS, frames with this style will be shown with a metallic look. This is an extra style.

Under Unix or Linux, MWM (the Motif Window Manager) or other window managers recognizing the MHM hints should be running for any of these styles to have an effect.

Events emitted by this class

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

Category: Common Dialogs

See Also:

  • Overview
  • Frame
  • Overview

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TopLevelWindow

#can_set_transparent, #center_on_screen, #centre_on_screen, #create_persistent_object, #enable_close_button, #enable_full_screen_view, #enable_maximize_button, #enable_minimize_button, #get_content_protection, #get_default_item, get_default_size, #get_icon, #get_icons, #get_title, #get_tmp_default_item, #is_active, #is_always_maximized, #is_full_screen, #is_maximized, #layout, #maximize, #msw_get_system_menu, #osx_is_modified, #osx_set_modified, #request_user_attention, #restore, #set_content_protection, #set_default_item, #set_max_size, #set_min_size, #set_represented_filename, #set_size_hints, #set_title, #set_tmp_default_item, #set_transparent, #should_prevent_app_exit, #show_full_screen, #show_without_activating

Methods inherited from NonOwnedWindow

#set_shape

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_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_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::Dialog #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_DIALOG_STYLE, name = Wx::DIALOG_NAME_STR) ⇒ Wx::Dialog

Returns a new instance of Dialog.

Overloads:

  • #initialize ⇒ Wx::Dialog

    Default constructor.

  • #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_DIALOG_STYLE, name = Wx::DIALOG_NAME_STR) ⇒ Wx::Dialog

    Constructor.

    Parameters:

    • parent (Wx::Window) —

      Can be NULL, a frame or another dialog box.

    • id (Integer) —

      An identifier for the dialog. A value of -1 is taken to mean a default.

    • title (String) —

      The title of the dialog.

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

      The dialog position. The value Wx::DEFAULT_POSITION indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.

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

      The dialog size. The value Wx::DEFAULT_SIZE indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.

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

      The window style.

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

      Used to associate a name with the window, allowing the application user to set Motif resource values for individual dialog boxes.

    See Also:



149
 
# File 'lib/wx/doc/gen/dialog.rb', line 149

def initialize(*args) end

Class Method Details

.enable_layout_adaptation(enable) ⇒ void

This method returns an undefined value.

A static function enabling or disabling layout adaptation for all dialogs.

Parameters:

  • enable (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


474
 
# File 'lib/wx/doc/gen/dialog.rb', line 474

def self.enable_layout_adaptation(enable) end

.get_layout_adapter ⇒ Wx::DialogLayoutAdapter

A static function getting the current layout adapter object.

Returns:

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


481
 
# File 'lib/wx/doc/gen/dialog.rb', line 481

def self.get_layout_adapter; end

.is_layout_adaptation_enabled ⇒ Boolean

A static function returning true if layout adaptation is enabled for all dialogs.

Returns:

  • (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


488
 
# File 'lib/wx/doc/gen/dialog.rb', line 488

def self.is_layout_adaptation_enabled; end

.set_layout_adapter(adapter) ⇒ Wx::DialogLayoutAdapter

A static function for setting the current layout adapter object, returning the old adapter.

If you call this, you should delete the old adapter object.

Parameters:

Returns:

See Also:



497
 
# File 'lib/wx/doc/gen/dialog.rb', line 497

def self.set_layout_adapter(adapter) end

Instance Method Details

#add_main_button_id(id) ⇒ void

This method returns an undefined value.

Adds an identifier to be regarded as a main button for the non-scrolling area of a dialog.

Parameters:

  • id (Integer)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


157
 
# File 'lib/wx/doc/gen/dialog.rb', line 157

def add_main_button_id(id) end

#can_do_layout_adaptation ⇒ Boolean Also known as: can_do_layout_adaptation?

Returns true if this dialog can and should perform layout adaptation using #do_layout_adaptation, usually if the dialog is too large to fit on the display.

Returns:

  • (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


164
 
# File 'lib/wx/doc/gen/dialog.rb', line 164

def can_do_layout_adaptation; end

#centre(direction = Wx::Orientation::BOTH) ⇒ void

This method returns an undefined value.

Centres the dialog box on the display.

Parameters:



170
 
# File 'lib/wx/doc/gen/dialog.rb', line 170

def centre(direction=Wx::Orientation::BOTH) end

#create(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_DIALOG_STYLE, name = Wx::DIALOG_NAME_STR) ⇒ Boolean

Used for two-step dialog box construction.

Parameters:

  • parent (Wx::Window)
  • id (Integer)
  • title (String)
  • 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: Wx::DEFAULT_DIALOG_STYLE)
  • name (String) (defaults to: Wx::DIALOG_NAME_STR)

Returns:

  • (Boolean)

See Also:

  • dialog


184
 
# File 'lib/wx/doc/gen/dialog.rb', line 184

def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DIALOG_NAME_STR) end

#create_button_sizer(flags) ⇒ Wx::Sizer

Creates a sizer with standard buttons.

flags is a bit list of the following flags: OK, CANCEL, YES, NO, APPLY, CLOSE, HELP, NO_DEFAULT. The sizer lays out the buttons in a manner appropriate to the platform. This function uses #create_std_dialog_button_sizer internally for most platforms but doesn’t create the sizer at all for the platforms with hardware buttons (such as smartphones) for which it sets up the hardware buttons appropriately and returns NULL, so don’t forget to test that the return value is valid before using it.

Parameters:

  • flags (Integer)

Returns:



193
 
# File 'lib/wx/doc/gen/dialog.rb', line 193

def create_button_sizer(flags) end

#create_separated_button_sizer(flags) ⇒ Wx::Sizer

Creates a sizer with standard buttons using #create_button_sizer separated from the rest of the dialog contents by a horizontal StaticLine.

Note:

Just like #create_button_sizer, this function may return NULL if no buttons were created.

This is a combination of #create_button_sizer and #create_separated_sizer.

Parameters:

  • flags (Integer)

Returns:



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

def create_separated_button_sizer(flags) end

#create_separated_sizer(sizer) ⇒ Wx::Sizer

Returns the sizer containing the given one with a separating StaticLine if necessarily.

This function is useful for creating the sizer containing footer-like contents in dialog boxes. It will add a separating static line only if it conforms to the current platform convention (currently it is not added under Mac where the use of static lines for grouping is discouraged and is added elsewhere).

The sizer wrapping the input one or possibly the input sizer itself if no wrapping is necessary.

Parameters:

  • sizer (Wx::Sizer) —

    The sizer to wrap, must be non-NULL.

Returns:



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

def create_separated_sizer(sizer) end

#create_std_dialog_button_sizer(flags) ⇒ Wx::StdDialogButtonSizer

Creates a StdDialogButtonSizer with standard buttons.

flags is a bit list of the following flags: OK, CANCEL, YES, NO, APPLY, CLOSE, HELP, NO_DEFAULT. The sizer lays out the buttons in a manner appropriate to the platform.

Parameters:

  • flags (Integer)

Returns:



223
 
# File 'lib/wx/doc/gen/dialog.rb', line 223

def create_std_dialog_button_sizer(flags) end

#create_text_sizer(message, widthMax = -1)) ⇒ Wx::Sizer

Splits text up at newlines and places the lines into StaticText objects with the specified maximum width in a vertical BoxSizer.

If widthMax has its default value of -1, only explicit new line characters in message are taken into account. Otherwise, lines are broken either after a new line or wrapped, at word boundary, if their width would become bigger than the specified maximal width.

Parameters:

  • message (String) —

    The text to be displayed.

  • widthMax (Integer) (defaults to: -1)) —

    Specifies the text’s maximum width (this argument is available since version 3.1.1, previous versions always behaved as if the maximal width of -1 was specified).

Returns:

See Also:

  • width)


232
 
# File 'lib/wx/doc/gen/dialog.rb', line 232

def create_text_sizer(message, widthMax=-1) end

#do_layout_adaptation ⇒ Boolean

Performs layout adaptation, usually if the dialog is too large to fit on the display.

Returns:

  • (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


239
 
# File 'lib/wx/doc/gen/dialog.rb', line 239

def do_layout_adaptation; end

#end_modal(retCode) ⇒ void

This method returns an undefined value.

Ends a modal dialog, passing a value to be returned from the #show_modal invocation.

Parameters:

  • retCode (Integer) —

    The value that should be returned by ShowModal.

See Also:



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

def end_modal(retCode) end

#get_affirmative_id ⇒ Integer Also known as: affirmative_id

Gets the identifier of the button which works like standard OK button in this dialog.

Returns:

  • (Integer)

See Also:



256
 
# File 'lib/wx/doc/gen/dialog.rb', line 256

def get_affirmative_id; end

#get_escape_id ⇒ Integer Also known as: escape_id

Gets the identifier of the button to map presses of ESC button to.

Returns:

  • (Integer)

See Also:



264
 
# File 'lib/wx/doc/gen/dialog.rb', line 264

def get_escape_id; end

#get_layout_adaptation_done ⇒ Boolean Also known as: layout_adaptation_done

Returns true if the dialog has been adapted, usually by making it scrollable to work with a small display.

Returns:

  • (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


272
 
# File 'lib/wx/doc/gen/dialog.rb', line 272

def get_layout_adaptation_done; end

#get_layout_adaptation_level ⇒ Integer Also known as: layout_adaptation_level

Gets a value representing the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.

Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.

Returns:

  • (Integer)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


280
 
# File 'lib/wx/doc/gen/dialog.rb', line 280

def get_layout_adaptation_level; end

#get_layout_adaptation_mode ⇒ Wx::DialogLayoutAdaptationMode Also known as: layout_adaptation_mode

Gets the adaptation mode, overriding the global adaptation flag.

Returns:

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


288
 
# File 'lib/wx/doc/gen/dialog.rb', line 288

def get_layout_adaptation_mode; end

#get_main_button_ids ⇒ Array<Integer> Also known as: main_button_ids

Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.

Returns:

  • (Array<Integer>)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


296
 
# File 'lib/wx/doc/gen/dialog.rb', line 296

def get_main_button_ids; end

#get_return_code ⇒ Integer Also known as: return_code

Gets the return code for this window.

Remark:

A return code is normally associated with a modal dialog, where #show_modal returns a code to the application.

Returns:

  • (Integer)

See Also:



310
 
# File 'lib/wx/doc/gen/dialog.rb', line 310

def get_return_code; end

#iconize(iconize = true) ⇒ void

This method returns an undefined value.

Iconizes or restores the dialog.

Windows only.

Remark:

Note that in Windows, iconization has no effect since dialog boxes cannot be iconized. However, applications may need to explicitly restore dialog boxes under Motif which have user-iconizable frames, and under Windows calling Iconize(false) will bring the window to the front, as does Show(true).

Parameters:

  • iconize (Boolean) (defaults to: true) —

    If true, iconizes the dialog box; if false, shows and restores it.



324
 
# File 'lib/wx/doc/gen/dialog.rb', line 324

def iconize(iconize=true) end

#is_iconized ⇒ Boolean Also known as: iconized?

Returns true if the dialog box is iconized.

Windows only.

Remark:

Always returns false under Windows since dialogs cannot be iconized.

Returns:

  • (Boolean) 


336
 
# File 'lib/wx/doc/gen/dialog.rb', line 336

def is_iconized; end

#is_main_button_id(id) ⇒ Boolean Also known as: main_button_id?

Returns true if id is in the array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.

Availability: only available for the WXMSW port.

Parameters:

  • id (Integer)

Returns:

  • (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)

Requires:

  • WXMSW 


346
 
# File 'lib/wx/doc/gen/dialog.rb', line 346

def is_main_button_id(id) end

#is_modal ⇒ Boolean Also known as: modal?

Returns true if the dialog box is modal, false otherwise.

Returns:

  • (Boolean) 


351
 
# File 'lib/wx/doc/gen/dialog.rb', line 351

def is_modal; end

#set_affirmative_id(id) ⇒ void Also known as: affirmative_id=

This method returns an undefined value.

Sets the identifier to be used as OK button.

When the button with this identifier is pressed, the dialog calls Window#validate and Window#transfer_data_from_window and, if they both return true, closes the dialog with the affirmative id return code. Also, when the user presses a hardware OK button on the devices having one or the special OK button in the PocketPC title bar, an event with this id is generated. By default, the affirmative id is StandardID::ID_OK.

Parameters:

  • id (Integer)

See Also:



363
 
# File 'lib/wx/doc/gen/dialog.rb', line 363

def set_affirmative_id(id) end

#set_escape_id(id) ⇒ void Also known as: escape_id=

This method returns an undefined value.

Sets the identifier of the button which should work like the standard “Cancel” button in this dialog.

When the button with this id is clicked, the dialog is closed. Also, when the user presses ESC key in the dialog or closes the dialog using the close button in the title bar, this is mapped to the click of the button with the specified id. By default, the escape id is the special value StandardID::ID_ANY meaning that StandardID::ID_CANCEL button is used if it’s present in the dialog and otherwise the button with #get_affirmative_id is used. Another special value for id is StandardID::ID_NONE meaning that ESC presses should be ignored. If any other value is given, it is interpreted as the id of the button to map the escape key to.

Note:

This method should be used for custom modal dialog implemented in wxWidgets itself, native dialogs such as MessageDialog or FileDialog, handle ESC presses in their own way which cannot be customized.

Parameters:

  • id (Integer) 


378
 
# File 'lib/wx/doc/gen/dialog.rb', line 378

def set_escape_id(id) end

#set_icon(icon) ⇒ void Also known as: icon=

This method returns an undefined value.

Sets the icon for this dialog.

Parameters:

  • icon (Wx::Icon) —

    The icon to associate with this dialog.

See Also:



387
 
# File 'lib/wx/doc/gen/dialog.rb', line 387

def set_icon(icon) end

#set_icons(icons) ⇒ void Also known as: icons=

This method returns an undefined value.

Sets the icons for this dialog.

Parameters:

See Also:



396
 
# File 'lib/wx/doc/gen/dialog.rb', line 396

def set_icons(icons) end

#set_layout_adaptation_done(done) ⇒ void Also known as: layout_adaptation_done=

This method returns an undefined value.

Marks the dialog as having been adapted, usually by making it scrollable to work with a small display.

Parameters:

  • done (Boolean)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


405
 
# File 'lib/wx/doc/gen/dialog.rb', line 405

def set_layout_adaptation_done(done) end

#set_layout_adaptation_level(level) ⇒ void Also known as: layout_adaptation_level=

This method returns an undefined value.

Sets the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.

Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.

Parameters:

  • level (Integer)

See Also:

  • Scrolled Dialogs (for more on layout adaptation)


414
 
# File 'lib/wx/doc/gen/dialog.rb', line 414

def set_layout_adaptation_level(level) end

#set_layout_adaptation_mode(mode) ⇒ void Also known as: layout_adaptation_mode=

This method returns an undefined value.

Sets the adaptation mode, overriding the global adaptation flag.

Parameters:

See Also:



424
 
# File 'lib/wx/doc/gen/dialog.rb', line 424

def set_layout_adaptation_mode(mode) end

#set_return_code(retCode) ⇒ void Also known as: return_code=

This method returns an undefined value.

Sets the return code for this window.

A return code is normally associated with a modal dialog, where #show_modal returns a code to the application. The function #end_modal calls #set_return_code.

Parameters:

  • retCode (Integer) —

    The integer return code, usually a control identifier.

See Also:



435
 
# File 'lib/wx/doc/gen/dialog.rb', line 435

def set_return_code(retCode) end

#show(show = true) ⇒ Boolean

Hides or shows the dialog.

The preferred way of dismissing a modal dialog is to use #end_modal.

Parameters:

  • show (Boolean) (defaults to: true) —

    If true, the dialog box is shown and brought to the front, otherwise the box is hidden. If false and the dialog is modal, control is returned to the calling program.

Returns:

  • (Boolean) 


443
 
# File 'lib/wx/doc/gen/dialog.rb', line 443

def show(show=true) end

#show_modal ⇒ Integer

Shows an application-modal dialog.

Program flow does not return until the dialog has been dismissed with #end_modal. Notice that it is possible to call #show_modal for a dialog which had been previously shown with #show, this allows making an existing modeless dialog modal. However #show_modal can’t be called twice without intervening #end_modal calls. Note that this function creates a temporary event loop which takes precedence over the application’s main event loop (see EventLoopBase) and which is destroyed when the dialog is dismissed. This also results in a call to App#process_pending_events. The value set with #set_return_code.

Returns:

  • (Integer)

See Also:



457
 
# File 'lib/wx/doc/gen/dialog.rb', line 457

def show_modal; end

#show_window_modal ⇒ void

This method returns an undefined value.

Shows a dialog modal to the parent top level window only.

Unlike #show_modal, dialogs shown with this function only prevent the user from interacting with their parent frame only but not with the rest of the application. They also don’t block the program execution but instead return immediately, as #show, and generate a EVT_WINDOW_MODAL_DIALOG_CLOSED event (WindowModalDialogEvent) later when the dialog is closed. Currently this function is only fully implemented in WXOSX ports, under the other platforms it behaves like #show_modal (but also sends the above mentioned event).

See Also:

  • WindowModalDialogEvent
  • show_window_modal_then_do


466
 
# File 'lib/wx/doc/gen/dialog.rb', line 466

def show_window_modal; end