GtkDialog               package:RGtk2               R Documentation

_G_t_k_D_i_a_l_o_g

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

     Create popup windows

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

     'gtkDialogNew(show = TRUE)'
      'gtkDialogNewWithButtons(title = NULL, parent = NULL, flags = 0,
     ..., show = TRUE)'
      'gtkDialogRun(object)'
      'gtkDialogResponse(object, response.id)'
      'gtkDialogAddButton(object, button.text, response.id)'
      'gtkDialogAddButtons(object, ...)'
      'gtkDialogAddActionWidget(object, child, response.id)'
      'gtkDialogGetHasSeparator(object)'
      'gtkDialogSetDefaultResponse(object, response.id)'
      'gtkDialogSetHasSeparator(object, setting)'
      'gtkDialogSetResponseSensitive(object, response.id, setting)'
      'gtkDialogGetResponseForWidget(object, widget)'
      'gtkAlternativeDialogButtonOrder(object)'
      'gtkDialogSetAlternativeButtonOrder(object, ...)'
      'gtkDialogSetAlternativeButtonOrderFromArray(object, new.order)'
      'gtkDialog(title = NULL, parent = NULL, flags = 0, ..., show =
     TRUE)'

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

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

     +----GtkColorSelectionDialog

     +----GtkFileChooserDialog
                                                  +----GtkFileSelection

     +----GtkFontSelectionDialog
                                                  +----GtkInputDialog
                                                  +----GtkMessageDialog

     +----GtkPageSetupUnixDialog

     +----GtkPrintUnixDialog

     +----GtkRecentChooserDialog 

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

     GtkDialog implements AtkImplementorIface and  'GtkBuildable'.

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

     Dialog boxes are a convenient way to prompt the user for a small
     amount of input, e.g. to display a message, ask a question, or
     anything else that does  not require extensive effort on the
     user's part.

     GTK+ treats a dialog as a window split vertically. The top section
     is a 'GtkVBox', and is where widgets such as a 'GtkLabel' or a
     'GtkEntry' should be packed. The bottom area is known as the
     'action_area'. This is generally used for packing buttons into the
     dialog which may perform functions such as cancel, ok, or apply.
     The two areas are separated by a 'GtkHSeparator'. 'GtkDialog'
     boxes are created with a call to 'gtkDialogNew' or
     'gtkDialogNewWithButtons'. 'gtkDialogNewWithButtons' is
     recommended; it allows you to set the dialog title, some
     convenient flags, and add simple buttons.

     If 'dialog' is a newly created dialog, the two primary areas of
     the window  can be accessed as 'GTK_DIALOG(dialog)->vbox' and 
     'GTK_DIALOG(dialog)->action_area', as can be seen from the
     example, below.

     A 'modal' dialog (that is, one which freezes the rest of the
     application from user input), can be created by calling
     'gtkWindowSetModal' on the dialog. Use the 'gtkWindow()' function
     to cast the widget returned from 'gtkDialogNew' into a
     'GtkWindow'. When using 'gtkDialogNewWithButtons' you can also
     pass the 'GTK_DIALOG_MODAL' flag to make a dialog modal.

     If you add buttons to 'GtkDialog' using 'gtkDialogNewWithButtons',
     'gtkDialogAddButton', 'gtkDialogAddButtons', or
     'gtkDialogAddActionWidget', clicking the button will emit a signal
     called "response" with a response ID that you specified. GTK+ will
     never assign a meaning to positive response IDs; these are
     entirely user-defined. But for convenience, you can use the
     response IDs in the 'GtkResponseType' enumeration (these all have
     values less than zero). If a dialog receives a delete event,  the
     "response" signal will be emitted with a response ID of
     'GTK_RESPONSE_DELETE_EVENT'.

     If you want to block waiting for a dialog to return before
     returning control flow to your code, you can call 'gtkDialogRun'.
     This function enters a recursive main loop and waits for the user
     to respond to the dialog, returning the  response ID corresponding
     to the button the user clicked.

     For the simple dialog in the following example, in reality you'd
     probably use 'GtkMessageDialog' to save yourself some effort.  But
     you'd need to create the dialog contents manually if you had more
     than a simple message in the dialog.

     _Simple   'GtkDialog'   usage._


     # Function to open a dialog box displaying the message provided.
     quick_message <- function(message) {
       ## Create the widgets 

       dialog <- gtkDialog("Message", NULL, "destroy-with-parent",
     "gtk-ok", "none",
                           show = FALSE)
       label <- gtkLabel(message)

       ## Ensure that the dialog box is destroyed when the user
     responds.

       gSignalConnect(dialog, "response", gtkWidgetDestroy)

       ## Add the label, and show everything we've added to the dialog.

       dialog[["vbox"]]$add(label)
       dialog$showAll()
     }


