GtkNotebook              package:RGtk2              R Documentation

_G_t_k_N_o_t_e_b_o_o_k

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

     A tabbed notebook container

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

     'gtkNotebookNew(show = TRUE)'
      'gtkNotebookAppendPage(object, child, tab.label = NULL)'
      'gtkNotebookAppendPageMenu(object, child, tab.label = NULL,
     menu.label = NULL)'
      'gtkNotebookPrependPage(object, child, tab.label = NULL)'
      'gtkNotebookPrependPageMenu(object, child, tab.label = NULL,
     menu.label = NULL)'
      'gtkNotebookInsertPage(object, child, tab.label = NULL, position
     = -1)'
      'gtkNotebookInsertPageMenu(object, child, tab.label = NULL,
     menu.label = NULL, position = -1)'
      'gtkNotebookRemovePage(object, page.num)'
      'gtkNotebookPageNum(object, child)'
      'gtkNotebookNextPage(object)'
      'gtkNotebookPrevPage(object)'
      'gtkNotebookReorderChild(object, child, position)'
      'gtkNotebookSetTabPos(object, pos)'
      'gtkNotebookSetShowTabs(object, show.tabs)'
      'gtkNotebookSetShowBorder(object, show.border)'
      'gtkNotebookSetScrollable(object, scrollable)'
      'gtkNotebookSetTabBorder(object, border.width)'
      'gtkNotebookPopupEnable(object)'
      'gtkNotebookPopupDisable(object)'
      'gtkNotebookGetCurrentPage(object)'
      'gtkNotebookGetMenuLabel(object, child)'
      'gtkNotebookGetNthPage(object, page.num)'
      'gtkNotebookGetNPages(object)'
      'gtkNotebookGetTabLabel(object, child)'
      'gtkNotebookQueryTabLabelPacking(object, child)'
      'gtkNotebookSetHomogeneousTabs(object, homogeneous)'
      'gtkNotebookSetMenuLabel(object, child, menu.label = NULL)'
      'gtkNotebookSetMenuLabelText(object, child, menu.text)'
      'gtkNotebookSetTabHborder(object, tab.hborder)'
      'gtkNotebookSetTabLabel(object, child, tab.label = NULL)'
      'gtkNotebookSetTabLabelPacking(object, child, expand, fill,
     pack.type)'
      'gtkNotebookSetTabLabelText(object, child, tab.text)'
      'gtkNotebookSetTabVborder(object, tab.vborder)'
      'gtkNotebookSetTabReorderable(object, child, reorderable)'
      'gtkNotebookSetTabDetachable(object, child, detachable)'
      'gtkNotebookGetMenuLabelText(object, child)'
      'gtkNotebookGetScrollable(object)'
      'gtkNotebookGetShowBorder(object)'
      'gtkNotebookGetShowTabs(object)'
      'gtkNotebookGetTabLabelText(object, child)'
      'gtkNotebookGetTabPos(object)'
      'gtkNotebookGetTabReorderable(object, child)'
      'gtkNotebookGetTabDetachable(object, child)'
      'gtkNotebookSetCurrentPage(object, page.num)'
      'gtkNotebookSetGroupId(object, group.id)'
      'gtkNotebookSetGroupId(object, group.id)'
      'gtkNotebookGetGroupId(object)'
      'gtkNotebookGetGroupId(object)'
      'gtkNotebookSetGroup(object, group)'
      'gtkNotebookGetGroup(object)'
      'gtkNotebookSetWindowCreationHook(func, data)'
      'gtkNotebook(show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkNotebook 

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

     GtkNotebook implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkNotebook' widget is a 'GtkContainer' whose children are
     pages that can be switched between using tab labels along one
     edge.

     There are many configuration options for 'GtkNotebook'. Among
     other things, you can choose on which edge the tabs appear (see
     'gtkNotebookSetTabPos'), whether, if there are too many tabs to
     fit the noteobook should be made bigger or scrolling arrows added
     (see gtk_notebook_set_scrollable), and whether there will be a
     popup menu allowing the users to switch pages. (see
     'gtkNotebookPopupEnable', 'gtkNoteobookPopupDisable()')

