Class: Wx::MessageDialog

Inherits:

Dialog

• Object
• Object
• EvtHandler
• Window
• NonOwnedWindow
• TopLevelWindow
• Dialog
• Wx::MessageDialog

Defined in:

lib/wx/doc/gen/message_dialog.rb

Overview

This class represents a dialog that shows a single or multi-line message, with a choice of OK, Yes, No and Cancel buttons.

Styles

This class supports the following styles:

• OK: Puts an Ok button in the message box. May be combined with CANCEL.

• CANCEL: Puts a Cancel button in the message box. Must be combined with either OK or YES_NO.

• YES_NO: Puts Yes and No buttons in the message box. It is recommended to always use CANCEL with this style as otherwise the message box won't have a close button under WXMSW and the user will be forced to answer it.

• HELP: Puts a Help button to the message box. This button can have special appearance or be specially positioned if its label is not changed from the default one. Notice that using this button is not supported when showing a message box from non-main thread in WXOSX/Cocoa. Available since wxWidgets 2.9.3.

• NO_DEFAULT: Makes the "No" button default, can only be used with YES_NO.

• CANCEL_DEFAULT: Makes the "Cancel" button default, can only be used with CANCEL. This style is currently not supported (and ignored) in WXOSX.

• YES_DEFAULT: Makes the "Yes" button default, this is the default behaviour and this flag exists solely for symmetry with NO_DEFAULT.

• OK_DEFAULT: Makes the "OK" button default, this is the default behaviour and this flag exists solely for symmetry with CANCEL_DEFAULT.

• ICON_NONE: Displays no icon in the dialog if possible (an icon might still be displayed if the current platform mandates its use). This style may be used to prevent the dialog from using the default icon based on YES_NO presence as explained in ICON_QUESTION and ICON_INFORMATION documentation below.

• ICON_ERROR: Displays an error icon in the dialog.

• ICON_WARNING: Displays a warning icon in the dialog. This style should be used for informative warnings or, in combination with YES_NO or CANCEL, for questions that have potentially serious consequences (caution icon is used on macOS in this case).

• ICON_QUESTION: Displays a question mark symbol. This icon is automatically used with YES_NO so it's usually unnecessary to specify it explicitly. This style is not supported for message dialogs under WXMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later) because Microsoft guidelines indicate that no icon should be used for routine confirmations. If it is specified, no icon will be displayed.

• ICON_INFORMATION: Displays an information symbol. This icon is used by default if YES_NO is not given so it is usually unnecessary to specify it explicitly.

• ICON_EXCLAMATION: Alias for ICON_WARNING.

• ICON_HAND: Alias for ICON_ERROR.

• ICON_AUTH_NEEDED: Displays an authentication needed symbol. This style is only supported for message dialogs under WXMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later). In other cases the default icon selection logic will be used. Note this can be combined with other styles to provide a fallback. For instance, using ICON_AUTH_NEEDED | ICON_QUESTION will show a shield symbol on Windows Vista or above and a question symbol on other platforms. Available since wxWidgets 2.9.5

• STAY_ON_TOP: Makes the message box stay on top of all other windows and not only just its parent (currently implemented only under MSW and GTK).

• GeometryCentre::CENTRE: Centre the message box on its parent or on the screen if parent is not specified. Setting this style under MSW makes no differences as the dialog is always centered on the parent.

Category: Common Dialogs

See Also:

• Overview
• RichMessageDialog

Requires:

• USE_MSGDLG

Instance Method Summary

• #get_cancel_label ⇒ String (also: #cancel_label)
• #get_caption ⇒ String (also: #caption)
• #get_effective_icon ⇒ Integer (also: #effective_icon)
• #get_extended_message ⇒ String (also: #extended_message)
• #get_help_label ⇒ String (also: #help_label)
• #get_message ⇒ String (also: #message)
• #get_message_dialog_style ⇒ Integer (also: #message_dialog_style)
• #get_no_label ⇒ String (also: #no_label)
• #get_ok_label ⇒ String (also: #ok_label)
• #get_yes_label ⇒ String (also: #yes_label)
• #has_custom_labels ⇒ Boolean (also: #has_custom_labels?)
• #initialize(parent, message, caption = Wx::MESSAGE_BOX_CAPTION_STR, style = (Wx::OK|Wx::GeometryCentre::CENTRE), pos = Wx::DEFAULT_POSITION) ⇒ Wx::MessageDialog constructor

  Constructor specifying the message box properties.

