[gtkmm] gtk/src/infobar.hg: Added class documentation.



commit 049ee6f50b386198c962fdc6b74add1bf9ea4d6c
Author: Murray Cumming <murrayc murrayc com>
Date:   Sun Sep 6 18:57:56 2009 +0200

    gtk/src/infobar.hg: Added class documentation.

 ChangeLog          |    4 ++++
 gtk/src/infobar.hg |   19 +++++++++++++++++--
 2 files changed, 21 insertions(+), 2 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 47cabeb..bdd13dd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2009-09-06  Murray Cumming  <murrayc murrayc com>
 
+	* gtk/src/infobar.hg: Added class documentation.
+
+2009-09-06  Murray Cumming  <murrayc murrayc com>
+
 	Gdk::Window: Wrapped new methods.
 
 	* gdk/src/gdk_methods.defs: Regenerated.
diff --git a/gtk/src/infobar.hg b/gtk/src/infobar.hg
index 1ae86fe..90f9c00 100644
--- a/gtk/src/infobar.hg
+++ b/gtk/src/infobar.hg
@@ -28,9 +28,24 @@ _PINCLUDE(gtkmm/private/box_p.h)
 namespace Gtk
 {
 
-/** TODO
+//TODO: Derive from Gtk::Buildable when we can break ABI.
+
+/** This 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 
+ * Dialog, which has a horizontal action area at the bottom, InfoBar has a vertical 
+ * action area at the side.
+ *
+ * The API is very similar to Dialog, allowing you to add buttons to the action 
+ * area with add_button(). The sensitivity of action widgets can be controlled 
+ * with set_response_sensitive(). To add widgets to the main content area, use 
+ * get_content_area() and add your widgets to the container.
+ *
+ * Similar to MessageDialog, the contents can by classified as error message, 
+ * warning, informational message, etc, by using set_message_type(). This 
+ * determines the background color of the message area. 
  *
- * The InfoBar widget looks like this: TODO
+ * The InfoBar widget looks like 
+ * @image html infobar1.png
  *
  * @newin{2,18}
  *



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