Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/src/sugar/graphics/combobox.py
diff options
context:
space:
mode:
authorDavid Farning <dfarning@gmail.com>2008-09-20 00:32:55 (GMT)
committer David Farning <dfarning@gmail.com>2008-09-20 00:32:55 (GMT)
commit62128530c339748001b595ecd47088090a654b0d (patch)
treee514e42c71c539c6e265e11df4f46233eba84da2 /src/sugar/graphics/combobox.py
parentdd7442a0faf94db7279c58bf8875be462f4bab0e (diff)
API docstrings from pydocweb
Diffstat (limited to 'src/sugar/graphics/combobox.py')
-rw-r--r--src/sugar/graphics/combobox.py56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/sugar/graphics/combobox.py b/src/sugar/graphics/combobox.py
index 68a7106..4c43f99 100644
--- a/src/sugar/graphics/combobox.py
+++ b/src/sugar/graphics/combobox.py
@@ -36,6 +36,16 @@ class ComboBox(gtk.ComboBox):
self.set_row_separator_func(self._is_separator)
def get_value(self):
+ """
+ Parameters
+ ----------
+ None :
+
+ Returns:
+ --------
+ value :
+
+ """
row = self.get_active_item()
if not row:
return None
@@ -55,6 +65,22 @@ class ComboBox(gtk.ComboBox):
return fname
def append_item(self, action_id, text, icon_name=None, file_name=None):
+ """
+ Parameters
+ ----------
+ action_id :
+
+ text :
+
+ icon_name=None :
+
+ file_name=None :
+
+ Returns
+ -------
+ None
+
+ """
if not self._icon_renderer and (icon_name or file_name):
self._icon_renderer = gtk.CellRendererPixbuf()
@@ -89,9 +115,29 @@ class ComboBox(gtk.ComboBox):
self._model.append([action_id, text, pixbuf, False])
def append_separator(self):
+ """
+ Parameters
+ ----------
+ None
+
+ Returns
+ -------
+ None
+
+ """
self._model.append([0, None, None, True])
def get_active_item(self):
+ """
+ Parameters
+ ----------
+ None
+
+ Returns
+ -------
+ Active_item :
+
+ """
index = self.get_active()
if index == -1:
index = 0
@@ -102,6 +148,16 @@ class ComboBox(gtk.ComboBox):
return self._model[row]
def remove_all(self):
+ """
+ Parameters
+ ----------
+ None
+
+ Returns
+ -------
+ None
+
+ """
self._model.clear()
def _is_separator(self, model, row):