[gtkmm] Application: add_window(): Correct the documentation.



commit a40e5be5436324b8933e48357fcbcc14017c6946
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Apr 19 09:32:31 2012 +0200

    Application: add_window(): Correct the documentation.
    
    	* gtk/src/application.hg: The text seems to be based on an earlier version
    	of Gtk::Application or GtkApplication which created windows automatically.
    	Noticed by Mateusz Marzantowicz.

 ChangeLog              |    7 +++++++
 gtk/src/application.hg |   18 ++++++++----------
 2 files changed, 15 insertions(+), 10 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index aea32c5..e163bf8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2012-04-19  Murray Cumming  <murrayc murrayc com>
+
+	Application: add_window(): Correct the documentation.
+
+	* gtk/src/application.hg: The text seems to be based on an earlier version
+	of Gtk::Application or GtkApplication which created windows automatically.
+
 2012-04-17  Alexandre Rostovtsev  <tetromino gentoo org>
 
 	Make list of gdk targets non-automagic
diff --git a/gtk/src/application.hg b/gtk/src/application.hg
index 8bb1148..3f3a47b 100644
--- a/gtk/src/application.hg
+++ b/gtk/src/application.hg
@@ -90,17 +90,15 @@ public:
 
   /** Adds a window to the Gtk::Application.
    * 
-   * If all the windows managed by Gtk::Application are closed, the
-   * Gtk::Application will call quit(), and quit
+   * If all the windows managed by Gtk::Application are closed or removed from
+   * the application then the Gtk::Application will call quit(), and quit
    * the application.
-   * 
-   * If your application uses only a single toplevel window, you can
-   * use get_window(). If you are using a sub-class
-   * of Gtk::Application you should call create_window()
-   * to let the Gtk::Application instance create a Gtk::Window and add
-   * it to the list of toplevels of the application. You should call
-   * this function only to add Gtk::Window<!-- -->s that you created
-   * directly using new Gtk::Window.
+   *
+   * This call is equivalent to calling Gtk::Window::set_application().
+   *
+   * Normally, the connection between the application and the window
+   * will remain until the window is closed or destroyed, but you can explicitly
+   * remove it with remove_window().
    * 
    * @newin{3,4}
    * @param window A toplevel window to add to the application.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]