Class: Gtk::MessageDialog

Inherits:
Dialog show all
Extended by:
GLib::Deprecatable
Defined in:
lib/gtk4/deprecated.rb,
lib/gtk4/message-dialog.rb

Instance Method Summary collapse

Methods inherited from Dialog

#add_action_widget, #add_button, #add_button_raw, #add_buttons, #content_area, #get_response_for_widget, #get_widget_for_response, #get_widget_for_response_raw, #header_bar, #initialize_raw, #response, #set_default_response, #set_default_response_raw, #set_response_sensitive, #use_header_bar, #use_header_bar=, #use_header_bar?

Methods inherited from Window

#application, #application=, auto_startup_notification=, #child, #child=, #close, #decorated, #decorated=, #decorated?, #default_height, #default_height=, default_icon_name, default_icon_name=, #default_widget, #default_widget=, #default_width, #default_width=, #deletable, #deletable=, #deletable?, #destroy, #destroy_with_parent, #destroy_with_parent=, #destroy_with_parent?, #display, #display=, #focus, #focus=, #focus_visible, #focus_visible=, #focus_visible?, #focus_widget, #focus_widget=, #fullscreen, #fullscreen_on_monitor, #fullscreened=, #fullscreened?, #get_default_size, #group, #handle_menubar_accel, #handle_menubar_accel=, #handle_menubar_accel?, #has_group, #hide_on_close, #hide_on_close=, #hide_on_close?, #icon_name, #icon_name=, interactive_debugging=, #is_active, #is_active=, #is_active?, #is_fullscreen, #is_maximized, #is_suspended, list_toplevels, #maximize, #maximized=, #maximized?, #minimize, #mnemonics_visible, #mnemonics_visible=, #mnemonics_visible?, #modal, #modal=, #modal?, #present, #present_with_time, #resizable, #resizable=, #resizable?, #set_default_size, #startup_id=, #suspended=, #suspended?, #title, #title=, #titlebar, #titlebar=, toplevels, #transient_for, #transient_for=, #unfullscreen, #unmaximize, #unminimize

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #children, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Constructor Details

#initialize(options = {}) ⇒ Gtk::Widget

Creates a new message dialog.

This is a simple dialog with some text that is marked up with Pango markup. When the user clicks a button a “response” signal is emitted with response IDs from [enumGtk.ResponseType]. See [classGtk.Dialog] for more details.

Special XML characters in the printf() arguments passed to this function will automatically be escaped as necessary. (See g_markup_printf_escaped() for how this is implemented.) Usually this is what you want, but if you have an existing Pango markup string that you want to use literally as the label, then you need to use [methodGtk.MessageDialog.set_markup] instead, since you can’t pass the markup string either as the format (it might contain “%” characters) or as a string argument.

GtkWidget *dialog;
GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
dialog = gtk_message_dialog_new (parent_window,
                                 flags,
                                 GTK_MESSAGE_ERROR,
                                 GTK_BUTTONS_CLOSE,
                                 NULL);
gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
                               markup);

Parameters:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/gtk4/message-dialog.rb', line 19

def initialize(options={})
  parent  = options[:parent]
  flags   = options[:flags] || 0
  type    = options[:type] || :info
  buttons = options[:buttons] || options[:buttons_type] || :ok
  message = options[:message]

  initialize_general = GLib::Object.instance_method(:initialize).bind(self)
  initialize_general.call(:message_type => type,
                          :buttons => buttons)
  Loader.reference_gobject(self, :sink => true)

  if message
    self.use_markup = false
    self.text = message
  end

  if parent
    self.transient_for = parent
  end

  if flags
    unless flags.is_a?(DialogFlags)
      flags = DialogFlags.new(flags)
    end
    self.modal = true if flags.modal?
    self.destroy_with_parent = true if flags.destroy_with_parent?
  end
end

Instance Method Details

#buttons=(buttons) ⇒ Gtk::ButtonsType

Returns buttons.

Parameters:

Returns:

#format_secondary_markup(message_format, array) ⇒ nil

Sets the secondary text of the message dialog.

The message_format is assumed to contain Pango markup.

Due to an oversight, this function does not escape special XML characters like [ctorGtk.MessageDialog.new_with_markup] does. Thus, if the arguments may contain special XML characters, you should use g_markup_printf_escaped() to escape it.

char *msg;

msg = g_markup_printf_escaped (message_format, ...);
gtk_message_dialog_format_secondary_markup (message_dialog,
                                            "%s", msg);
g_free (msg);

Parameters:

  • message_format (String) —

    printf()-style string with Pango markup

  • array (Array) —

    arguments for message_format

Returns:

  • (nil)

#format_secondary_text(message_format, array) ⇒ nil

Sets the secondary text of the message dialog.

Parameters:

  • message_format (String) —

    printf()-style format string

  • array (Array) —

    arguments for message_format

Returns:

  • (nil)

#markup=(str) ⇒ nil

Sets the text of the message dialog.

Parameters:

  • str (String) —

    string with Pango markup

Returns:

  • (nil)

#message_area ⇒ Gtk::Widget

The GtkBox that corresponds to the message area of this dialog.

See [methodGtk.MessageDialog.get_message_area] for a detailed description of this area.

Returns:

#message_area=(message_area) ⇒ Gtk::Widget

The GtkBox that corresponds to the message area of this dialog.

See [methodGtk.MessageDialog.get_message_area] for a detailed description of this area.

Parameters:

Returns:

#message_type ⇒ Gtk::MessageType

The type of the message.

Returns:

#message_type=(message_type) ⇒ Gtk::MessageType

The type of the message.

Parameters:

Returns:

#secondary_text ⇒ String

The secondary text of the message dialog.

Returns:

  • (String) —

    secondary-text

#secondary_text=(secondary_text) ⇒ String

The secondary text of the message dialog.

Parameters:

  • secondary_text (String)

Returns:

  • (String) —

    secondary-text

  • (String) —

    secondary-text

#secondary_use_markup=(secondary_use_markup) ⇒ Boolean

true if the secondary text of the dialog includes Pango markup.

See [funcPango.parse_markup].

Parameters:

  • secondary_use_markup (Boolean)

Returns:

  • (Boolean) —

    secondary-use-markup

  • (Boolean) —

    secondary-use-markup

#secondary_use_markup? ⇒ Boolean

true if the secondary text of the dialog includes Pango markup.

See [funcPango.parse_markup].

Returns:

  • (Boolean) —

    secondary-use-markup

#text ⇒ String

The primary text of the message dialog.

If the dialog has a secondary text, this will appear as the title.

Returns:

  • (String) —

    text

#text=(text) ⇒ String

The primary text of the message dialog.

If the dialog has a secondary text, this will appear as the title.

Parameters:

  • text (String)

Returns:

  • (String) —

    text

  • (String) —

    text

#use_markup=(use_markup) ⇒ Boolean

true if the primary text of the dialog includes Pango markup.

See [funcPango.parse_markup].

Parameters:

  • use_markup (Boolean)

Returns:

  • (Boolean) —

    use-markup

  • (Boolean) —

    use-markup

#use_markup? ⇒ Boolean

true if the primary text of the dialog includes Pango markup.

See [funcPango.parse_markup].

Returns:

  • (Boolean) —

    use-markup