summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorLutz Mueller <lutz@users.sourceforge.net>2001-10-14 16:00:54 +0000
committerLutz Mueller <lutz@users.sourceforge.net>2001-10-14 16:00:54 +0000
commitbf92a9a8b382f307229b4932b4a122170d8f4ff7 (patch)
treef3c6b9c0af61e42bf74f52dff8163b79484990c9 /doc/api
parentb8f00f39d1b81844ebdcf0f9c21b940e7ca70371 (diff)
downloadlibgphoto2-bf92a9a8b382f307229b4932b4a122170d8f4ff7.tar.gz
2001-10-14 Lutz M�ller <urc8@rz.uni-karlsruhe.de>
* libgphoto2/gphoto2-list.[c,h]: Documented. git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@2508 67ed7778-7388-44ab-90cf-0a291f65f57c
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/gphoto2-api.sgml2
-rw-r--r--doc/api/gphoto2-sections.txt25
-rw-r--r--doc/api/tmpl/gphoto2-unused.sgml17
-rw-r--r--doc/api/tmpl/libgphoto2.sgml17
-rw-r--r--doc/api/tmpl/widget.sgml289
5 files changed, 27 insertions, 323 deletions
diff --git a/doc/api/gphoto2-api.sgml b/doc/api/gphoto2-api.sgml
index 8adee7c74..402879634 100644
--- a/doc/api/gphoto2-api.sgml
+++ b/doc/api/gphoto2-api.sgml
@@ -5,6 +5,7 @@
<!entity gphoto2-core SYSTEM "sgml/gphoto2-core.sgml">
<!entity gphoto2-camera SYSTEM "sgml/gphoto2-camera.sgml">
<!entity gphoto2-setting SYSTEM "sgml/gphoto2-setting.sgml">
+<!entity gphoto2-list SYSTEM "sgml/gphoto2-list.sgml">
]>
<book id="index">
@@ -83,6 +84,7 @@ locking of serial ports. GPhoto2 currently supports
<sect1 id="GeneralPurposeObjects">
<title>Objects used by both frontends and camera drivers</title>
&gphoto2-widget;
+ &gphoto2-list;
</sect1>
</chapter>
diff --git a/doc/api/gphoto2-sections.txt b/doc/api/gphoto2-sections.txt
index 37fc931d4..046d91ec5 100644
--- a/doc/api/gphoto2-sections.txt
+++ b/doc/api/gphoto2-sections.txt
@@ -29,6 +29,31 @@ gp_widget_changed
</SECTION>
<SECTION>
+<FILE>gphoto2-list</FILE>
+<TITLE>CameraList</TITLE>
+CameraList
+
+gp_list_new
+gp_list_ref
+gp_list_unref
+gp_list_free
+
+gp_list_count
+
+gp_list_set_name
+gp_list_set_value
+
+gp_list_get_name
+gp_list_get_value
+
+gp_list_append
+gp_list_populate
+gp_list_reset
+gp_list_sort
+
+</SECTION>
+
+<SECTION>
<FILE>gphoto2-filesys</FILE>
<TITLE>CameraFilesystem</TITLE>
CameraFilesystem
diff --git a/doc/api/tmpl/gphoto2-unused.sgml b/doc/api/tmpl/gphoto2-unused.sgml
deleted file mode 100644
index 0f33399a9..000000000
--- a/doc/api/tmpl/gphoto2-unused.sgml
+++ /dev/null
@@ -1,17 +0,0 @@
-<!-- ##### SECTION ./tmpl/libgphoto2.sgml:See_Also ##### -->
-<para>
-</para>
-
-
-<!-- ##### SECTION ./tmpl/libgphoto2.sgml:Short_Description ##### -->
-Library for accessing digital cameras.
-
-
-<!-- ##### SECTION ./tmpl/libgphoto2.sgml:Long_Description ##### -->
-<para>
-<filename>libgphoto2</filename> is the library that provides access
-to a wide range of digital camera models. The library is GUI
-independent.
-</para>
-
-
diff --git a/doc/api/tmpl/libgphoto2.sgml b/doc/api/tmpl/libgphoto2.sgml
deleted file mode 100644
index af07f949e..000000000
--- a/doc/api/tmpl/libgphoto2.sgml
+++ /dev/null
@@ -1,17 +0,0 @@
-<!-- ##### SECTION Title #### -->
-libgphoto2
-
-<!-- ##### SECTION Short_Description ##### -->
-Library for accessing digital cameras.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-<filename>libgphoto2</filename> is the library that provides access
-to a wide range of digital camera models. The library is GUI
-independent.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-</para>
-
diff --git a/doc/api/tmpl/widget.sgml b/doc/api/tmpl/widget.sgml
deleted file mode 100644
index 45f445734..000000000
--- a/doc/api/tmpl/widget.sgml
+++ /dev/null
@@ -1,289 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-gphoto-widget
-
-<!-- ##### SECTION Short_Description ##### -->
-Widgets for GUI-independent access to camera configuration options.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A GPWidget is a mechanism to access camera configuration options
-without having to rely on a GUI. When a frontend requests a
-configuration dialog through gp_*_config_get, the camera driver will
-do something like
-</para>
-<para>
- <example>
- <title>Creating a GPWidget</title>
- <programlisting>
- *window = gp_widget_new (GP_WIDGET_WINDOW,
- _("Configuration for Model XY"));
- return (GP_OK);
- </programlisting>
- </example>
-</para>
-<para>
-The frontend now traverses this widget and builds the configuration
-dialog.
-</para>
-<para>
- <example>
- <title>Traversing a GPWidget</title>
- <programlisting>
- int i, count, result;
- GPWidgetType type;
-
- count = gp_widget_count_children (window);
- if (count < 0)
- return (count);
- for (i = 0; i < count; i++) {
- result = gp_widget_get_type (window, &type);
- if (result < 0)
- return (result);
- switch (type) {
- case GP_WIDGET_TYPE_WINDOW:
- break;
- default:
- break;
- }
- }
- </programlisting>
- </example>
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gp_widget_new ##### -->
-<para>
-
-</para>
-
-@type:
-@label:
-@widget:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_free ##### -->
-<para>
-
-</para>
-
-@widget:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_ref ##### -->
-<para>
-
-</para>
-
-@widget:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_unref ##### -->
-<para>
-
-</para>
-
-@widget:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_append ##### -->
-<para>
-
-</para>
-
-@parent:
-@child:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_prepend ##### -->
-<para>
-
-</para>
-
-@parent:
-@child:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_count_children ##### -->
-<para>
-
-</para>
-
-@parent:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_child ##### -->
-<para>
-
-</para>
-
-@parent:
-@child_number:
-@child:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_child_by_label ##### -->
-<para>
-
-</para>
-
-@parent:
-@child_label:
-@child:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_child_by_id ##### -->
-<para>
-
-</para>
-
-@parent:
-@id:
-@child:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_root ##### -->
-<para>
-
-</para>
-
-@widget:
-@root:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_set_info ##### -->
-<para>
-
-</para>
-
-@widget:
-@info:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_info ##### -->
-<para>
-
-</para>
-
-@widget:
-@info:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_id ##### -->
-<para>
-
-</para>
-
-@widget:
-@id:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_type ##### -->
-<para>
-
-</para>
-
-@widget:
-@type:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_label ##### -->
-<para>
-
-</para>
-
-@widget:
-@label:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_set_value ##### -->
-<para>
-
-</para>
-
-@widget:
-@value:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_value ##### -->
-<para>
-
-</para>
-
-@widget:
-@value:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_range ##### -->
-<para>
-
-</para>
-
-@range:
-@low:
-@high:
-@increment:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_add_choice ##### -->
-<para>
-
-</para>
-
-@widget:
-@choice:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_count_choices ##### -->
-<para>
-
-</para>
-
-@widget:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_get_choice ##### -->
-<para>
-
-</para>
-
-@widget:
-@choice_number:
-@choice:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_widget_changed ##### -->
-<para>
-
-</para>
-
-@widget:
-@Returns:
-
-