GtkAboutDialog             package:RGtk2             R Documentation

_G_t_k_A_b_o_u_t_D_i_a_l_o_g

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

     Display information about an application

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

     'gtkAboutDialogNew(show = TRUE)'
      'gtkAboutDialogGetName(object)'
      'gtkAboutDialogGetName(object)'
      'gtkAboutDialogSetName(object, name = NULL)'
      'gtkAboutDialogSetName(object, name = NULL)'
      'gtkAboutDialogGetProgramName(object)'
      'gtkAboutDialogSetProgramName(object, name)'
      'gtkAboutDialogGetVersion(object)'
      'gtkAboutDialogSetVersion(object, version = NULL)'
      'gtkAboutDialogGetCopyright(object)'
      'gtkAboutDialogSetCopyright(object, copyright = NULL)'
      'gtkAboutDialogGetComments(object)'
      'gtkAboutDialogSetComments(object, comments = NULL)'
      'gtkAboutDialogGetLicense(object)'
      'gtkAboutDialogSetLicense(object, license = NULL)'
      'gtkAboutDialogGetWrapLicense(object)'
      'gtkAboutDialogSetWrapLicense(object, wrap.license)'
      'gtkAboutDialogGetWebsite(object)'
      'gtkAboutDialogSetWebsite(object, website = NULL)'
      'gtkAboutDialogGetWebsiteLabel(object)'
      'gtkAboutDialogSetWebsiteLabel(object, website.label = NULL)'
      'gtkAboutDialogGetAuthors(object)'
      'gtkAboutDialogSetAuthors(object, authors)'
      'gtkAboutDialogGetArtists(object)'
      'gtkAboutDialogSetArtists(object, artists)'
      'gtkAboutDialogGetDocumenters(object)'
      'gtkAboutDialogSetDocumenters(object, documenters)'
      'gtkAboutDialogGetTranslatorCredits(object)'
      'gtkAboutDialogSetTranslatorCredits(object, translator.credits =
     NULL)'
      'gtkAboutDialogGetLogo(object)'
      'gtkAboutDialogSetLogo(object, logo = NULL)'
      'gtkAboutDialogGetLogoIconName(object)'
      'gtkAboutDialogSetLogoIconName(object, icon.name = NULL)'
      'gtkAboutDialogSetEmailHook(func, data = NULL)'
      'gtkAboutDialogSetUrlHook(func, data = NULL)'
      'gtkShowAboutDialog(parent, ...)'
      'gtkAboutDialog(show = TRUE)'

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

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

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

     GtkAboutDialog implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkAboutDialog' offers a simple way to display information
     about a program like its logo, name, copyright, website and
     license. It is also possible to give credits to the authors,
     documenters, translators and artists who have worked on the
     program. An about dialog is typically opened when the user selects
     the 'About' option from  the 'Help' menu. All parts of the dialog
     are optional.

     About dialog often contain links and email addresses.
     'GtkAboutDialog'  supports this by offering global hooks, which
     are called when the user clicks on a link or email address, see
     'gtkAboutDialogSetEmailHook' and 'gtkAboutDialogSetUrlHook'. Email
     addresses in the  authors, documenters and artists properties are
     recognized by looking for '<user@', URLs are  recognized by
     looking for 'http://url', with  'url' extending to the next space,
     tab or line break.

     To make constructing a 'GtkAboutDialog' as convenient as possible,
     you can use the function 'gtkShowAboutDialog' which constructs and
     shows a dialog  and keeps it around so that it can be shown again.

     Note that GTK+ sets a default title of '_("About %s")'  on the
     dialog window (where %s is replaced by the name of the 
     application, but in order to ensure proper translation of the
     title,  applications should set the title property explicitly when
     constructing  a 'GtkAboutDialog', as shown in the following
     example:


     gtkShowAboutDialog(NULL, "name" = "ExampleCode", "logo" =
     example_logo,
                        "title" = "About ExampleCode")
      Note that prior to GTK+ 2.12, the '"program-name"' property was
     called "name". This was changed to avoid the conflict with the
     '"name"' property.

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


     '_G_t_k_A_b_o_u_t_D_i_a_l_o_g' The 'GtkAboutDialog' struct contains only private
          fields and should not be directly accessed.


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

     'gtkAboutDialog' is the equivalent of 'gtkAboutDialogNew'.

_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_G_t_k_A_b_o_u_t_D_i_a_l_o_g_A_c_t_i_v_a_t_e_L_i_n_k_F_u_n_c(_a_b_o_u_t, _l_i_n_k., _d_a_t_a)' The type of a
          function which is called when a URL or email link is
          activated. 

          '_a_b_o_u_t' ['GtkAboutDialog'] the 'GtkAboutDialog' in which the
               link was activated

          '_l_i_n_k.' [character] the URL or email address to which the
               activated link points

          '_d_a_t_a' [R object] user data that was passed when the function
               was registered with 'gtkAboutDialogSetEmailHook' or 
               'gtkAboutDialogSetUrlHook'


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


     '_a_r_t_i_s_t_s' [_c_h_a_r_a_c_t_e_r _l_i_s_t : _R_e_a_d / _W_r_i_t_e] The people who
          contributed artwork to the program, as a list of strings.
          Each string may contain email addresses and URLs, which will
          be displayed as links, see the introduction for more details.            

          Since  2.6


     '_a_u_t_h_o_r_s' [_c_h_a_r_a_c_t_e_r _l_i_s_t : _R_e_a_d / _W_r_i_t_e] The authors of the
          program, as a list of strings. Each string may contain email
          addresses and URLs, which will be displayed as links, see the
          introduction for more details.  

          Since  2.6


     '_c_o_m_m_e_n_t_s' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Comments about the program.
          This string is displayed in a label  in the main dialog, thus
          it should be a short explanation of the main purpose of the
          program, not a detailed list of features.  

          Default value: NULL  Since  2.6


     '_c_o_p_y_r_i_g_h_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Copyright information for
          the program.  

          Default value: NULL  Since  2.6


     '_d_o_c_u_m_e_n_t_e_r_s' [_c_h_a_r_a_c_t_e_r _l_i_s_t : _R_e_a_d / _W_r_i_t_e] The people
          documenting the program, as a list of strings. Each string
          may contain email addresses and URLs, which will be displayed
          as links, see the introduction for more details.  

          Since  2.6


     '_l_i_c_e_n_s_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The license of the program.
          This string is displayed in a  text view in a secondary
          dialog, therefore it is fine to use a long multi-paragraph
          text. Note that the text is only wrapped in the text view if
          the "wrap-license" property is set to 'TRUE'; otherwise the
          text itself must contain the intended linebreaks.  

          Default value: NULL  Since  2.6


     '_l_o_g_o' ['_G_d_k_P_i_x_b_u_f' : _R_e_a_d / _W_r_i_t_e] A logo for the about box. If
          this is not set, it defaults to 
          'gtkWindowGetDefaultIconList'.  

          Since  2.6


     '_l_o_g_o-_i_c_o_n-_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] A named icon to use as
          the logo for the about box. This property overrides the logo
          property.  

          Default value: NULL  Since  2.6


     '_p_r_o_g_r_a_m-_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The name of the program.
           If this is not set, it defaults to 'gGetApplicationName()'.  

          Default value: NULL  Since  2.12


     '_t_r_a_n_s_l_a_t_o_r-_c_r_e_d_i_t_s' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Credits to the
          translators. This string should be marked as translatable.
          The string may contain email addresses and URLs, which will
          be displayed as links, see the introduction for more details.            

          Default value: NULL  Since  2.6


     '_v_e_r_s_i_o_n' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The version of the program.  

          Default value: NULL  Since  2.6


     '_w_e_b_s_i_t_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The URL for the link to the
          website of the program.  This should be a string starting
          with "http://.  

          Default value: NULL  Since  2.6


     '_w_e_b_s_i_t_e-_l_a_b_e_l' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The label for the link
          to the website of the program. If this is not set,  it
          defaults to the URL specified in the  website property.  

          Default value: NULL  Since  2.6


     '_w_r_a_p-_l_i_c_e_n_s_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether to wrap the text
          in the license dialog.  

          Default value: FALSE  Since  2.8


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

