GtkMessageDialog            package:RGtk2            R Documentation

_G_t_k_M_e_s_s_a_g_e_D_i_a_l_o_g

_D_e_s_c_r_i_p_t_i_o_n:

     A convenient message window

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkMessageDialogNew(parent = NULL, flags, type, buttons, ...,
     show = TRUE)'
      'gtkMessageDialogNewWithMarkup(parent, flags, type, buttons, ...,
     show = TRUE)'
      'gtkMessageDialogSetMarkup(object, str)'
      'gtkMessageDialogSetImage(object, image)'
      'gtkMessageDialogFormatSecondaryText(object, ...)'
      'gtkMessageDialogFormatSecondaryMarkup(object, ...)'
      'gtkMessageDialog(parent, flags, type, buttons, ..., show =
     TRUE)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBin
                                      +----GtkWindow
                                            +----GtkDialog
                                                  +----GtkMessageDialog 

_I_n_t_e_r_f_a_c_e_s:

     GtkMessageDialog implements AtkImplementorIface and 
     'GtkBuildable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     'GtkMessageDialog' presents a dialog with an image representing
     the type of  message (Error, Question, etc.) alongside some
     message text. It's simply a  convenience widget; you could
     construct the equivalent of 'GtkMessageDialog'  from 'GtkDialog'
     without too much effort, but 'GtkMessageDialog' saves typing.

     The easiest way to do a modal message dialog is to use
     'gtkDialogRun', though you can also pass in the 'GTK_DIALOG_MODAL'
     flag, 'gtkDialogRun' automatically makes the dialog modal and
     waits for the user to respond to it. 'gtkDialogRun' returns when
     any dialog button is clicked.

     _A modal dialog._


     # A Modal dialog
     dialog <- gtkMessageDialog(main_application_window,
     "destroy-with-parent",
                                "error", "close", "Error loading file
     '", filename,
                                "': ", message)
     dialog$run()
     dialog$destroy()

     You might do a non-modal 'GtkMessageDialog' as follows:

     _A non-modal dialog._


     dialog <- gtkMessageDialog(main_application_window,
     "destroy-with-parent",
                                "error", "close", "Error loading file
     '", filename,
                                "': ", message)
     # Destroy the dialog when the user responds to it (e.g. clicks a
     button)
     gSignalConnect(dialog, "response", gtkWidgetDestroy)


_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_M_e_s_s_a_g_e_D_i_a_l_o_g' _undocumented _

          '_i_m_a_g_e' ['GtkWidget'] 

          '_l_a_b_e_l' ['GtkWidget'] 


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkMessageDialog' is the result of collapsing the constructors of
     'GtkMessageDialog' ('gtkMessageDialogNew',
     'gtkMessageDialogNewWithMarkup') and accepts a subset of its
     arguments matching the required arguments of one of its delegate
     constructors.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_M_e_s_s_a_g_e_T_y_p_e' The type of message being displayed in the
          dialog.

          '_i_n_f_o' Informational message

          '_w_a_r_n_i_n_g' Nonfatal warning message

          '_q_u_e_s_t_i_o_n' Question requiring a choice

          '_e_r_r_o_r' Fatal error message


     '_G_t_k_B_u_t_t_o_n_s_T_y_p_e' Prebuilt sets of buttons for the dialog. If  none
          of these choices are appropriate, simply use
          'GTK_BUTTONS_NONE' then call 'gtkDialogAddButtons'.

          '_n_o_n_e' no buttons at all

          '_o_k' an OK button

          '_c_l_o_s_e' a Close button

          '_c_a_n_c_e_l' a Cancel button

          '_y_e_s-_n_o' Yes and No buttons

          '_o_k-_c_a_n_c_e_l' OK and Cancel buttons


_P_r_o_p_e_r_t_i_e_s:


     '_b_u_t_t_o_n_s' ['_G_t_k_B_u_t_t_o_n_s_T_y_p_e' : _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] The buttons
          shown in the message dialog.  Default value: GTK_BUTTONS_NONE


     '_i_m_a_g_e' ['_G_t_k_W_i_d_g_e_t' : _R_e_a_d / _W_r_i_t_e] The image for this dialog.  

          Since  2.10


     '_m_e_s_s_a_g_e-_t_y_p_e' ['_G_t_k_M_e_s_s_a_g_e_T_y_p_e' : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t] The
          type of the message. The type is used to determine the image
          that is shown in the dialog, unless the image is  explicitly
          set by the ::image property.  

          Default value: GTK_MESSAGE_INFO


     '_s_e_c_o_n_d_a_r_y-_t_e_x_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The secondary text of
          the message dialog.  

          Default value: NULL  Since  2.10


     '_s_e_c_o_n_d_a_r_y-_u_s_e-_m_a_r_k_u_p' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] 'TRUE' if the
          secondary text of the dialog includes Pango markup.  See
          'pangoParseMarkup'.  

          Default value: FALSE  Since  2.10


     '_t_e_x_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The primary text of the message
          dialog. If the dialog has  a secondary text, this will appear
          as the title.  

          Default value: NULL  Since  2.10


     '_u_s_e-_m_a_r_k_u_p' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] 'TRUE' if the primary text
          of the dialog includes Pango markup.  See 'pangoParseMarkup'.            

          Default value: FALSE  Since  2.10


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_m_e_s_s_a_g_e-_b_o_r_d_e_r' [_i_n_t_e_g_e_r : _R_e_a_d] Width of border around the label
          and image in the message dialog.  Allowed values: >= 0 
          Default value: 12


     '_u_s_e-_s_e_p_a_r_a_t_o_r' [_l_o_g_i_c_a_l : _R_e_a_d] Whether to draw a separator line
          between the message label and the buttons in the dialog.  

          Default value: FALSE  Since  2.4


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://developer.gnome.org/doc/API/2.0/gtk/GtkMessageDialog.html>

_S_e_e _A_l_s_o:

     'GtkDialog'

