From 104b7c66947eea718ecde4c562c44eb995a3a054 Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Wed, 16 Mar 2011 13:43:58 +0100 Subject: reference: pygtk-gtktoolpalette.xml: add purpose, interfaces, properties and signals + update methods --- docs/reference/pygtk-gtktoolpalette.xml | 279 ++++++++++++++++++++++++++++---- 1 file changed, 247 insertions(+), 32 deletions(-) diff --git a/docs/reference/pygtk-gtktoolpalette.xml b/docs/reference/pygtk-gtktoolpalette.xml index 96da38e3..1b718c78 100644 --- a/docs/reference/pygtk-gtktoolpalette.xml +++ b/docs/reference/pygtk-gtktoolpalette.xml @@ -5,7 +5,7 @@ gtk.ToolPalette - + a tool palette with categories (new in PyGTK 2.22) @@ -118,6 +118,135 @@ + + Implemented Interfaces + + gtk.ToolPalette + implements + atk.ImplementorIFace, + gtk.Buildable, + + + + + gtk.ToolPalette Properties + + gtk.Object Properties + gtk.Widget Properties + gtk.Container Properties + +
+ + + + + + + + "icon-size" + Read-Write + Whether the group has been collapsed and items are hidden. + Default value: False. + This property is available in GTK+ 2.20 and above. + + + "icon-size-set" + Read-Write + Ellipsize for item group headers. + Default value: pango.ELLIPSIZE_NONE. + This property is available in GTK+ 2.20 and above. + + + "toolbar-style" + Read-Write + Relief of the group header button. + Default value: gtk.RELIEF_NORMAL. + This property is available in GTK+ 2.20 and above. + + + + +
+ + + + + gtk.ToolPalette Child Properties + +
+ + + + + + + + "exclusive" + Read-Write + Whether the item should receive extra space when the group grows. + Default value: False. + This property is available in GTK+ 2.20 and above. + + + "expand" + Read-Write + Whether the item should fill the available space. + Default value: True. + This property is available in GTK+ 2.20 and above. + + + + +
+ + + + + gtk.ToolPalette Style Properties + + gtk.Widget Style Properties + + + + + gtk.ToolPalette Signal Prototypes + + gobject.GObject Signal Prototypes + gtk.Object Signal Prototypes + gtk.Widget Signal Prototypes + gtk.Container Signal Prototypes + + + + "set-scroll-adjustments" + + callback + toolpalette + hadjustment + vadjustment + user_param1 + ... + + + + + + + + + Description + + + This widget is available in PyGTK 2.22 and above. + + + A gtk.ToolPalette + is used together with gtk.ToolPalette + to add gtk.ToolItem objects to + a palette like container with different categories and drag and drop support. + + + Constructor @@ -133,13 +262,13 @@ a new gtk.ToolPalette + This constructor is available in PyGTK 2.22 and above. Creates a new tool palette. - @@ -158,20 +287,22 @@ group : - a gtk.ToolItemGroup which is a child of palette + a gtk.ToolPalette which is a child of palette position : a new index for group + This method is available in PyGTK 2.22 and above. The set_group_position() method sets the position of the group as an index of the tool palette. -If position is 0 the group will become the first child, if position is --1 it will become the last child. + If position is 0 the group will become the first child, if position is + -1 it will become the last child. + @@ -187,19 +318,21 @@ If position is 0 the group will become the first child, if position is group : - a gtk.ToolItemGroup which is a child of palette + a gtk.ToolPalette which is a child of palette exclusive : whether the group should be exclusive or not + This method is available in PyGTK 2.22 and above. Sets whether the group should be exclusive or not. -If an exclusive group is expanded all other groups are collapsed. + If an exclusive group is expanded all other groups are collapsed. + @@ -215,18 +348,20 @@ If an exclusive group is expanded all other groups are collapsed. group : - a gtk.ToolItemGroup which is a child of palette + a gtk.ToolPalette which is a child of palette expand : whether the group should be given extra space + This method is available in PyGTK 2.22 and above. Sets whether the group should be given extra space. + @@ -241,19 +376,21 @@ If an exclusive group is expanded all other groups are collapsed. group : - a gtk.ToolItemGroup + a gtk.ToolPalette Returns : the index of group or -1 if group is not a child of palette + This method is available in PyGTK 2.22 and above. Gets the position of group in palette as index. -See gtk.ToolPalette.set_group_position. + See gtk.ToolPalette.set_group_position. + @@ -268,19 +405,21 @@ See gtk.To group : - a gtk.ToolItemGroup which is a child of palette + a gtk.ToolPalette which is a child of palette Returns : - TRUE if group is exclusive + True if group is exclusive + This method is available in PyGTK 2.22 and above. Gets whether group is exclusive or not. -See gtk.ToolPalette.set_exclusive. + See gtk.ToolPalette.set_exclusive. + @@ -295,19 +434,21 @@ See gtk.ToolPal group : - a gtk.ToolItemGroup which is a child of palette + a gtk.ToolPalette which is a child of palette Returns : - TRUE if group should be given extra space, FALSE otherwise + True if group should be given extra space, False otherwise + This method is available in PyGTK 2.22 and above. Gets whether group should be given extra space. -See gtk.ToolPalette.set_expand. + See gtk.ToolPalette.set_expand. + @@ -322,14 +463,16 @@ See gtk.ToolPalett icon_size : - the GtkIconSize that icons in the tool palette shall have + one of the that icons in the tool palette shall have + This method is available in PyGTK 2.22 and above. The set_icon_size() method sets the size of icons in the tool palette. + @@ -341,12 +484,14 @@ See gtk.ToolPalett + This method is available in PyGTK 2.22 and above. Unsets the tool palette icon size set with gtk.ToolPalette.set_icon_size, -so that user preferences will be used to determine the icon size. + so that user preferences will be used to determine the icon size. + @@ -361,14 +506,16 @@ so that user preferences will be used to determine the icon size. style : - the GtkToolbarStyle that items in the tool palette shall have + one of the that items in the tool palette shall have + This method is available in PyGTK 2.22 and above. The set_style() method sets the style (text, icons or both) of items in the tool palette. + @@ -380,12 +527,14 @@ so that user preferences will be used to determine the icon size. + This method is available in PyGTK 2.22 and above. Unsets a toolbar style set with gtk.ToolPalette.set_style, -so that user preferences will be used to determine the toolbar style. + so that user preferences will be used to determine the toolbar style. + @@ -400,15 +549,17 @@ so that user preferences will be used to determine the toolbar style. Returns : - the GtkIconSize of icons in the tool palette + one of the + This method is available in PyGTK 2.22 and above. Gets the size of icons in the tool palette. -See gtk.ToolPalette.set_icon_size. + See gtk.ToolPalette.set_icon_size. + @@ -423,14 +574,16 @@ See gtk.ToolPal Returns : - the GtkToolbarStyle of items in the tool palette. + one of the + This method is available in PyGTK 2.22 and above. Gets the style (icons, text or both) of items in the tool palette. + @@ -454,15 +607,17 @@ See gtk.ToolPal Returns : - the gtk.ToolItem at position or NULL if there is no such item + the gtk.ToolItem at position or None if there is no such item + This method is available in PyGTK 2.22 and above. Gets the item at position (x, y). -See gtk.ToolPalette.get_drop_group. + See gtk.ToolPalette.get_drop_group. + @@ -486,14 +641,16 @@ See gtk.ToolPa Returns : - the gtk.ToolItemGroup at position or NULL if there is no such group + the gtk.ToolPalette at position or None if there is no such group + This method is available in PyGTK 2.22 and above. Gets the group at position (x, y). + @@ -515,12 +672,14 @@ See gtk.ToolPa the dragged item in selection + This method is available in PyGTK 2.22 and above. Get the dragged item from the selection. -This could be a gtk.ToolItem or a gtk.ToolItemGroup. + This could be a gtk.ToolItem or a gtk.ToolPalette. + @@ -538,14 +697,16 @@ This could be a gtk.ToolItemthe GtkToolPaletteDragTargets which the widget should support + This method is available in PyGTK 2.22 and above. The set_drag_source() method sets the tool palette as a drag source. -Enables all groups and items in the tool palette as drag sources -on button 1 and button 3 press with copy and move actions. -See gtk.Widget.drag_source_set. + Enables all groups and items in the tool palette as drag sources + on button 1 and button 3 press with copy and move actions. + See gtk.Widget.drag_source_set. + @@ -578,13 +739,15 @@ See gtk.Widget.dra the GdkDragActions which the widget should suppport + This method is available in PyGTK 2.22 and above. Sets palette as drag source (see gtk.ToolPalette.set_drag_source) -and sets widget as a drag destination for drags from palette. -See gtk.Widget.drag_dest_set. + and sets widget as a drag destination for drags from palette. + See gtk.Widget.drag_dest_set. + @@ -602,11 +765,13 @@ See gtk.Widget.drag_ the horizontal adjustment of palette + This method is available in PyGTK 2.22 and above. Gets the horizontal adjustment of the tool palette. + @@ -624,13 +789,63 @@ See gtk.Widget.drag_ the vertical adjustment of palette + This method is available in PyGTK 2.22 and above. Gets the vertical adjustment of the tool palette. + + + Signals + + + The "set-scroll-adjustments" gtk.ToolPalette Signal + + + callback + toolpalette + hadjustment + vadjustment + user_param1 + ... + + + + + toolpalette : + the toolpalette that received the signal + + + hadjustment : + the horizontal adjustment + + + vadjustment : + the vertical adjustment + + + user_param1 : + the first user parameter (if any) specified with the connect() method + + + ... : + additional user parameters (if any) + + + + + This signal is available in GTK+ 2.20 and above. + + + The "set-scroll-adjustments" signal is emitted when one or both + adjustments (specified by hadjustment and + vadjustment) are set on textview. + + + -- cgit v1.2.1