diff options
| -rw-r--r-- | ChangeLog | 10 | ||||
| -rw-r--r-- | doc/reference/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/reference/epiphany-docs.sgml | 1 | ||||
| -rw-r--r-- | doc/reference/epiphany-sections.txt | 5 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-embed.sgml | 1 | ||||
| -rw-r--r-- | lib/ephy-glade.c | 24 |
6 files changed, 35 insertions, 7 deletions
@@ -1,3 +1,13 @@ +2004-04-19 Adam Hooper <adamh@cvs.gnome.org> + + * doc/reference/Makefile.am: + * doc/reference/epiphany-docs.sgml: + * doc/reference/epiphany-sections.txt: + * doc/reference/tmpl/ephy-embed.sgml: + * lib/ephy-glade.c: (ephy_glade_widget_new): + + Documented EphyGlade... which is just a single function. + 2004-04-18 Christian Persch <chpe@cvs.gnome.org> * configure.in: diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 2e5373c54..33da0122c 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -38,7 +38,6 @@ IGNORE_HFILES = \ ephy-dnd.h \ ephy-file-chooser.h \ ephy-file-helpers.h \ - ephy-glade.h \ ephy-gui.h \ ephy-langs.h \ ephy-marshal.h \ diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml index ad600c820..77f21f012 100644 --- a/doc/reference/epiphany-docs.sgml +++ b/doc/reference/epiphany-docs.sgml @@ -17,6 +17,7 @@ <xi:include href="xml/ephy-embed-persist.xml"/> <xi:include href="xml/ephy-embed-factory.xml"/> <xi:include href="xml/ephy-node-db.xml"/> + <xi:include href="xml/ephy-glade.xml"/> </chapter> <chapter> <title>Incomplete</title> diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt index a08ed80a8..8d5750e4b 100644 --- a/doc/reference/epiphany-sections.txt +++ b/doc/reference/epiphany-sections.txt @@ -228,6 +228,11 @@ EPHY_IS_NODE_DB_CLASS EPHY_NODE_DB_GET_CLASS </SECTION> +<SECTION> +<FILE>ephy-glade</FILE> +<TITLE>EphyGlade</TITLE> +ephy_glade_widget_new +</SECTION> diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml index 1fd4d6784..0deb4abec 100644 --- a/doc/reference/tmpl/ephy-embed.sgml +++ b/doc/reference/tmpl/ephy-embed.sgml @@ -113,7 +113,6 @@ time, an #EphyEmbed's chrome will simply be %EPHY_EMBED_CHROME_DEFAULT. However, windows opened with JavaScript often use a nonstandard chrome. </para> -@EPHY_EMBED_CHROME_DEFAULT: @EPHY_EMBED_CHROME_MENUBAR: %TRUE for the #EphyEmbed's containing #EphyWindow to display its menubar. @EPHY_EMBED_CHROME_TOOLBAR: %TRUE for the #EphyEmbed's containing #EphyWindow diff --git a/lib/ephy-glade.c b/lib/ephy-glade.c index f6edad31a..5cd521a77 100644 --- a/lib/ephy-glade.c +++ b/lib/ephy-glade.c @@ -35,9 +35,25 @@ glade_signal_connect_func (const gchar *cb_name, GObject *obj, gpointer user_data); /** - * ephy_widget_new: build a new widget of the provided name, with all - * signals attached and data set to the provided parameter. - */ + * ephy_glade_widget_new: + * @file: a Glade XML file + * @widget_name: the name of a widget within @file + * @root: the returned root #GtkWidget pointer, or %NULL if not wanted + * @data: callback data to connect to all @root's signal callbacks + * @domain: the translation domain for the XML file (or %NULL for default) + * + * Builds a new #GladeXML object from the given @file with root widget + * @widget_name. The widget can also be aquired by passing @root, a pointer + * to a #GtkWidget pointer. + * + * The signal callbacks underneath the desired root widget in @file will all be + * automatically connected; the callback data will be @data. + * + * Libglade automatically caches @file; it is not inefficient to call + * ephy_glade_widget_new() several times on the same XML file. + * + * Return value: the desired #GladeXML object, or %NULL on failure + **/ GladeXML * ephy_glade_widget_new (const char *file, const char *widget_name, @@ -48,8 +64,6 @@ ephy_glade_widget_new (const char *file, GladeXML *gxml; /* build the widget */ - /* note that libglade automatically caches the parsed file, - * so we don't need to worry about the efficiency of this */ gxml = glade_xml_new (file, widget_name, domain); g_return_val_if_fail (gxml != NULL, NULL); |