=head1 NAME

Gtk2::Notebook

=head1 HIERARCHY

  Glib::Object
  +----Gtk2::Object
        +----Gtk2::Widget
              +----Gtk2::Container
                    +----Gtk2::Notebook

=head1 INTERFACES

  Gtk2::Atk::ImplementorIface


=head1 METHODS

=head2 widget = Gtk2::Notebook-E<gt>B<new> 

=over

=back

=head2 integer = $notebook-E<gt>B<append_page> ($child, $tab_label=undef)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (scalar) 

=back

=back

=head2 integer = $notebook-E<gt>B<append_page_menu> ($child, $tab_label, $menu_label)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (Gtk2::Widget or undef) 

=item * $menu_label (Gtk2::Widget or undef) 

=back

=back

=head2 integer = $notebook-E<gt>B<get_current_page> 

=over

=back

=head2 $notebook-E<gt>B<set_current_page> ($page_num)

=over

=over

=item * $page_num (integer) 

=back

=back

=head2 integer = $notebook-E<gt>B<insert_page> ($child, $tab_label, $position)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (scalar) 

=item * $position (integer) 

=back

=back

=head2 integer = $notebook-E<gt>B<insert_page_menu> ($child, $tab_label, $menu_label, $position)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (Gtk2::Widget or undef) 

=item * $menu_label (Gtk2::Widget or undef) 

=item * $position (integer) 

=back

=back

=head2 widget or undef = $notebook-E<gt>B<get_menu_label> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<set_menu_label> ($child, $menu_label=undef)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $menu_label (Gtk2::Widget or undef) 

=back

=back

=head2 string = $notebook-E<gt>B<get_menu_label_text> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<set_menu_label_text> ($child, $menu_text)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $menu_text (string) 

=back

=back

=head2 integer = $notebook-E<gt>B<get_n_pages> 

=over

=back

=head2 $notebook-E<gt>B<next_page> 

=over

=back

=head2 widget or undef = $notebook-E<gt>B<get_nth_page> ($page_num)

=over

=over

=item * $page_num (integer) 

=back

=back

=head2 integer = $notebook-E<gt>B<page_num> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<popup_disable> 

=over

=back

=head2 $notebook-E<gt>B<popup_enable> 

=over

=back

=head2 integer = $notebook-E<gt>B<prepend_page> ($child, $tab_label=undef)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (scalar) 

=back

=back

=head2 integer = $notebook-E<gt>B<prepend_page_menu> ($child, $tab_label, $menu_label)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (Gtk2::Widget or undef) 

=item * $menu_label (Gtk2::Widget or undef) 

=back

=back

=head2 $notebook-E<gt>B<prev_page> 

=over

=back

=head2 (expand, fill, pack_type) = $notebook-E<gt>B<query_tab_label_packing> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<remove_page> ($page_num)

=over

=over

=item * $page_num (integer) 

=back

=back

=head2 $notebook-E<gt>B<reorder_child> ($child, $position)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $position (integer) 

=back

=back

=head2 boolean = $notebook-E<gt>B<get_scrollable> 

=over

=back

=head2 $notebook-E<gt>B<set_scrollable> ($scrollable)

=over

=over

=item * $scrollable (boolean) 

=back

=back

=head2 boolean = $notebook-E<gt>B<get_show_border> 

=over

=back

=head2 $notebook-E<gt>B<set_show_border> ($show_border)

=over

=over

=item * $show_border (boolean) 

=back

=back

=head2 boolean = $notebook-E<gt>B<get_show_tabs> 

=over

=back

=head2 $notebook-E<gt>B<set_show_tabs> ($show_tabs)

=over

=over

=item * $show_tabs (boolean) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_border> ($border_width)

=over

=over

=item * $border_width (integer) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_hborder> ($tab_hborder)

=over

=over

=item * $tab_hborder (integer) 

=back

=back

=head2 widget = $notebook-E<gt>B<get_tab_label> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_label_packing> ($child, $expand, $fill, $pack_type)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $expand (boolean) 

=item * $fill (boolean) 

=item * $pack_type (Gtk2::PackType) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_label> ($child, $tab_label=undef)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_label (Gtk2::Widget or undef) 

=back

=back

=head2 string = $notebook-E<gt>B<get_tab_label_text> ($child)

=over

=over

=item * $child (Gtk2::Widget) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_label_text> ($child, $tab_text)

=over

=over