• #set_extended_message(extendedMessage) ⇒ void (also: #extended_message=)

  Sets the extended message for the dialog: this message is usually an extension of the short message specified in the constructor or set with #set_message.

• #set_help_label(help) ⇒ Boolean (also: #help_label=)

  Sets the label for the Help button.

• #set_message(message) ⇒ void (also: #message=)

  Sets the message shown by the dialog.

• #set_ok_cancel_labels(ok, cancel) ⇒ Boolean

  Overrides the default labels of the OK and Cancel buttons.

• #set_ok_label(ok) ⇒ Boolean (also: #ok_label=)

  Overrides the default label of the OK button.

• #set_yes_no_cancel_labels(yes, no, cancel) ⇒ Boolean

  Overrides the default labels of the Yes, No and Cancel buttons.

• #set_yes_no_labels(yes, no) ⇒ Boolean

  Overrides the default labels of the Yes and No buttons.

• #show_modal ⇒ Integer

  Shows the dialog, returning one of StandardID::ID_OK, StandardID::ID_CANCEL, StandardID::ID_YES, StandardID::ID_NO or StandardID::ID_HELP.

Methods inherited from Dialog

#add_main_button_id, #can_do_layout_adaptation, #centre, #create, #create_button_sizer, #create_separated_button_sizer, #create_separated_sizer, #create_std_dialog_button_sizer, #create_text_sizer, #do_layout_adaptation, enable_layout_adaptation, #end_modal, #get_affirmative_id, #get_escape_id, #get_layout_adaptation_done, #get_layout_adaptation_level, #get_layout_adaptation_mode, get_layout_adapter, #get_main_button_ids, #get_return_code, #iconize, #is_iconized, is_layout_adaptation_enabled, #is_main_button_id, #is_modal, #set_affirmative_id, #set_escape_id, #set_icon, #set_icons, #set_layout_adaptation_done, #set_layout_adaptation_level, #set_layout_adaptation_mode, set_layout_adapter, #set_return_code, #show, #show_window_modal

Methods inherited from TopLevelWindow

#can_set_transparent, #center_on_screen, #centre_on_screen, #create, #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, #iconize, #is_active, #is_always_maximized, #is_full_screen, #is_iconized, #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_icon, #set_icons, #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, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #create, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_style_flag, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #hit_test, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_frozen, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #line_down, #line_up, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_font, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_style_flag, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parent, message, caption = Wx::MESSAGE_BOX_CAPTION_STR, style = (Wx::OK|Wx::GeometryCentre::CENTRE), pos = Wx::DEFAULT_POSITION) ⇒ Wx::MessageDialog

Constructor specifying the message box properties.

Use #show_modal to show the dialog. style may be a bit list of the identifiers described above. Notice that not all styles are compatible: only one of OK and YES_NO may be specified (and one of them must be specified) and at most one default button style can be used and it is only valid if the corresponding button is shown in the message box.

Parameters:

• parent (Wx::Window) —

  Parent window.

• message (String) —

  Message to show in the dialog.

• caption (String) (defaults to: Wx::MESSAGE_BOX_CAPTION_STR) —

  The dialog title.

• style (Integer) (defaults to: (Wx::OK|Wx::GeometryCentre::CENTRE)) —

  Combination of style flags described above.

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

  Dialog position (ignored under MSW).

# File 'lib/wx/doc/gen/message_dialog.rb', line 96

def initialize(parent, message, caption=Wx::MESSAGE_BOX_CAPTION_STR, style=(Wx::OK|Wx::GeometryCentre::CENTRE), pos=Wx::DEFAULT_POSITION) end

Instance Method Details

#get_cancel_label ⇒ String Also known as: cancel_label

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 209

def get_cancel_label; end

#get_caption ⇒ String Also known as: caption

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 177

def get_caption; end

#get_effective_icon ⇒ Integer Also known as: effective_icon

Returns:

• (Integer)

# File 'lib/wx/doc/gen/message_dialog.rb', line 217

def get_effective_icon; end

#get_extended_message ⇒ String Also known as: extended_message

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 185

def get_extended_message; end

#get_help_label ⇒ String Also known as: help_label

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 213

def get_help_label; end

#get_message ⇒ String Also known as: message

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 181

def get_message; end

#get_message_dialog_style ⇒ Integer Also known as: message_dialog_style

Returns:

