GtkAssistant              package:RGtk2              R Documentation

_G_t_k_A_s_s_i_s_t_a_n_t

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

     A widget used to guide users through multi-step operations

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

     'gtkAssistantNew(show = TRUE)'
      'gtkAssistantGetCurrentPage(object)'
      'gtkAssistantSetCurrentPage(object, page.num)'
      'gtkAssistantGetNPages(object)'
      'gtkAssistantGetNthPage(object, page.num)'
      'gtkAssistantPrependPage(object, page)'
      'gtkAssistantAppendPage(object, page)'
      'gtkAssistantInsertPage(object, page, position)'
      'gtkAssistantSetForwardPageFunc(object, page.func, data)'
      'gtkAssistantSetPageType(object, page, type)'
      'gtkAssistantGetPageType(object, page)'
      'gtkAssistantSetPageTitle(object, page, title)'
      'gtkAssistantGetPageTitle(object, page)'
      'gtkAssistantSetPageHeaderImage(object, page, pixbuf = NULL)'
      'gtkAssistantGetPageHeaderImage(object, page)'
      'gtkAssistantSetPageSideImage(object, page, pixbuf = NULL)'
      'gtkAssistantGetPageSideImage(object, page)'
      'gtkAssistantSetPageComplete(object, page, complete)'
      'gtkAssistantGetPageComplete(object, page)'
      'gtkAssistantAddActionWidget(object, child)'
      'gtkAssistantRemoveActionWidget(object, child)'
      'gtkAssistantUpdateButtonsState(object)'
      'gtkAssistant(show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBin
                                      +----GtkWindow
                                            +----GtkAssistant 

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

     GtkAssistant implements AtkImplementorIface and  'GtkBuildable'.

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

     A 'GtkAssistant' is a widget used to represent a generally complex
     operation splitted in several steps, guiding the user through its
     pages and controlling the page flow to collect the necessary data.

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


     '_G_t_k_A_s_s_i_s_t_a_n_t' _undocumented _


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

     'gtkAssistant' is the equivalent of 'gtkAssistantNew'.

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


     '_G_t_k_A_s_s_i_s_t_a_n_t_P_a_g_e_T_y_p_e' An enum for determining the page role
          inside the 'GtkAssistant'. It's used to handle buttons
          sensitivity and visibility.

          Note that an assistant needs to end its page flow with a page
          of type GTK_ASSISTANT_PAGE_CONFIRM or
          GTK_ASSISTANT_PAGE_SUMMARY to be correct.

          '_c_o_n_t_e_n_t' The page has regular contents.

          '_i_n_t_r_o' The page contains an introduction to the assistant
               task.

          '_c_o_n_f_i_r_m' The page lets the user confirm or deny the changes.

          '_s_u_m_m_a_r_y' The page informs the user of the changes done.

          '_p_r_o_g_r_e_s_s' Used for tasks that take a long time to complete,
               blocks the assistant until the page is marked as
               complete.


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


     '_G_t_k_A_s_s_i_s_t_a_n_t_P_a_g_e_F_u_n_c(_c_u_r_r_e_n_t._p_a_g_e, _d_a_t_a)' A function used by
          'gtkAssistantSetForwardPageFunc' to know which is the next
          page given a current one. It's called both for computing the
          next page when the user presses the "forward" button and for
          handling the behavior of the "last" button.

          '_c_u_r_r_e_n_t._p_a_g_e' [integer] The page number used to calculate
               the next page.

          '_d_a_t_a' [R object] user data.

          _Returns:_ [integer] The next page number.


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


     '_a_p_p_l_y(_a_s_s_i_s_t_a_n_t, _u_s_e_r._d_a_t_a)' The ::apply signal is emitted when
          the apply button is clicked. The default behavior of the
          'GtkAssistant' is to switch to the page after the current
          page, unless the current page is the last one.

          A handler for the ::apply signal should carry out the actions
          for which the wizard has collected data. If the action takes
          a long time to complete, you might consider to put a page of
          type GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page
          and handle this operation within the ::prepare signal of the
          progress page.  

          Since  2.10

          '_a_s_s_i_s_t_a_n_t' ['GtkAssistant']  the 'GtkAssistant'

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


     '_c_a_n_c_e_l(_a_s_s_i_s_t_a_n_t, _u_s_e_r._d_a_t_a)' The ::cancel signal is emitted when
          then the cancel button is clicked.  

          Since  2.10

          '_a_s_s_i_s_t_a_n_t' ['GtkAssistant']  the 'GtkAssistant'

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


     '_c_l_o_s_e(_a_s_s_i_s_t_a_n_t, _u_s_e_r._d_a_t_a)' The ::close signal is emitted either
          when the close button of a summary page is clicked, or when
          the apply button in the last page in the flow (of type
          GTK_ASSISTANT_PAGE_CONFIRM) is clicked.  

          Since  2.10

          '_a_s_s_i_s_t_a_n_t' ['GtkAssistant']  the 'GtkAssistant'

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


     '_p_r_e_p_a_r_e(_a_s_s_i_s_t_a_n_t, _p_a_g_e, _u_s_e_r._d_a_t_a)' The ::prepared signal is
          emitted when a new page is set as the assistant's  current
          page, before making the new page visible. A handler for this
          signal  can do any preparation which are necessary before
          showing 'page'.  

          Since  2.10

          '_a_s_s_i_s_t_a_n_t' ['GtkAssistant']  the 'GtkAssistant'

          '_p_a_g_e' ['GtkWidget']  the current page

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


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


     '_c_o_n_t_e_n_t-_p_a_d_d_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Number of pixels around the
          content pages.  Allowed values: >= 0  Default value: 1


     '_h_e_a_d_e_r-_p_a_d_d_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Number of pixels around the
          header.  Allowed values: >= 0  Default value: 6


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

