[gtkmm] Tiny comment/docs changes.



commit d1be30e965ae229bc80c4e6a665f6fef2139bc72
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Oct 9 10:34:59 2013 +0200

    Tiny comment/docs changes.

 gtk/src/comboboxtext.hg    |    2 +-
 gtk/src/entrycompletion.hg |    6 ++--
 gtk/src/fontbutton.hg      |    2 +-
 gtk/src/grid.hg            |    1 +
 gtk/src/iconinfo.hg        |   47 ++++++++++++++++++++++++++++++++++++++++---
 5 files changed, 49 insertions(+), 9 deletions(-)
---
diff --git a/gtk/src/comboboxtext.hg b/gtk/src/comboboxtext.hg
index 259c7d7..2946a2e 100644
--- a/gtk/src/comboboxtext.hg
+++ b/gtk/src/comboboxtext.hg
@@ -59,7 +59,7 @@ public:
 
   _WRAP_METHOD(void remove_all(), gtk_combo_box_text_remove_all)
 
-  //TODO: Add a C function
+  //TODO: Add a C function?
   void set_active_text(const Glib::ustring& text);
 };
 
diff --git a/gtk/src/entrycompletion.hg b/gtk/src/entrycompletion.hg
index 87f529c..d501259 100644
--- a/gtk/src/entrycompletion.hg
+++ b/gtk/src/entrycompletion.hg
@@ -28,13 +28,13 @@ namespace Gtk
 
 class Entry;
 
-//TODO: we should add "It derives from the Gtk::CellLayout, to allow the user to add extra cells to the 
Gtk::TreeView with completion matches".
-
 /** Completion functionality for Gtk::Entry.
  *
  * Gtk::EntryCompletion is an auxiliary object to be used in conjunction with
  * Gtk::Entry to provide the completion functionality.
  *
+ * It derives from Gtk::CellLayout, to allow the user to add extra cells to the Gtk::TreeView with 
completion matches.
+ *
  * "Completion functionality" means that when the user modifies the text in the
  * entry, Gtk::EntryCompletion checks which rows in the model match the current
  * content of the entry, and displays a list of matches. By default, the
@@ -211,7 +211,7 @@ protected:
 
   //Default Signal Handler:
   virtual bool on_match_selected(const TreeModel::iterator& iter);
-  //No default handler for on_cursor_on_match(), to preserver ABI. TODO: Add this when we can break ABI.
+  //No default handler for on_cursor_on_match(), to preserve ABI. TODO: Add this when we can break ABI.
 };
 
 } // namespace Gtk
diff --git a/gtk/src/fontbutton.hg b/gtk/src/fontbutton.hg
index 249aae1..86ba10b 100644
--- a/gtk/src/fontbutton.hg
+++ b/gtk/src/fontbutton.hg
@@ -39,7 +39,7 @@ namespace Gtk
  */
 class FontButton
   : public Button
-  //TODO: When we can break ABI:    public FontChooser
+  //TODO: When we can break ABI: public FontChooser
 {
   _CLASS_GTKOBJECT(FontButton, GtkFontButton, GTK_FONT_BUTTON, Gtk::Button, GtkButton)
   //TODO: When we can break ABI: _IMPLEMENTS_INTERFACE(FontChooser)
diff --git a/gtk/src/grid.hg b/gtk/src/grid.hg
index b34e96b..ef8d5b1 100644
--- a/gtk/src/grid.hg
+++ b/gtk/src/grid.hg
@@ -54,6 +54,7 @@ public:
   _CTOR_DEFAULT
 
   //TODO: Add a Grid(Orientation orientation = ORIENTATION_HORIZONTAL) constructor to match the Paned and 
Box ones?
+  //Probably not, because a vertical GtkGrid is not very useful. murrayc.
 
   _WRAP_METHOD(void attach(Widget& child, int left, int top, int width, int height), gtk_grid_attach)
   _WRAP_METHOD(void attach_next_to(Widget& child, Widget& sibling, PositionType side, int width, int 
height), gtk_grid_attach_next_to)
diff --git a/gtk/src/iconinfo.hg b/gtk/src/iconinfo.hg
index 6a01325..1177708 100644
--- a/gtk/src/iconinfo.hg
+++ b/gtk/src/iconinfo.hg
@@ -74,8 +74,21 @@ public:
 
   _IGNORE(gtk_icon_info_load_symbolic_for_style) //deprecated
 
-  //TODO: Documentation.
+  /** Asynchronously load, render and scale an icon previously looked up from the icon theme using 
Gtk::IconTheme::lookup_icon().
+   *
+   * @param slot A callback slot to call when the request is satisfied.
+   * @param cancellable A Cancellable object which can be used to cancel the operation.
+   *
+   * @newin{3,8}
+   */
   void load_icon_async(const Gio::SlotAsyncReady& slot, const Glib::RefPtr<Gio::Cancellable>& cancellable);
+
+  /** Asynchronously load, render and scale an icon previously looked up from the icon theme using 
Gtk::IconTheme::lookup_icon().
+   *
+   * @param slot A callback slot to call when the request is satisfied.
+   *
+   * @newin{3,8}
+   */
   void load_icon_async(const Gio::SlotAsyncReady& slot);
   _IGNORE(gtk_icon_info_load_icon_async)
 
@@ -83,13 +96,39 @@ public:
 
 
 
-  //TODO: Documentation:
+  /** Loads an icon, modifying it to match the system colors for the foreground, success, warning and error 
colors provided.
+   * If the icon is not a symbolic one, this method will return the result from load_icon().
+   * This method uses the regular foreground color and the symbolic colors with the names "success_color",
+   * "warning_color" and "error_color" from the context.
+   *
+   * This allows loading symbolic icons that will match the system theme.
+   *
+   * @param A StyleContext.
+   * @param was_symbolic Whether the loaded icon was a symbolic one and whether the fg color was applied to 
it. 
+   */
   Glib::RefPtr<Gdk::Pixbuf> load_symbolic(const Glib::RefPtr<StyleContext>& style, bool& was_symbolic);
   _IGNORE(gtk_icon_info_load_symbolic_for_context)
 
-
-  //TODO: Documentation.
+  //TODO: When we can break ABI: Rename these to load_symbolic_async(), or rename load_symbolic(context) to 
load_symbolic_for_context() for consistency.  
+  /** Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using 
Gtk::IconTheme::lookup_icon().
+   * For more details, see load_symbolic() which is the synchronous version of this call.
+   *
+   * @param context A StyleContext.
+   * @param slot A callback slot to call when the request is satisfied.
+   * @param cancellable A Cancellable object which can be used to cancel the operation.
+   *
+   * @newin{3,8}
+   */
   void load_symbolic_for_context_async(const Glib::RefPtr<StyleContext>& context, const Gio::SlotAsyncReady& 
slot, const Glib::RefPtr<Gio::Cancellable>& cancellable);
+
+  /** Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using 
Gtk::IconTheme::lookup_icon().
+   * For more details, see load_symbolic() which is the synchronous version of this call.
+   *
+   * @param context A StyleContext.
+   * @param slot A callback slot to call when the request is satisfied.
+   *
+   * @newin{3,8}
+   */
   void load_symbolic_for_context_async(const Glib::RefPtr<StyleContext>& context, const Gio::SlotAsyncReady& 
slot);
   _IGNORE(gtk_icon_info_load_symbolic_for_context_async)
 


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