From f835813c6b5f7824e3f1c2a84e9ecf0d2f09ea5f Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Tue, 15 Mar 2011 15:54:30 +0100 Subject: reference: pygtk-gtkinfobar.xml: add purpose, interfaces, properties and signals + update methods --- docs/reference/pygtk-gtkinfobar.xml | 288 +++++++++++++++++++++++++++++++++--- 1 file changed, 269 insertions(+), 19 deletions(-) (limited to 'docs') diff --git a/docs/reference/pygtk-gtkinfobar.xml b/docs/reference/pygtk-gtkinfobar.xml index 63eb216a..15cfbc03 100644 --- a/docs/reference/pygtk-gtkinfobar.xml +++ b/docs/reference/pygtk-gtkinfobar.xml @@ -5,7 +5,7 @@ gtk.InfoBar - + report important messages to the user (new in PyGTK 2.22) @@ -79,6 +79,152 @@ + + + Implemented Interfaces + + gtk.InfoBar + implements + gtk.Buildable + atk.ImplementorIFace + + + + + gtk.InfoBar Properties + + gtk.Object Properties + gtk.Widget Properties + gtk.Container Properties + gtk.Box Properties + +
+ + + + + + + + "message-type" + Read-Write-Construct + The type of the message. + The type is used to determine the colors to use in the info bar. The following + symbolic color names can by used to customize these colors: "info_fg_color", + "info_bg_color", "warning_fg_color", "warning_bg_color", "question_fg_color", + "question_bg_color", "error_fg_color", "error_bg_color". "other_fg_color", "other_bg_color". + If the type is gtk.MESSAGE_OTHER, no info bar is painted but the colors are still set. + Default value: gtk.MESSAGE_INFO + This property is available in GTK+ 2.18 and above. + + + + +
+ + + + + gtk.InfoBar Style Properties + + gtk.Widget Style Properties + +
+ + + + + + + + "action-area-border" + Read + Width of the border around the action area of the info bar. + Allowed values: >= 0 + Default value: 5 + This property is available in GTK+ 2.18 and above. + + + "button-spacing" + Read + Spacing between buttons in the action area of the info bar. + Allowed values: >=0 + Default value: 6 + This property is available in GTK+ 2.18 and above. + + + "content-area-border" + Read + The width of the border around the content content area of the info bar. + Allowed values: >=0 + Default value: 8 + This property is available in GTK+ 2.18 and above. + + + "content-area-spacing" + Read + The default spacing used between elements of the content area of the info bar. + Allowed values: >=0 + Default value: 16 + This property is available in GTK+ 2.18 and above. + + + + +
+ + + + + gtk.InfoBar Signal Prototypes + + gobject.GObject Signal Prototypes + gtk.Object Signal Prototypes + gtk.Widget Signal Prototypes + gtk.Container Signal Prototypes + + + + "close" + + callback + infobar + user_param1 + ... + + + + + "response" + + callback + infobar + response_id + user_param1 + ... + + + + + + + + + Description + + + This widget is available in PyGTK 2.22 and above. + + + gtk.InfoBar + is a widget that can be used to show messages to the user without showing a dialog. + It is often temporarily shown at the top or bottom of a document. In contrast to + gtk.Dialog, which has + a horizontal action area at the bottom, + gtk.InfoBar has a vertical + action area at the side. + + Constructor @@ -94,13 +240,13 @@ a new gtk.InfoBar object + This constructor is available in PyGTK 2.22 and above. Creates a new gtk.InfoBar object. - @@ -121,11 +267,13 @@ the action area + This method is available in PyGTK 2.22 and above. - The get_action_area() method returns the action area of info_bar. + The get_action_area() method returns the action area of the infobar. + @@ -143,11 +291,13 @@ the content area + This method is available in PyGTK 2.22 and above. - The get_content_area() method returns the content area of info_bar. + The get_content_area() method returns the content area of the infobar. + @@ -170,14 +320,18 @@ response ID for child + This method is available in PyGTK 2.22 and above. - Add an activatable widget to the action area of a gtk.InfoBar, -connecting a signal handler that will emit the gtk.InfoBar::response + Add an activatable widget to the action area of a +gtk.InfoBar, +connecting a signal handler that will emit the +gtk.InfoBar::response signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area. + @@ -204,6 +358,7 @@ is appended to the end of the message areas action area. the button widget that was added + This method is available in PyGTK 2.22 and above. @@ -213,6 +368,7 @@ is a stock ID) and sets things up so that clicking the button will emit the "response" signal with the given response_id. The button is appended to the end of the info bars's action area. The button widget is returned, but usually you don't need it. + @@ -222,6 +378,8 @@ returned, but usually you don't need it. add_buttons first_button_text + first_response_id + ... @@ -229,15 +387,20 @@ returned, but usually you don't need it. first_button_text : button text or stock ID + + first_response_id : + response ID for the button + + This method is available in PyGTK 2.22 and above. - Adds more buttons, same as calling gtk.InfoBar.add_button -repeatedly. The variable argument list should be NULL-terminated -as with gtk_info_bar_new_with_buttons(). Each button must have both -text and response ID. + Adds more buttons, same as calling +add_button() +repeatedly. Each button must have both text and response ID. + @@ -260,13 +423,15 @@ text and response ID. TRUE for sensitive + This method is available in PyGTK 2.22 and above. - Calls gtk_widget_set_sensitive (widget, setting) for each -widget in the info bars's action area with the given response_id. + Calls gtk.Widget.set_sensitive() +for each widget in the info bars's action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons. + @@ -289,13 +454,15 @@ A convenient way to sensitize/desensitize dialog buttons. This method is available in PyGTK 2.22 and above. - The set_default_response() method sets the last widget in the info bar's action area with + The set_default_response() method +sets the last widget in the info bar's action area with the given response_id as the default widget for the dialog. Pressing "Enter" normally activates the default widget. - -Note that this function currently requires info_bar to + + Note that this function currently requires the infobar to be added to a widget hierarchy. + @@ -313,11 +480,13 @@ be added to a widget hierarchy. a response ID + This method is available in PyGTK 2.22 and above. Emits the 'response' signal with the given response_id. + @@ -335,13 +504,15 @@ be added to a widget hierarchy. a GtkMessageType + This method is available in PyGTK 2.22 and above. - The set_message_type() method sets the message type of the message area. -GTK+ uses this type to determine what color to use -when drawing the message area. + The set_message_type() method sets +the message type of the message area. GTK+ uses this type to determine what +color to use when drawing the message area. + @@ -363,9 +534,88 @@ when drawing the message area. This method is available in PyGTK 2.22 and above. - The get_message_type() method returns the message type of the message area. + The get_message_type() method returns + the message type of the message area. + + Signals + + + The "close" gtk.InfoBar Signal + + + callback + infobar + user_param1 + ... + + + + + infobar : + the infobar that received the signal + + + 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.18 and above. + + + The "close" signal keybinding signal which gets emitted when the user + uses a keybinding to dismiss the info bar. The default binding for this signal + is the Escape key. + + + + + The "response" gtk.InfoBar Signal + + + callback + infobar + response_id + user_param1 + ... + + + + + infobar : + the infobar that received the signal + + + response_id : + the response ID + + + 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.18 and above. + + + The "response" signal is emitted when an action widget is clicked or the + application programmer calls response(). + The response_id depends on which action widget was clicked. + + + -- cgit v1.2.1