=item * $child (Gtk2::Widget) 

=item * $tab_text (string) 

=back

=back

=head2 positiontype = $notebook-E<gt>B<get_tab_pos> 

=over

=back

=head2 $notebook-E<gt>B<set_tab_pos> ($pos)

=over

=over

=item * $pos (Gtk2::PositionType) 

=back

=back

=head2 $notebook-E<gt>B<set_tab_vborder> ($tab_vborder)

=over

=over

=item * $tab_vborder (integer) 

=back

=back


=head1 PROPERTIES

=over

=item 'enable-popup' (boolean : readable / writable)

If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page

=item 'homogeneous' (boolean : readable / writable)

Whether tabs should have homogeneous sizes

=item 'page' (integer : readable / writable)

The index of the current page

=item 'scrollable' (boolean : readable / writable)

If TRUE, scroll arrows are added if there are too many tabs to fit

=item 'show-border' (boolean : readable / writable)

Whether the border should be shown or not

=item 'show-tabs' (boolean : readable / writable)

Whether tabs should be shown or not

=item 'tab-border' (Glib::UInt : writable)

Width of the border around the tab labels

=item 'tab-hborder' (Glib::UInt : readable / writable)

Width of the horizontal border of tab labels

=item 'tab-pos' (Gtk2::PositionType : readable / writable)

Which side of the notebook holds the tabs

=item 'tab-vborder' (Glib::UInt : readable / writable)

Width of the vertical border of tab labels

=back


=head1 SIGNALS

=over

=item B<switch-page> (Gtk2::Notebook, gpointer, Glib::UInt)

=item boolean = B<focus-tab> (Gtk2::Notebook, Gtk2::NotebookTab)

=item boolean = B<select-page> (Gtk2::Notebook, boolean)

=item B<change-current-page> (Gtk2::Notebook, integer)

=item B<move-focus-out> (Gtk2::Notebook, Gtk2::DirectionType)

=back


=head1 ENUMS AND FLAGS

=head2 flags Gtk2::Gdk::EventMask

=over

=item * 'exposure-mask' / 'GDK_EXPOSURE_MASK'

=item * 'pointer-motion-mask' / 'GDK_POINTER_MOTION_MASK'

=item * 'pointer-motion-hint-mask' / 'GDK_POINTER_MOTION_HINT_MASK'

=item * 'button-motion-mask' / 'GDK_BUTTON_MOTION_MASK'

=item * 'button1-motion-mask' / 'GDK_BUTTON1_MOTION_MASK'

=item * 'button2-motion-mask' / 'GDK_BUTTON2_MOTION_MASK'

=item * 'button3-motion-mask' / 'GDK_BUTTON3_MOTION_MASK'

=item * 'button-press-mask' / 'GDK_BUTTON_PRESS_MASK'

=item * 'button-release-mask' / 'GDK_BUTTON_RELEASE_MASK'

=item * 'key-press-mask' / 'GDK_KEY_PRESS_MASK'

=item * 'key-release-mask' / 'GDK_KEY_RELEASE_MASK'

=item * 'enter-notify-mask' / 'GDK_ENTER_NOTIFY_MASK'

=item * 'leave-notify-mask' / 'GDK_LEAVE_NOTIFY_MASK'

=item * 'focus-change-mask' / 'GDK_FOCUS_CHANGE_MASK'

=item * 'structure-mask' / 'GDK_STRUCTURE_MASK'

=item * 'property-change-mask' / 'GDK_PROPERTY_CHANGE_MASK'

=item * 'visibility-notify-mask' / 'GDK_VISIBILITY_NOTIFY_MASK'

=item * 'proximity-in-mask' / 'GDK_PROXIMITY_IN_MASK'

=item * 'proximity-out-mask' / 'GDK_PROXIMITY_OUT_MASK'

=item * 'substructure-mask' / 'GDK_SUBSTRUCTURE_MASK'

=item * 'scroll-mask' / 'GDK_SCROLL_MASK'

=item * 'all-events-mask' / 'GDK_ALL_EVENTS_MASK'

=back



=head1 SEE ALSO

L<Gtk2>, L<Glib::Object>, L<Gtk2::Object>, L<Gtk2::Widget>, L<Gtk2::Container>

=head1 COPYRIGHT

Copyright (C) 2003-2005 by the gtk2-perl team.

This software is licensed under the LGPL.  See L<Gtk2> for a full notice.


=cut