_G_t_k_D_i_a_l_o_g _a_s _G_t_k_B_u_i_l_d_a_b_l_e:

     The GtkDialog implementation of the GtkBuildable interface exposes
     the  'vbox' and 'action.area' as internal children with the names
     "vbox" and  "action_area".

     GtkDialog supports a custom <action-widgets> element, which  can
     contain multiple <action-widget> elements. The "response"
     attribute specifies a numeric response, and the content of the
     element is the id of widget (which should be a child of the
     dialogs 'action.area').

     _A   'GtkDialog'   UI definition fragment._ <object
     class="GtkDialog" id="dialog1">
       <child internal-child="vbox">"
         <object class="GtkVBox">
           <child internal-child="action_area">
             <object class="GtkHButtonBox">
               <child>
                 <object class="GtkButton" id="button_cancel"/>
               </child>
               <child>
                 <object class="GtkButton" id="button_ok"/>
               </child>
             </object>
           </child>
         </object>
       </child>
       <action-widgets>
         <action-widget response="3">button_ok</action-widget>
         <action-widget response="-5">button_cancel</action-widget>
       </action-widgets>
     </object>


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


     '_G_t_k_D_i_a_l_o_g' 'vbox' is a 'GtkVBox' - the main part of the dialog
          box. 'action_area' is a 'GtkHButtonBox' packed below the
          dividing 'GtkHSeparator' in the dialog. It is treated exactly
          the same as any other 'GtkHButtonBox'.

          '_v_b_o_x' ['GtkWidget'] 

          '_a_c_t_i_o_n_A_r_e_a' ['GtkWidget'] 


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

     'gtkDialog' is the result of collapsing the constructors of
     'GtkDialog' ('gtkDialogNew', 'gtkDialogNewWithButtons') 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_D_i_a_l_o_g_F_l_a_g_s' Flags used to influence dialog construction.

          '_m_o_d_a_l' Make the constructed dialog modal,  see
               'gtkWindowSetModal'.

          '_d_e_s_t_r_o_y-_w_i_t_h-_p_a_r_e_n_t' Destroy the dialog when its parent is
               destroyed, see 'gtkWindowSetDestroyWithParent'.

          '_n_o-_s_e_p_a_r_a_t_o_r' Don't put a separator between the action area
               and the dialog content.


     '_G_t_k_R_e_s_p_o_n_s_e_T_y_p_e' Predefined values for use as response ids in
          'gtkDialogAddButton'. All predefined values are negative,
          GTK+ leaves positive values for application-defined response
          ids. 

          '_n_o_n_e' Returned if an action widget has no response id, or if
                the dialog gets programmatically hidden or destroyed.

          '_r_e_j_e_c_t' Generic response id, not used by GTK+ dialogs.

          '_a_c_c_e_p_t' Generic response id, not used by GTK+ dialogs.

          '_d_e_l_e_t_e-_e_v_e_n_t' Returned if the dialog is deleted.

          '_o_k' Returned by OK buttons in GTK+ dialogs.

          '_c_a_n_c_e_l' Returned by Cancel buttons in GTK+ dialogs.

          '_c_l_o_s_e' Returned by Close buttons in GTK+ dialogs.

          '_y_e_s' Returned by Yes buttons in GTK+ dialogs.

          '_n_o' Returned by No buttons in GTK+ dialogs.

          '_a_p_p_l_y' Returned by Apply buttons in GTK+ dialogs.

          '_h_e_l_p' Returned by Help buttons in GTK+ dialogs.


_S_i_g_n_a_l_s:


     '_c_l_o_s_e(_d_i_a_l_o_g, _u_s_e_r._d_a_t_a)' _undocumented _

          '_d_i_a_l_o_g' ['GtkDialog'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_r_e_s_p_o_n_s_e(_d_i_a_l_o_g, _a_r_g_1, _u_s_e_r._d_a_t_a)' Emitted when an action widget
          is clicked, the dialog receives a delete event, or the
          application programmer calls 'gtkDialogResponse'. On a delete
          event, the response ID is 'GTK_RESPONSE_NONE'. Otherwise, it
          depends on which action widget was clicked.

          '_d_i_a_l_o_g' ['GtkDialog'] the object which received the signal.

          '_a_r_g_1' [integer] the response ID

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


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


     '_h_a_s-_s_e_p_a_r_a_t_o_r' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] The dialog has a
          separator bar above its buttons.  Default value: TRUE


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


     '_a_c_t_i_o_n-_a_r_e_a-_b_o_r_d_e_r' [_i_n_t_e_g_e_r : _R_e_a_d] Width of border around the
          button area at the bottom of the dialog.  Allowed values: >=
          0  Default value: 5


     '_b_u_t_t_o_n-_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Spacing between buttons. 
          Allowed values: >= 0  Default value: 6


     '_c_o_n_t_e_n_t-_a_r_e_a-_b_o_r_d_e_r' [_i_n_t_e_g_e_r : _R_e_a_d] Width of border around the
          main dialog area.  Allowed values: >= 0  Default value: 2


_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/GtkDialog.html>

