From bf116658a871f088c26d652087f26be87285a3d0 Mon Sep 17 00:00:00 2001 From: Vincent Geddes Date: Fri, 13 Jul 2007 13:33:38 +0000 Subject: bindings/python/docs: added documentation for gladeui.Inspector svn path=/branches/BINDINGS/; revision=1474 --- bindings/python/docs/Makefile.am | 15 +- bindings/python/docs/pygladeui-classes.xml | 9 +- bindings/python/docs/pygladeui-inspector.xml | 206 ++++++++++++++++++++++ bindings/python/docs/pygladeui-introduction.xml | 224 ------------------------ bindings/python/docs/pygladeui.xml | 4 +- 5 files changed, 225 insertions(+), 233 deletions(-) create mode 100644 bindings/python/docs/pygladeui-inspector.xml delete mode 100644 bindings/python/docs/pygladeui-introduction.xml diff --git a/bindings/python/docs/Makefile.am b/bindings/python/docs/Makefile.am index 5ce36f7d..c4791b85 100644 --- a/bindings/python/docs/Makefile.am +++ b/bindings/python/docs/Makefile.am @@ -7,15 +7,16 @@ HTML_STYLE = $(PYGOBJECT_DATADIR)/pygobject/xsl/ref-html-style.xsl XMLFILES = \ pygladeui.xml \ - pygladeui-introduction.xml \ - pygladeui-classes.xml + pygladeui-classes.xml \ + pygladeui-inspector.xml -HTML_FILES = \ - html/index.html \ - html/index.sgml \ - html/pygladeui.devhelp \ - html/pygladeui-introduction.html +HTML_FILES = \ + html/index.html \ + html/index.sgml \ + html/pygladeui.devhelp \ + html/gladeui-class-reference \ + html/class-inspector.html CSS_FILES = $(PYGOBJECT_PYGDOCS)/style.css diff --git a/bindings/python/docs/pygladeui-classes.xml b/bindings/python/docs/pygladeui-classes.xml index 8b137891..b49e895a 100644 --- a/bindings/python/docs/pygladeui-classes.xml +++ b/bindings/python/docs/pygladeui-classes.xml @@ -1 +1,8 @@ - + + + + The gladeui Class Reference + + + diff --git a/bindings/python/docs/pygladeui-inspector.xml b/bindings/python/docs/pygladeui-inspector.xml new file mode 100644 index 00000000..00ae656a --- /dev/null +++ b/bindings/python/docs/pygladeui-inspector.xml @@ -0,0 +1,206 @@ + + + + + gladeui.Inspector + A widget for inspecting objects in a project + + + Synopsis + + gladeui.Inspector + gtk.VBox + + gladeui.Inspector + + + + get_project + + + + set_project + project + + + get_selected_items + + + + +Functions + +gladeui.inspector_new_with_project +project + + + + + Ancestry ++-- gobject.GObject + +-- gtk.Object + +-- gtk.Widget + +-- gtk.Container + +-- gtk.Box + +-- gtk.VBox + +-- gladeui.Inspector + + + +
+ + + + + + + + + "project" + Read-Write + The project being inspected. + + + + +
+ + + + gladeui.Inspector Signal Prototypes + + + "item-activated" + + callback + inspector + user_param1 + ... + + + + + "selection-changed" + + callback + inspector + user_param1 + ... + + + + + + + + Description + A gladeui.Inspector + is a widget for inspecting the objects that make up a user interface design. + + + + + Constructor + + + gladeui.Inspector + + + + + Returns : + a new gladeui.Inspector widget. + + + Creates a new inspector. + + + + Methods + + + + gladeui.Inspector.get_project + + + get_project + + + + + Returns : + The project being inspected. + + + + The get_project() gets the current + project being inspected. + + + + + gladeui.Inspector.set_project + + + set_project + project + + + + project : + project to inspect or None. + + + + The set_project() method sets the +"project" property to the value of project. + + + + gladeui.Inspector.get_selected_items + + + get_selected_items + + + + + Returns : + A list of items in the current selection. + + + + The get_selected_items() gets the list of items + in the current selection. This is useful for getting the last item which was activated + by the user + + + + + + + Functions + + + gladeui.inspector_new_with_project + + + gladeui.inspector_new_with_project + project + + + + + + project : + a gladeui.Project + + + + This is a convenience function to initialize a new inspector with a project. + + + + + diff --git a/bindings/python/docs/pygladeui-introduction.xml b/bindings/python/docs/pygladeui-introduction.xml deleted file mode 100644 index d5888f77..00000000 --- a/bindings/python/docs/pygladeui-introduction.xml +++ /dev/null @@ -1,224 +0,0 @@ - - -]> - - - Introduction - - This document describes many of the PyGObject - version 2.12 classes and their methods and associated - functions. Deprecated classes, functions and methods have been - specifically left out of this reference though classes that have become - deprecated since PyGObject 2.0 have been left in but annotated with a - deprecation warning. This document attempts to document as much of the - PyGObject API as possible but there - are undoubtedly errors and omissions. If you discover any of these please - file a bug report at bugzilla.gnome.org for the - pygladeui project. Specific areas that have not been - documented include: - - - - The GParamSpec class - - - - This reference describes the API for PyGObject as - of version 2.11.0+ and assumes that the additional API changes for version - 2.12 will not be significant. There will undoubtedly be changes that are - not reflected in this reference. The differences in the API between - version 2.0 and previous versions are denoted in this reference with a - Note that describes the availability of the object, constructor, method or - function. Any of these that do not have a notation can be assumed to be - available in all versions of PyGObject from 2.0 and up. The source code - must be consulted if this reference and your version of - PyGObject seem to differ. You are encouraged to use the - latest version of PyGObject that is available. See the - PyGTK - homepage for more information and more resources on how to use - PyGObject as well as help in its development. - - The Reference contains a chapter for each - PyGObject module containing the class descriptions. The - class descriptions are arranged alphabetically within the - chapters. Currently there is one module chapter: - - - - The gobject module - The classes that are included in the -gobject module of PyGObject and are -accessed similar to: gobject.GObject. These classes are the base object -classes that the gtk and gtk.gdk -module classes are built on. - - - - - - - - Reference Page Format - - Each PyGObject class is described in a reference -page that has a number of sections in a fixed format. Each reference page -will have a subset of the following sections: - - - - Name - - The name and a one-line description of the -class. - - - - Synopsis - - A synopsis of the class and its methods and -optionally a list of associated functions. - - - - Ancestry - - The list of the parent classes of the class. This -section may not be present in all class descriptions. - - - - Properties - - A list of the properties (internal state) -supported by the class. This section may not be present in all classes. The -property descriptions include the name, the access operations (e.g. Read, -Write), and a brief description. Properties are accessed using the gobject.set_property() -and gobject.get_property() -methods that are available to every PyGObject object. This -section may not be present in all class descriptions. - - - - Attributes - - A set of internal object state data accessible as Python - attributes (e.g. object.attr). The attribute descriptions include - a name by which the attribute data is accessed, the access mode - (e.g. Read, Write), and a brief description of the attribute. Most - PyGObject classes do not support attributes so - this section is not present in most class descriptions. - - - - Signal Prototypes - - A list of the signals supported by the class including - the signal name and a synopsis of the signal handler function - prototype. This section may not be present in all class - descriptions. - - - - Description - A description of the class and possibly some of - the methods supported by the class. - - - - Constructor - - The description of the class object constructor including - the synopsis with brief parameter descriptions and a description - of th use of the constructor. There may be more than one - constructor description if the constructor supports different - parameter lists. This section may not be present in all class - descriptions. - - - - Methods - - A list of methods supported by the class. Each method - description includes: a synopsis of the method and its parameters - as well as a brief description of each parameter and return value - (if any); and, a description of the use of the method. - - - - Functions - - A list of related functions. Each function description - includes a synopsis of the function and its parameters and return - value (if any), and a description of the use of the - function. - - - - Signals - - A list of signals including a synopsis of the signal - handler prototype function with its parameters and return value - (if any). The signal emission conditions are briefly - described. This section is not present in all class descriptions; - specifically, the gtk.gdk classes do not - usually support signals. - - - - - The function and method synopsis parameters are displayed in - bold to denote Python keyword - parameters. Also if the parameter is optional its default value will be - displayed. For example the gobject.signal_lookup() - function synopsis is: - - - - gobject.signal_lookup - name - type - - - - The parameters name and - type are keyword parameters that can be specified - in a call either by position or keyword (in which case position is not - important). The following calls have the same result: - - - id = gobject.signal_lookup("clicked", gtk.Button) - id = gobject.signal_lookup("clicked", type=gtk.Button) - id = gobject.signal_lookup(name="clicked", type=gtk.Button) - id = gobject.signal_lookup(type=gtk.Button, name="clicked") - - - Parameters that are not keyword parameters are displayed in -italic and must be specified positionally but may also -be optional. - - - - diff --git a/bindings/python/docs/pygladeui.xml b/bindings/python/docs/pygladeui.xml index 9f932f60..3f7f41e5 100644 --- a/bindings/python/docs/pygladeui.xml +++ b/bindings/python/docs/pygladeui.xml @@ -43,9 +43,11 @@ This reference describes the classes of the Python gladeui module. - + + + -- cgit v1.2.1