Class: Wx::Dialog
- Inherits:
-
TopLevelWindow
- Object
- Object
- EvtHandler
- Window
- NonOwnedWindow
- TopLevelWindow
- Wx::Dialog
- 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: Shows the title bar, containing the window title, for this window. Note that this style is implicitly enabled by MINIMIZE_BOX, MAXIMIZE_BOX and CLOSE_BOX on most systems as the corresponding buttons couldn't be shown if the window had no title bar at all.
-
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. This style implicitly enables CAPTION too.
-
MAXIMIZE_BOX: Displays a maximize box on the dialog. This style implicitly enables CAPTION too.
-
MINIMIZE_BOX: Displays a minimize box on the dialog. This style implicitly enables CAPTION too.
-
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 nil 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 a window manager recognizing the WM 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:
-
EvtHandler#evt_close(meth = nil, &block): The dialog is being closed by the user or programmatically (see Window#close). The user may generate this event clicking the close button (typically the 'X' on the top-right of the title bar) if it's present (see the CLOSE_BOX style).
-
EvtHandler#evt_init_dialog(meth = nil, &block): Process a EVT_INIT_DIALOG event. See InitDialogEvent.
Category: Common Dialogs
Direct Known Subclasses
ColourDialog, CredentialEntryDialog, DirDialog, FileDialog, FindReplaceDialog, FontDialog, GenericAboutDialog, MessageDialog, MultiChoiceDialog, NumberEntryDialog, PG::PGArrayEditorDialog, PRT::PrintAbortDialog, ProgressDialog, PropertySheetDialog, RTC::RichTextStyleOrganiserDialog, RTC::SymbolPickerDialog, SingleChoiceDialog, TextEntryDialog, Wizard
Class Method Summary collapse
-
.enable_layout_adaptation(enable) ⇒ void
A static function enabling or disabling layout adaptation for all dialogs.
-
.get_layout_adapter ⇒ Wx::DialogLayoutAdapter
A static function getting the current layout adapter object.
-
.is_layout_adaptation_enabled ⇒ Boolean
A static function returning true if layout adaptation is enabled for all dialogs.
-
.set_layout_adapter(adapter) ⇒ Wx::DialogLayoutAdapter
A static function for setting the current layout adapter object, returning the old adapter.
Instance Method Summary collapse
-
#add_main_button_id(id) ⇒ void
Adds an identifier to be regarded as a main button for the non-scrolling area of a dialog.
-
#can_do_layout_adaptation ⇒ Boolean
(also: #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.
-
#centre(direction = Wx::Orientation::BOTH) ⇒ void
Centres the dialog box on the display.
-
#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.
-
#create_button_sizer(flags) ⇒ Wx::Sizer
Creates a sizer with standard buttons.
-
#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.
-
#create_separated_sizer(sizer) ⇒ Wx::Sizer
Returns the sizer containing the given one with a separating StaticLine if necessarily.
-
#create_std_dialog_button_sizer(flags) ⇒ Wx::StdDialogButtonSizer
Creates a StdDialogButtonSizer with standard buttons.
-
#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.
-
#do_layout_adaptation ⇒ Boolean
Performs layout adaptation, usually if the dialog is too large to fit on the display.
-
#end_modal(retCode) ⇒ void
Ends a modal dialog, passing a value to be returned from the #show_modal invocation.
-
#get_affirmative_id ⇒ Integer
(also: #affirmative_id)
Gets the identifier of the button which works like standard OK button in this dialog.
-
#get_escape_id ⇒ Integer
(also: #escape_id)
Gets the identifier of the button to map presses of ESC button to.
-
#get_layout_adaptation_done ⇒ Boolean
(also: #layout_adaptation_done)
Returns true if the dialog has been adapted, usually by making it scrollable to work with a small display.
-
#get_layout_adaptation_level ⇒ Integer
(also: #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.
-
#get_layout_adaptation_mode ⇒ Wx::DialogLayoutAdaptationMode
(also: #layout_adaptation_mode)
Gets the adaptation mode, overriding the global adaptation flag.
-
#get_main_button_ids ⇒ Array<Integer>
(also: #main_button_ids)
Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
-
#get_return_code ⇒ Integer
(also: #return_code)
Gets the return code for this window.
-
#iconize(iconize = true) ⇒ void
Iconizes or restores the dialog.
-
#initialize(*args) ⇒ Dialog
constructor
A new instance of Dialog.
-
#is_iconized ⇒ Boolean
(also: #iconized?)
Returns true if the dialog box is iconized.
-
#is_main_button_id(id) ⇒ Boolean
(also: #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.
-
#is_modal ⇒ Boolean
(also: #modal?)
Returns true if the dialog box is modal, false otherwise.
-
#set_affirmative_id(id) ⇒ void
(also: #affirmative_id=)
Sets the identifier to be used as OK button.
-
#set_escape_id(id) ⇒ void
(also: #escape_id=)
Sets the identifier of the button which should work like the standard “Cancel” button in this dialog.
-
#set_icon(icon) ⇒ void
(also: #icon=)
Sets the icon for this dialog.
-
#set_icons(icons) ⇒ void
(also: #icons=)
Sets the icons for this dialog.
-
#set_layout_adaptation_done(done) ⇒ void
(also: #layout_adaptation_done=)
Marks the dialog as having been adapted, usually by making it scrollable to work with a small display.
-
#set_layout_adaptation_level(level) ⇒ void
(also: #layout_adaptation_level=)
Sets the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.
-
#set_layout_adaptation_mode(mode) ⇒ void
(also: #layout_adaptation_mode=)
Sets the adaptation mode, overriding the global adaptation flag.
-
#set_return_code(retCode) ⇒ void
(also: #return_code=)
Sets the return code for this window.
-
#show(show = true) ⇒ Boolean
Hides or shows the dialog.
-
#show_modal ⇒ Integer
Shows an application-modal dialog.
-
#show_window_modal ⇒ void
Shows a dialog modal to the parent top level window only.
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
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_prepare_update_window_ui, #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_cursor_bundle, #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, #msw_disable_composited, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #pop_event_handler, #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_cursor_bundle, #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_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_label_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_label_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_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_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, #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 #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_DIALOG_STYLE, name = Wx::DIALOG_NAME_STR) {|win| ... } ⇒ Wx::Dialog
Returns a new instance of Dialog.
163 |
# File 'lib/wx/doc/gen/dialog.rb', line 163 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.
494 |
# File 'lib/wx/doc/gen/dialog.rb', line 494 def self.enable_layout_adaptation(enable) end |
.get_layout_adapter ⇒ Wx::DialogLayoutAdapter
A static function getting the current layout adapter object.
501 |
# File 'lib/wx/doc/gen/dialog.rb', line 501 def self.get_layout_adapter; end |
.is_layout_adaptation_enabled ⇒ Boolean
A static function returning true if layout adaptation is enabled for all dialogs.
508 |
# File 'lib/wx/doc/gen/dialog.rb', line 508 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.
517 |
# File 'lib/wx/doc/gen/dialog.rb', line 517 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.
171 |
# File 'lib/wx/doc/gen/dialog.rb', line 171 def (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.
178 |
# File 'lib/wx/doc/gen/dialog.rb', line 178 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.
184 |
# File 'lib/wx/doc/gen/dialog.rb', line 184 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.
198 |
# File 'lib/wx/doc/gen/dialog.rb', line 198 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 nil, so don’t forget to test that the return value is valid before using it.
207 |
# File 'lib/wx/doc/gen/dialog.rb', line 207 def (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.
Just like #create_button_sizer, this function may return nil if no buttons were created.
This is a combination of #create_button_sizer and #create_separated_sizer.
220 |
# File 'lib/wx/doc/gen/dialog.rb', line 220 def (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.
229 |
# File 'lib/wx/doc/gen/dialog.rb', line 229 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.
Unlike when using StdDialogButtonSizer directly, creating the sizer with this method usually results in one of its buttons being default (and having initial focus): NO_DEFAULT will make the No button the default, otherwise the OK or Yes button will be set as the default when present.
243 |
# File 'lib/wx/doc/gen/dialog.rb', line 243 def (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.
252 |
# File 'lib/wx/doc/gen/dialog.rb', line 252 def create_text_sizer(, widthMax=-1) end |
#do_layout_adaptation ⇒ Boolean
Performs layout adaptation, usually if the dialog is too large to fit on the display.
259 |
# File 'lib/wx/doc/gen/dialog.rb', line 259 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.
269 |
# File 'lib/wx/doc/gen/dialog.rb', line 269 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.
276 |
# File 'lib/wx/doc/gen/dialog.rb', line 276 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.
284 |
# File 'lib/wx/doc/gen/dialog.rb', line 284 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.
292 |
# File 'lib/wx/doc/gen/dialog.rb', line 292 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.
300 |
# File 'lib/wx/doc/gen/dialog.rb', line 300 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.
308 |
# File 'lib/wx/doc/gen/dialog.rb', line 308 def get_layout_adaptation_mode; end |
#get_main_button_ids ⇒ Array<Integer> Also known as:
Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
316 |
# File 'lib/wx/doc/gen/dialog.rb', line 316 def ; end |
#get_return_code ⇒ Integer Also known as: return_code
Gets 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.
330 |
# File 'lib/wx/doc/gen/dialog.rb', line 330 def get_return_code; end |
#iconize(iconize = true) ⇒ void
This method returns an undefined value.
Iconizes or restores the dialog.
Windows only.
Note that in Windows, iconization has no effect since dialog boxes cannot be iconized. However calling Iconize(false) will bring the window to the front, as does Show(true).
344 |
# File 'lib/wx/doc/gen/dialog.rb', line 344 def iconize(iconize=true) end |
#is_iconized ⇒ Boolean Also known as: iconized?
Returns true if the dialog box is iconized.
Windows only.
Always returns false under Windows since dialogs cannot be iconized.
356 |
# File 'lib/wx/doc/gen/dialog.rb', line 356 def is_iconized; end |
#is_main_button_id(id) ⇒ Boolean Also known as:
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.
366 |
# File 'lib/wx/doc/gen/dialog.rb', line 366 def (id) end |
#is_modal ⇒ Boolean Also known as: modal?
Returns true if the dialog box is modal, false otherwise.
371 |
# File 'lib/wx/doc/gen/dialog.rb', line 371 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.
383 |
# File 'lib/wx/doc/gen/dialog.rb', line 383 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.
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.
398 |
# File 'lib/wx/doc/gen/dialog.rb', line 398 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.
407 |
# File 'lib/wx/doc/gen/dialog.rb', line 407 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.
416 |
# File 'lib/wx/doc/gen/dialog.rb', line 416 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.
425 |
# File 'lib/wx/doc/gen/dialog.rb', line 425 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.
434 |
# File 'lib/wx/doc/gen/dialog.rb', line 434 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.
444 |
# File 'lib/wx/doc/gen/dialog.rb', line 444 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.
455 |
# File 'lib/wx/doc/gen/dialog.rb', line 455 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.
463 |
# File 'lib/wx/doc/gen/dialog.rb', line 463 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.
477 |
# File 'lib/wx/doc/gen/dialog.rb', line 477 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).
486 |
# File 'lib/wx/doc/gen/dialog.rb', line 486 def show_window_modal; end |