aboutsummaryrefslogtreecommitdiffstats
path: root/shell/Evolution-Shell.idl
diff options
context:
space:
mode:
authorEttore Perazzoli <ettore@src.gnome.org>2000-08-04 02:44:07 +0800
committerEttore Perazzoli <ettore@src.gnome.org>2000-08-04 02:44:07 +0800
commit769ea87ada0a1c2fafc3a2578327910d12cac3a1 (patch)
tree03f18fce66b18a46d34252c94a3f40f2d1ff7e8b /shell/Evolution-Shell.idl
parent6310bd4bc14e6b321df0064552f8c61f01f85c69 (diff)
downloadgsoc2013-evolution-769ea87ada0a1c2fafc3a2578327910d12cac3a1.tar.gz
gsoc2013-evolution-769ea87ada0a1c2fafc3a2578327910d12cac3a1.tar.zst
gsoc2013-evolution-769ea87ada0a1c2fafc3a2578327910d12cac3a1.zip
Update docs.
svn path=/trunk/; revision=4510
Diffstat (limited to 'shell/Evolution-Shell.idl')
-rw-r--r--shell/Evolution-Shell.idl23
1 files changed, 22 insertions, 1 deletions
diff --git a/shell/Evolution-Shell.idl b/shell/Evolution-Shell.idl
index 3b154cd191..bda5732537 100644
--- a/shell/Evolution-Shell.idl
+++ b/shell/Evolution-Shell.idl
@@ -19,12 +19,33 @@ module Evolution {
exception NotFound {};
exception Busy {};
+ /**
+ * get_component_for_type:
+ * @type: name of a valid folder type
+ *
+ * Get the shell component associated with a specific folder type.
+ *
+ * Return value: the Evolution::ShellComponent interface for the component that
+ * handles @type.
+ */
ShellComponent get_component_for_type (in string type)
raises (NotFound);
typedef sequence<string> FolderTypeList;
- /* FIXME: Parent "transient_for" window. */
+ /**
+ * user_select_folder:
+ * @listener: a listener interface to report the answer of the user.
+ * @title: title for the folder selector dialog
+ * @default_folder: physical or `evolution:' URI for the folder that must be
+ * selected by default, when the dialog is popped up
+ * @possible_types: list of the names of the types of folders that are allowed
+ *
+ * Pop up a folder selection dialog from which the user can select a folder.
+ * Initially, the @default_folder is selected. The user can also create a new
+ * folder by using the "New..." button. The dialog only lets the user choose
+ * a folder whose type is listed in @possible_types.
+ */
void user_select_folder (in FolderSelectionListener listener,
in string title,
in string default_folder,