home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Bonobo / Dock.pod next >
Encoding:
Text File  |  2006-06-19  |  2.4 KB  |  186 lines

  1. =head1 NAME
  2.  
  3. Gnome2::Bonobo::Dock
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Glib::Object::_Unregistered::GInitiallyUnowned
  9.        +----Gtk2::Object
  10.             +----Gtk2::Widget
  11.                  +----Gtk2::Container
  12.                       +----Gnome2::Bonobo::Dock
  13.  
  14. =head1 INTERFACES
  15.  
  16.   Gtk2::Atk::ImplementorIface
  17.  
  18.  
  19. =head1 METHODS
  20.  
  21. =head2 widget = Gnome2::Bonobo::Dock-E<gt>B<new> 
  22.  
  23. =over
  24.  
  25. =back
  26.  
  27. =head2 $dock-E<gt>B<add_floating_item> ($widget, $x, $y, $orientation)
  28.  
  29. =over
  30.  
  31. =over
  32.  
  33. =item * $widget (Gnome2::Bonobo::DockItem) 
  34.  
  35. =item * $x (integer) 
  36.  
  37. =item * $y (integer) 
  38.  
  39. =item * $orientation (Gtk2::Orientation) 
  40.  
  41. =back
  42.  
  43. =back
  44.  
  45. =head2 boolean = $dock-E<gt>B<add_from_layout> ($layout)
  46.  
  47. =over
  48.  
  49. =over
  50.  
  51. =item * $layout (Gnome2::Bonobo::DockLayout) 
  52.  
  53. =back
  54.  
  55. =back
  56.  
  57. =head2 $dock-E<gt>B<add_item> ($item, $placement, $band_num, $position, $offset, $in_new_band)
  58.  
  59. =over
  60.  
  61. =over
  62.  
  63. =item * $item (Gnome2::Bonobo::DockItem) 
  64.  
  65. =item * $placement (Gnome2::Bonobo::DockPlacement) 
  66.  
  67. =item * $band_num (integer) 
  68.  
  69. =item * $position (integer) 
  70.  
  71. =item * $offset (integer) 
  72.  
  73. =item * $in_new_band (boolean) 
  74.  
  75. =back
  76.  
  77. =back
  78.  
  79. =head2 $dock-E<gt>B<allow_floating_items> ($enable)
  80.  
  81. =over
  82.  
  83. =over
  84.  
  85. =item * $enable (boolean) 
  86.  
  87. =back
  88.  
  89. =back
  90.  
  91. =head2 widget = $dock-E<gt>B<get_client_area> 
  92.  
  93. =over
  94.  
  95. =back
  96.  
  97. =head2 $dock-E<gt>B<set_client_area> ($widget)
  98.  
  99. =over
  100.  
  101. =over
  102.  
  103. =item * $widget (Gtk2::Widget) 
  104.  
  105. =back
  106.  
  107. =back
  108.  
  109. =head2 list = $dock-E<gt>B<get_item_by_name> ($name)
  110.  
  111. =over
  112.  
  113. =over
  114.  
  115. =item * $name (string) 
  116.  
  117. =back
  118.  
  119.  
  120. Returns a BonoboDockItem, a BonoboDockPlacement and three unsigned integers
  121. correspoding to num_band, band_position and offset.
  122.  
  123.  
  124. =back
  125.  
  126. =head2 docklayout = $dock-E<gt>B<get_layout> 
  127.  
  128. =over
  129.  
  130. =back
  131.  
  132.  
  133. =head1 SIGNALS
  134.  
  135. =over
  136.  
  137. =item B<layout-changed> (Gnome2::Bonobo::Dock)
  138.  
  139. =back
  140.  
  141.  
  142. =head1 ENUMS AND FLAGS
  143.  
  144. =head2 enum Gnome2::Bonobo::DockPlacement
  145.  
  146. =over
  147.  
  148. =item * 'top' / 'BONOBO_DOCK_TOP'
  149.  
  150. =item * 'right' / 'BONOBO_DOCK_RIGHT'
  151.  
  152. =item * 'bottom' / 'BONOBO_DOCK_BOTTOM'
  153.  
  154. =item * 'left' / 'BONOBO_DOCK_LEFT'
  155.  
  156. =item * 'floating' / 'BONOBO_DOCK_FLOATING'
  157.  
  158. =back
  159.  
  160.  
  161. =head2 enum Gtk2::Orientation
  162.  
  163. =over
  164.  
  165. =item * 'horizontal' / 'GTK_ORIENTATION_HORIZONTAL'
  166.  
  167. =item * 'vertical' / 'GTK_ORIENTATION_VERTICAL'
  168.  
  169. =back
  170.  
  171.  
  172.  
  173. =head1 SEE ALSO
  174.  
  175. L<Gnome2>, L<Glib::Object>, L<Glib::Object::_Unregistered::GInitiallyUnowned>, L<Gtk2::Object>, L<Gtk2::Widget>, L<Gtk2::Container>
  176.  
  177. =head1 COPYRIGHT
  178.  
  179. Copyright (C) 2003-2004 by the gtk2-perl team.
  180.  
  181. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  182.  
  183.  
  184. =cut
  185.  
  186.