• (Integer)

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

def get_message_dialog_style; end

#get_no_label ⇒ String Also known as: no_label

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 201

def get_no_label; end

#get_ok_label ⇒ String Also known as: ok_label

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 205

def get_ok_label; end

#get_yes_label ⇒ String Also known as: yes_label

Returns:

• (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 197

def get_yes_label; end

#has_custom_labels ⇒ Boolean Also known as: has_custom_labels?

Returns:

• (Boolean)

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

def has_custom_labels; end

#set_extended_message(extendedMessage) ⇒ void Also known as: extended_message=

This method returns an undefined value.

Sets the extended message for the dialog: this message is usually an extension of the short message specified in the constructor or set with #set_message.

If it is set, the main message appears highlighted if supported and this message appears beneath it in normal font. On the platforms which don’t support extended messages, it is simply appended to the normal message with an empty line separating them.

Parameters:

• extendedMessage (String)

# File 'lib/wx/doc/gen/message_dialog.rb', line 103

def set_extended_message(extendedMessage) end

#set_help_label(help) ⇒ Boolean Also known as: help_label=

Sets the label for the Help button.

Please see the remarks in #set_yes_no_labels documentation. Notice that changing the label of the help button resets its special status (if any, this depends on the platform) and it will be treated just like another button in this case.

Parameters:

• help (String, Integer)

Returns:

• (Boolean)

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

def set_help_label(help) end

#set_message(message) ⇒ void Also known as: message=

This method returns an undefined value.

Sets the message shown by the dialog.

Parameters:

• message (String)

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

def set_message(message) end

#set_ok_cancel_labels(ok, cancel) ⇒ Boolean

Overrides the default labels of the OK and Cancel buttons.

Please see the remarks in #set_yes_no_labels documentation.

Parameters:

• ok (String, Integer)
• cancel (String, Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/message_dialog.rb', line 127

def set_ok_cancel_labels(ok, cancel) end

#set_ok_label(ok) ⇒ Boolean Also known as: ok_label=

Overrides the default label of the OK button.

Please see the remarks in #set_yes_no_labels documentation.

Parameters:

• ok (String, Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/message_dialog.rb', line 134

def set_ok_label(ok) end

#set_yes_no_cancel_labels(yes, no, cancel) ⇒ Boolean

Overrides the default labels of the Yes, No and Cancel buttons.

Please see the remarks in #set_yes_no_labels documentation.

Parameters:

• yes (String, Integer)
• no (String, Integer)
• cancel (String, Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/message_dialog.rb', line 144

def set_yes_no_cancel_labels(yes, no, cancel) end

#set_yes_no_labels(yes, no) ⇒ Boolean

Overrides the default labels of the Yes and No buttons.

The arguments of this function can be either strings or one of the standard identifiers, such as StandardID::ID_APPLY or StandardID::ID_OPEN. Notice that even if the label is specified as an identifier, the return value of the dialog #show_modal method still remains one of StandardID::ID_OK, StandardID::ID_CANCEL, StandardID::ID_YES or StandardID::ID_NO values, i.e. this identifier changes only the label appearance but not the return code generated by the button. It is possible to mix stock identifiers and string labels in the same function call, for example:

Wx.MessageDialog(...) do |dlg|
    dlg.set_yes_no_labels(Wx::ID_SAVE, "&Don't save")
  end

Also notice that this function is not currently available on all platforms (although as of wxWidgets 2.9.0 it is implemented in all major ports), so it may return false to indicate that the labels couldn’t be changed. If it returns true, the labels were set successfully. Typically, if the function was used successfully, the main dialog message may need to be changed, e.g.:

Wx.MessageDialog(...) do |dlg|
    if dlg.set_yes_no_labels("&Quit, "&Don't quit")
      dlg.set_message('What do you want to do?')
    else # buttons have standard "Yes"/"No" values, so rephrase the question
      dlg.set_message('Do you really want to quit?')
  end

Parameters:

• yes (String, Integer)
• no (String, Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/message_dialog.rb', line 168

def set_yes_no_labels(yes, no) end

#show_modal ⇒ Integer

Shows the dialog, returning one of StandardID::ID_OK, StandardID::ID_CANCEL, StandardID::ID_YES, StandardID::ID_NO or StandardID::ID_HELP.

Notice that this method returns the identifier of the button which was clicked unlike Wx.message_box function.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/message_dialog.rb', line 174

def show_modal; end