_G_t_k_N_o_t_e_b_o_o_k _a_s _G_t_k_B_u_i_l_d_a_b_l_e:

     The GtkNoteboopk implementation of the GtkBuildable interface
     supports placing children into tabs by specifying "tab" as the
     "type" attribute of a <child> element. Note that the content of
     the tab must be created before the tab can be filled. A tab child
     can be specified without specifying a <child>  type attribute.

     _A UI definition fragment with GtkNotebook_ <object
     class="GtkNotebook">
       <child>
         <object class="GtkLabel" id="notebook-content">
           <property name="label">Content</property>
         </object>
       </child>
       <child type="tab">
         <object class="GtkLabel" id="notebook-tab">
           <property name="label">Tab</property>
         </object>
       </child>
     </object>


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


     '_G_t_k_N_o_t_e_b_o_o_k' _undocumented _

          '_t_a_b_P_o_s' ['GtkPositionType'] 


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

     'gtkNotebook' is the equivalent of 'gtkNotebookNew'.

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


     '_G_t_k_N_o_t_e_b_o_o_k_W_i_n_d_o_w_C_r_e_a_t_i_o_n_F_u_n_c(_s_o_u_r_c_e, _p_a_g_e, _x, _y, _d_a_t_a)' A
          function used by GtkNotebook when a detachable tab is dropped
          in the root window, it's used to create a window containing a
          notebook where the tab will be attached. This function will
          also be responsible of moving/resizing the window and adding
          the necessary properties to the notebook (i.e.: group-id).

          If the function returns 'NULL', the drag will be cancelled.

          '_s_o_u_r_c_e' ['GtkNotebook'] The source 'GtkNotebook' of the drag
               operation

          '_p_a_g_e' ['GtkWidget'] the child 'GtkWidget' affected

          '_x' [integer] the X coordinate where the drop happens

          '_y' [integer] the Y coordinate where the drop happens

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

          _Returns:_ ['GtkNotebook'] The created 'GtkNotebook' where
          the tab will be attached, or NULL to cancel the drag


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


     '_c_h_a_n_g_e-_c_u_r_r_e_n_t-_p_a_g_e(_n_o_t_e_b_o_o_k, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

          '_a_r_g_1' [integer] 

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


     '_c_r_e_a_t_e-_w_i_n_d_o_w(_n_o_t_e_b_o_o_k, _p_a_g_e, _x, _y, _u_s_e_r._d_a_t_a)' The
          ::create-window signal is emitted when a detachable tab is
          dropped on the root window. 

          A handler for this signal can create a window containing  a
          notebook where the tab will be attached. It is also 
          responsible for moving/resizing the window and adding the 
          necessary properties to the notebook (e.g. the  '"group-id"'
          ).

          The default handler uses the global window creation hook, if
          one has been set with 'gtkNotebookSetWindowCreationHook'.  

          Since  2.12

          '_n_o_t_e_b_o_o_k' ['GtkNotebook']  the 'GtkNotebook' emitting the
               signal

          '_p_a_g_e' ['GtkWidget']  the tab of 'notebook' that is being
               detached

          '_x' [integer]  the X coordinate where the drop happens

          '_y' [integer]  the Y coordinate where the drop happens

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

          _Returns:_ ['GtkNotebook']  a 'GtkNotebook' that 'page'
          should be added to, or 'NULL'.


     '_f_o_c_u_s-_t_a_b(_n_o_t_e_b_o_o_k, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

          '_a_r_g_1' ['GtkNotebookTab'] 

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


     '_m_o_v_e-_f_o_c_u_s-_o_u_t(_n_o_t_e_b_o_o_k, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

          '_a_r_g_1' ['GtkDirectionType'] 

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


     '_p_a_g_e-_a_d_d_e_d(_n_o_t_e_b_o_o_k, _c_h_i_l_d, _p_a_g_e._n_u_m, _u_s_e_r._d_a_t_a)' the
          ::page-added signal is emitted in the notebook right after a
          page is added to the notebook.  

          Since  2.10

          '_n_o_t_e_b_o_o_k' ['GtkNotebook']  the 'GtkNotebook'

          '_c_h_i_l_d' ['GtkWidget']  the child 'GtkWidget' affected

          '_p_a_g_e._n_u_m' [numeric]  the new page number for 'child'

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


     '_p_a_g_e-_r_e_m_o_v_e_d(_n_o_t_e_b_o_o_k, _c_h_i_l_d, _p_a_g_e._n_u_m, _u_s_e_r._d_a_t_a)' the
          ::page-removed signal is emitted in the notebook right after
          a page is removed from the notebook.  

          Since  2.10

          '_n_o_t_e_b_o_o_k' ['GtkNotebook']  the 'GtkNotebook'

          '_c_h_i_l_d' ['GtkWidget']  the child 'GtkWidget' affected

          '_p_a_g_e._n_u_m' [numeric]  the 'child' page number

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


     '_p_a_g_e-_r_e_o_r_d_e_r_e_d(_n_o_t_e_b_o_o_k, _c_h_i_l_d, _p_a_g_e._n_u_m, _u_s_e_r._d_a_t_a)' the
          ::page-reordered signal is emitted in the notebook right
          after a page has been reordered.  

          Since  2.10

          '_n_o_t_e_b_o_o_k' ['GtkNotebook']  the 'GtkNotebook'

          '_c_h_i_l_d' ['GtkWidget']  the child 'GtkWidget' affected

          '_p_a_g_e._n_u_m' [numeric]  the new page number for 'child'

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


     '_r_e_o_r_d_e_r-_t_a_b(_n_o_t_e_b_o_o_k, _a_r_g_1, _P_a_r_a_m_3, _u_s_e_r._d_a_t_a)' _undocumented _

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

          '_a_r_g_1' ['GtkDirectionType'] 

          '_P_a_r_a_m_3' [logical] 

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


     '_s_e_l_e_c_t-_p_a_g_e(_n_o_t_e_b_o_o_k, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

          '_a_r_g_1' [logical] 

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


     '_s_w_i_t_c_h-_p_a_g_e(_n_o_t_e_b_o_o_k, _p_a_g_e, _p_a_g_e._n_u_m, _u_s_e_r._d_a_t_a)' Emitted when
          the user or a function changes the current page.

          '_n_o_t_e_b_o_o_k' ['GtkNotebook'] the object which received the
               signal.

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

          '_p_a_g_e._n_u_m' [numeric] the index of the page

          '_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:


     '_e_n_a_b_l_e-_p_o_p_u_p' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If TRUE, pressing the
          right mouse button on the notebook pops up a menu that you
          can use to go to a page.  Default value: FALSE


     '_g_r_o_u_p' [_R _o_b_j_e_c_t : _R_e_a_d / _W_r_i_t_e] Group for tabs drag and drop.  

          Since  2.12


     '_g_r_o_u_p-_i_d' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Group ID for tabs drag and
          drop.  Allowed values: >= -1  Default value: -1


     '_h_o_m_o_g_e_n_e_o_u_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether tabs should have
          homogeneous sizes.  Default value: FALSE


     '_p_a_g_e' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The index of the current page. 
          Allowed values: >= 0  Default value: 0


     '_s_c_r_o_l_l_a_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If TRUE, scroll arrows are
          added if there are too many tabs to fit.  Default value:
          FALSE


     '_s_h_o_w-_b_o_r_d_e_r' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the border should
          be shown or not.  Default value: TRUE


     '_s_h_o_w-_t_a_b_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether tabs should be shown
          or not.  Default value: TRUE


     '_t_a_b-_b_o_r_d_e_r' [_n_u_m_e_r_i_c : _W_r_i_t_e] Width of the border around the tab
          labels.  Default value: 2


     '_t_a_b-_h_b_o_r_d_e_r' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] Width of the horizontal
          border of tab labels.  Default value: 2


     '_t_a_b-_p_o_s' ['_G_t_k_P_o_s_i_t_i_o_n_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Which side of the
          notebook holds the tabs.  Default value: GTK_POS_TOP


     '_t_a_b-_v_b_o_r_d_e_r' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] Width of the vertical
          border of tab labels.  Default value: 2


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


     '_a_r_r_o_w-_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] The "arrow-spacing" property
          defines the spacing between the scroll arrows and the tabs.  

          Allowed values: >= 0  Default value: 0  Since  2.10


     '_h_a_s-_b_a_c_k_w_a_r_d-_s_t_e_p_p_e_r' [_l_o_g_i_c_a_l : _R_e_a_d] The "has-backward-stepper"
          property determines whether  the standard backward arrow
          button is displayed.  

          Default value: TRUE  Since  2.4


     '_h_a_s-_f_o_r_w_a_r_d-_s_t_e_p_p_e_r' [_l_o_g_i_c_a_l : _R_e_a_d] The "has-forward-stepper"
          property determines whether  the standard forward arrow
          button is displayed.  

          Default value: TRUE  Since  2.4


     '_h_a_s-_s_e_c_o_n_d_a_r_y-_b_a_c_k_w_a_r_d-_s_t_e_p_p_e_r' [_l_o_g_i_c_a_l : _R_e_a_d] The
          "has-secondary-backward-stepper" property determines whether 
          a second backward arrow button is displayed on the opposite
          end  of the tab area.  

          Default value: FALSE  Since  2.4


     '_h_a_s-_s_e_c_o_n_d_a_r_y-_f_o_r_w_a_r_d-_s_t_e_p_p_e_r' [_l_o_g_i_c_a_l : _R_e_a_d] The
          "has-secondary-forward-stepper" property determines whether 
          a second forward arrow button is displayed on the opposite
          end  of the tab area.  

          Default value: FALSE  Since  2.4


     '_t_a_b-_c_u_r_v_a_t_u_r_e' [_i_n_t_e_g_e_r : _R_e_a_d] The "tab-curvature" property
          defines size of tab curvature.  

          Allowed values: >= 0  Default value: 1  Since  2.10


     '_t_a_b-_o_v_e_r_l_a_p' [_i_n_t_e_g_e_r : _R_e_a_d] The "tab-overlap" property defines
          size of tab overlap area.  

          Default value: 2  Since  2.10


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

