From c00167cb8fdd5325c18f595dc7e9cdea89f49b44 Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Thu, 17 Feb 2011 07:53:50 +0100 Subject: reference: pygtk-gtkcellrenderertoggle.xml: add missing methods --- docs/reference/ChangeLog | 1 + docs/reference/pygtk-gtkcellrenderertoggle.xml | 369 ++++++++++++++----------- 2 files changed, 202 insertions(+), 168 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 4b17e06b..98b34468 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -2,6 +2,7 @@ * pygtk-gtkcelleditable.xml: add missing "editing-canceled" property * pygtk-gtkcellrenderer.xml: add missing property and methods + * pygtk-gtkcellrenderertoggle.xml: add missing methods 2011-01-13 Dieter Verfaillie diff --git a/docs/reference/pygtk-gtkcellrenderertoggle.xml b/docs/reference/pygtk-gtkcellrenderertoggle.xml index bf4ea707..5ebed1eb 100644 --- a/docs/reference/pygtk-gtkcellrenderertoggle.xml +++ b/docs/reference/pygtk-gtkcellrenderertoggle.xml @@ -13,31 +13,34 @@ cell gtk.CellRendererToggle - gtk.CellRenderer + gtk.CellRenderer - gtk.CellRendererToggle - + gtk.CellRendererToggle + + - get_radio - + get_radio + + + + set_radio + radio + + + get_active + + - set_radio - radio + set_active + setting - get_active - + get_activatable + + - set_active - setting + set_activatable + setting @@ -62,47 +65,41 @@ linkend="method-gtkcellrenderertoggle--set-active">set_active - - - - - - - - "activatable" - Read/Write - If True, the toggle button can be - activated - - - - "active" - Read/Write - If True, the button is active. - - - - "inconsistent" - Read/Write - If True, the button is in an - inconsistent state. GTK+ 2.2 and above. - - - - "indicator-size" - Read-Write - Size of check or radio indicator. Allowed values: >= 0. - Default value: 12. - - - - "radio" - Read/Write - If True, draw the toggle button as a - radio button - - - + + + + + + + "activatable" + Read/Write + If True, the toggle button can be activated + + + + "active" + Read/Write + If True, the button is active. + + + + "inconsistent" + Read/Write + If True, the button is in an inconsistent state. GTK+ 2.2 and above. + + + + "indicator-size" + Read-Write + Size of check or radio indicator. Allowed values: >= 0. Default value: 12. + + + + "radio" + Read/Write + If True, draw the toggle button as a radio button + + @@ -118,19 +115,13 @@ linkend="method-gtkcellrenderertoggle--set-active">set_active - "toggled" + "toggled" - callback - cellrenderertoggle - - path - - user_param1 - - ... - + callback + cellrenderertoggle + path + user_param1 + ... @@ -141,10 +132,8 @@ linkend="signal-gtkcellrenderertoggle--toggled">toggled" Description - The gtk.CellRendererToggle - manages the rendering of toggle button into a gtk.TreeView + The gtk.CellRendererToggle + manages the rendering of toggle button into a gtk.TreeView cell. The button is drawn as a radio- or checkbutton, depending on the "radio" property. When activated, it emits the toggled signal. @@ -154,27 +143,28 @@ linkend="signal-gtkcellrenderertoggle--toggled">toggled" Constructor - gtk.CellRendererToggle - + gtk.CellRendererToggle + + + - Returns : - the new cell renderer + Returns : + the new cell renderer - Creates a new gtk.CellRendererToggle. -The toggle button rendering parameters are adjusted using the object -properties. The object properties can be set globally (with set_property()). -Also, with gtk.TreeViewColumn, -you can bind a property to a value in a gtk.TreeModel. -For example, you can bind the "active" property on the cell renderer to a -boolean value in the model, thus causing the check button to reflect the -state of the model. + Creates a new gtk.CellRendererToggle. + The toggle button rendering parameters are adjusted using the object + properties. The object properties can be set globally (with set_property()). + Also, with gtk.TreeViewColumn, + you can bind a property to a value in a gtk.TreeModel. + For example, you can bind the "active" property on the cell renderer to a + boolean value in the model, thus causing the check button to reflect the + state of the model. @@ -185,19 +175,20 @@ state of the model. gtk.CellRendererToggle.get_radio - get_radio - + get_radio + + + - - Returns : - True if we're rendering -radio toggles rather than checkboxes - + + Returns : + True if we're rendering radio toggles rather than checkboxes + The get_radio() method returns -True if radio toggles rather than checkboxes are being -rendered. + True if radio toggles rather than checkboxes are being + rendered. @@ -205,29 +196,28 @@ rendered. gtk.CellRendererToggle.set_radio - set_radio - radio - + set_radio + radio + + - - radio : - If True make the toggle look -like a radio button - + + radio : + If True make the toggle look like a radio button + The set_radio() method sets the style -of the toggle button. If radio is -True, the cell renderer renders a radio toggle (i.e. a -toggle in a group of mutually-exclusive toggles). If -False, it renders a check toggle (a standalone boolean -option). This can be set globally for the cell renderer, or changed just -before rendering each cell in the model (for gtk.TreeView, you -set up a per-row setting using gtk.TreeViewColumn -to associate model columns with cell renderer properties). + of the toggle button. If radio is + True, the cell renderer renders a radio toggle (i.e. a + toggle in a group of mutually-exclusive toggles). If + False, it renders a check toggle (a standalone boolean + option). This can be set globally for the cell renderer, or changed just + before rendering each cell in the model (for gtk.TreeView, you + set up a per-row setting using gtk.TreeViewColumn + to associate model columns with cell renderer properties). @@ -235,19 +225,20 @@ to associate model columns with cell renderer properties). gtk.CellRendererToggle.get_active - get_active - + get_active + + + - - Returns : - True if the cell renderer is -active. - + + Returns : + True if the cell renderer is active. + The get_active() method returns -True if the cell renderer is active. See gtk.CellRendererToggle.set_active(). + True if the cell renderer is active. See gtk.CellRendererToggle.set_active(). @@ -255,21 +246,69 @@ linkend="method-gtkcellrenderertoggle--set-active">gtk.CellRendererTog gtk.CellRendererToggle.set_active - set_active - setting - + set_active + setting + + - - setting : - the value to set. - + + setting : + the value to set. + The set_active() method activates a -cell renderer if setting is True -and or deactivates a cell renderer if setting is -False. + cell renderer if setting is True + and or deactivates a cell renderer if setting is + False. + + + + + gtk.CellRendererToggle.get_activatable + + + get_activatable + + + + + + Returns : + True if the cell renderer is activatable. + + + + + This method is available in PyGTK 2.22 and above. + + + The get_activatable() method returns + True if the cell renderer is activatable. + + + + + gtk.CellRendererToggle.set_activatable + + + set_activatable + setting + + + + + setting : + the value to set. + + + + + This method is available in PyGTK 2.22 and above. + + + The set_activatable() method sets wether + the cell renderer is activatable. @@ -282,36 +321,30 @@ and or deactivates a cell renderer if setting is The "toggled" gtk.CellRendererToggle Signal - callback - cellrenderertoggle - path - user_param1 - ... - + callback + cellrenderertoggle + path + user_param1 + ... + - - cellrenderertoggle : - the cellrenderertoggle that received the -"toggled" signal - - - path : - the path of the cellrenderertoggle represented - as a string - - - user_param1 : - the first user parameter (if any) specified -with the connect() -method - - - ... : - additional user parameters (if -any) - + + cellrenderertoggle : + the cellrenderertoggle that received the "toggled" signal + + + path : + the path of the cellrenderertoggle represented as a string + + + user_param1 : + the first user parameter (if any) specified with the connect() method + + + ... : + additional user parameters (if any) + The "toggled" signal is emitted when the toggle button in the -- cgit v1.2.1