diff options
author | Federico Mena Quintero <federico@ximian.com> | 2003-10-23 19:47:13 +0000 |
---|---|---|
committer | Federico Mena Quintero <federico@src.gnome.org> | 2003-10-23 19:47:13 +0000 |
commit | e577ee85c3e53631132f1d95c7bb6adbbc5fc158 (patch) | |
tree | 3309a53802c8e3ba10ebcbde3dec7bfd6fd0c661 /docs | |
parent | 0483c1a9dd17766ab2c0cd3e96cbd5591a1277d1 (diff) | |
download | gdk-pixbuf-e577ee85c3e53631132f1d95c7bb6adbbc5fc158.tar.gz |
Added gtk_file_chooser_get_type, gtk_file_chooser_dialog_get_type,
2003-10-23 Federico Mena Quintero <federico@ximian.com>
* gtk/gtk.types: Added gtk_file_chooser_get_type,
gtk_file_chooser_dialog_get_type,
gtk_file_chooser_widget_get_type, gtk_file_filter_get_type.
* gtk/gtk-sections.txt: Added GtkFileChooser,
GtkFileChooserWidget, GtkFileChooserDialog, GtkFileFilter.
* gtk/Makefile.am (IGNORE_HFILES): Added gtkcellrendererseptext.h,
gtkfilechooserdefault.h, gtkfilechooserentry.h,
gtkfilechooserutils.h, gtkfilesystem.h, gtkfilesystemmodel.h,
gtkfilesystemunix.h.
* gtk/tmpl/gtkfilechooser.sgml: New template file.
* gtk/tmpl/gtkfilechooserdialog.sgml: Likewise.
* gtk/tmpl/gtkfilechooserwidget.sgml: Likewise.
* gtk/tmpl/gtkfilefilter.sgml: Likewise.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 22 | ||||
-rw-r--r-- | docs/reference/gtk/Makefile.am | 59 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-sections.txt | 114 | ||||
-rw-r--r-- | docs/reference/gtk/gtk.types | 4 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilechooser.sgml | 485 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilechooserdialog.sgml | 31 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilechooserwidget.sgml | 27 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilefilter.sgml | 130 |
8 files changed, 846 insertions, 26 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d6688295d..6e8243561 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,25 @@ +2003-10-23 Federico Mena Quintero <federico@ximian.com> + + * gtk/gtk.types: Added gtk_file_chooser_get_type, + gtk_file_chooser_dialog_get_type, + gtk_file_chooser_widget_get_type, gtk_file_filter_get_type. + + * gtk/gtk-sections.txt: Added GtkFileChooser, + GtkFileChooserWidget, GtkFileChooserDialog, GtkFileFilter. + + * gtk/Makefile.am (IGNORE_HFILES): Added gtkcellrendererseptext.h, + gtkfilechooserdefault.h, gtkfilechooserentry.h, + gtkfilechooserutils.h, gtkfilesystem.h, gtkfilesystemmodel.h, + gtkfilesystemunix.h. + + * gtk/tmpl/gtkfilechooser.sgml: New template file. + + * gtk/tmpl/gtkfilechooserdialog.sgml: Likewise. + + * gtk/tmpl/gtkfilechooserwidget.sgml: Likewise. + + * gtk/tmpl/gtkfilefilter.sgml: Likewise. + Sun Oct 12 00:33:48 2003 Matthias Clasen <maclas@gmx.de> * gtk/gtk.types: Add the get_type() functions for diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 511803a76..b48ee17e6 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -22,32 +22,39 @@ HFILE_GLOB=$(top_srcdir)/gtk/*.h CFILE_GLOB=$(top_srcdir)/gtk/*.c # Header files to ignore when scanning -IGNORE_HFILES= \ - fnmatch.h \ - gdk-pixbuf-loader.h \ - gtkdebug.h \ - gtkhsv.h \ - gtkiconthemeparser.h \ - gtkimmodule.h \ - gtkintl.h \ - gtkkeyhash.h \ - gtkmarshal.h \ - gtkprivate.h \ - gtktreeprivate.h \ - gtkrbtree.h \ - gtktreedatalist.h \ - gtktextbtree.h \ - gtktextdisplay.h \ - gtktextiterprivate.h \ - gtktextlayout.h \ - gtktextmarkprivate.h \ - gtktextsegment.h \ - gtktexttagprivate.h \ - gtktexttypes.h \ - gtktextutil.h \ - gtktypebuiltins.h \ - gtkxembed.h \ - xembed.h \ +IGNORE_HFILES= \ + fnmatch.h \ + gdk-pixbuf-loader.h \ + gtkcellrendererseptext.h \ + gtkdebug.h \ + gtkfilechooserdefault.h \ + gtkfilechooserentry.h \ + gtkfilechooserutils.h \ + gtkfilesystem.h \ + gtkfilesystemmodel.h \ + gtkfilesystemunix.h \ + gtkhsv.h \ + gtkiconthemeparser.h \ + gtkimmodule.h \ + gtkintl.h \ + gtkkeyhash.h \ + gtkmarshal.h \ + gtkprivate.h \ + gtktreeprivate.h \ + gtkrbtree.h \ + gtktreedatalist.h \ + gtktextbtree.h \ + gtktextdisplay.h \ + gtktextiterprivate.h \ + gtktextlayout.h \ + gtktextmarkprivate.h \ + gtktextsegment.h \ + gtktexttagprivate.h \ + gtktexttypes.h \ + gtktextutil.h \ + gtktypebuiltins.h \ + gtkxembed.h \ + xembed.h \ gtktoggleactionprivate.h # CFLAGS and LDFLAGS for compiling scan program. Only needed diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index d6ed50d68..959742b58 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -1065,6 +1065,120 @@ GtkExpanderPrivate </SECTION> <SECTION> +<FILE>gtkfilechooser</FILE> +<TITLE>GtkFileChooser</TITLE> +GtkFileChooser +GtkFileChooserAction +GTK_FILE_CHOOSER_ERROR +GtkFileChooserError +gtk_file_chooser_error_quark +gtk_file_chooser_set_action +gtk_file_chooser_get_action +gtk_file_chooser_set_folder_mode +gtk_file_chooser_get_folder_mode +gtk_file_chooser_set_local_only +gtk_file_chooser_get_local_only +gtk_file_chooser_set_select_multiple +gtk_file_chooser_get_select_multiple +gtk_file_chooser_set_current_name +gtk_file_chooser_get_filename +gtk_file_chooser_set_filename +gtk_file_chooser_select_filename +gtk_file_chooser_unselect_filename +gtk_file_chooser_select_all +gtk_file_chooser_unselect_all +gtk_file_chooser_get_filenames +gtk_file_chooser_set_current_folder +gtk_file_chooser_get_current_folder +gtk_file_chooser_get_uri +gtk_file_chooser_set_uri +gtk_file_chooser_select_uri +gtk_file_chooser_unselect_uri +gtk_file_chooser_get_uris +gtk_file_chooser_set_current_folder_uri +gtk_file_chooser_get_current_folder_uri +gtk_file_chooser_set_preview_widget +gtk_file_chooser_get_preview_widget +gtk_file_chooser_set_preview_widget_active +gtk_file_chooser_get_preview_widget_active +gtk_file_chooser_get_preview_filename +gtk_file_chooser_get_preview_uri +gtk_file_chooser_set_extra_widget +gtk_file_chooser_get_extra_widget +gtk_file_chooser_add_filter +gtk_file_chooser_remove_filter +gtk_file_chooser_list_filters +gtk_file_chooser_set_filter +gtk_file_chooser_get_filter +gtk_file_chooser_add_shortcut_folder +gtk_file_chooser_remove_shortcut_folder +gtk_file_chooser_list_shortcut_folders +gtk_file_chooser_add_shortcut_folder_uri +gtk_file_chooser_remove_shortcut_folder_uri +gtk_file_chooser_list_shortcut_folder_uris +<SUBSECTION Standard> +GTK_FILE_CHOOSER +GTK_IS_FILE_CHOOSER +GTK_TYPE_FILE_CHOOSER +<SUBSECTION Private> +gtk_file_chooser_get_type +</SECTION> + +<SECTION> +<FILE>gtkfilechooserdialog</FILE> +<TITLE>GtkFileChooserDialog</TITLE> +gtk_file_chooser_dialog_new +<SUBSECTION Standard> +GTK_FILE_CHOOSER_DIALOG +GTK_IS_FILE_CHOOSER_DIALOG +GTK_TYPE_FILE_CHOOSER_DIALOG +GTK_FILE_CHOOSER_DIALOG_CLASS +GTK_IS_FILE_CHOOSER_DIALOG_CLASS +GTK_FILE_CHOOSER_DIALOG_GET_CLASS +<SUBSECTION Private> +gtk_file_chooser_dialog_get_type +GtkFileChooserDialogPrivate +</SECTION> + +<SECTION> +<FILE>gtkfilechooserwidget</FILE> +<TITLE>GtkFileChooserWidget</TITLE> +gtk_file_chooser_widget_new +<SUBSECTION Standard> +GTK_FILE_CHOOSER_WIDGET +GTK_IS_FILE_CHOOSER_WIDGET +GTK_TYPE_FILE_CHOOSER_WIDGET +GTK_FILE_CHOOSER_WIDGET_CLASS +GTK_IS_FILE_CHOOSER_WIDGET_CLASS +GTK_FILE_CHOOSER_WIDGET_GET_CLASS +<SUBSECTION Private> +gtk_file_chooser_widget_get_type +GtkFileChooserWidgetPrivate +</SECTION> + +<SECTION> +<FILE>gtkfilefilter</FILE> +GtkFileFilter +GtkFileFilterInfo +GtkFileFilterFlags +GtkFileFilterFunc +gtk_file_filter_new +gtk_file_filter_set_name +gtk_file_filter_get_name +gtk_file_filter_add_mime_type +gtk_file_filter_add_pattern +gtk_file_filter_add_custom +gtk_file_filter_get_needed +gtk_file_filter_filter +<SUBSECTION Standard> +GTK_FILE_FILTER +GTK_IS_FILE_FILTER +GTK_TYPE_FILE_FILTER +<SUBSECTION Private> +gtk_file_filter_get_type +</SECTION> + +<SECTION> <FILE>gtkfilesel</FILE> <TITLE>GtkFileSelection</TITLE> GtkFileSelection diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types index 3a3f5366b..f9305e53e 100644 --- a/docs/reference/gtk/gtk.types +++ b/docs/reference/gtk/gtk.types @@ -37,6 +37,10 @@ gtk_entry_completion_get_type gtk_entry_get_type gtk_event_box_get_type gtk_expander_get_type +gtk_file_chooser_get_type +gtk_file_chooser_dialog_get_type +gtk_file_chooser_widget_get_type +gtk_file_filter_get_type gtk_file_selection_get_type gtk_fixed_get_type gtk_font_button_get_type diff --git a/docs/reference/gtk/tmpl/gtkfilechooser.sgml b/docs/reference/gtk/tmpl/gtkfilechooser.sgml new file mode 100644 index 000000000..750ec3bc1 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkfilechooser.sgml @@ -0,0 +1,485 @@ +<!-- ##### SECTION Title ##### --> +GtkFileChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GtkFileChooser ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GtkFileChooser::current-folder-changed ##### --> +<para> + +</para> + +@filechooser: the object which received the signal. + +<!-- ##### SIGNAL GtkFileChooser::file-activated ##### --> +<para> + +</para> + +@filechooser: the object which received the signal. + +<!-- ##### SIGNAL GtkFileChooser::selection-changed ##### --> +<para> + +</para> + +@filechooser: the object which received the signal. + +<!-- ##### SIGNAL GtkFileChooser::update-preview ##### --> +<para> + +</para> + +@filechooser: the object which received the signal. + +<!-- ##### ENUM GtkFileChooserAction ##### --> +<para> + +</para> + +@GTK_FILE_CHOOSER_ACTION_OPEN: +@GTK_FILE_CHOOSER_ACTION_SAVE: + +<!-- ##### MACRO GTK_FILE_CHOOSER_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM GtkFileChooserError ##### --> +<para> + +</para> + +@GTK_FILE_CHOOSER_ERROR_NONEXISTENT: +@GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: + +<!-- ##### FUNCTION gtk_file_chooser_error_quark ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_action ##### --> +<para> + +</para> + +@chooser: +@action: + + +<!-- ##### FUNCTION gtk_file_chooser_get_action ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_folder_mode ##### --> +<para> + +</para> + +@chooser: +@folder_mode: + + +<!-- ##### FUNCTION gtk_file_chooser_get_folder_mode ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_local_only ##### --> +<para> + +</para> + +@chooser: +@files_only: + + +<!-- ##### FUNCTION gtk_file_chooser_get_local_only ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_select_multiple ##### --> +<para> + +</para> + +@chooser: +@select_multiple: + + +<!-- ##### FUNCTION gtk_file_chooser_get_select_multiple ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_current_name ##### --> +<para> + +</para> + +@chooser: +@name: + + +<!-- ##### FUNCTION gtk_file_chooser_get_filename ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_filename ##### --> +<para> + +</para> + +@chooser: +@filename: + + +<!-- ##### FUNCTION gtk_file_chooser_select_filename ##### --> +<para> + +</para> + +@chooser: +@filename: + + +<!-- ##### FUNCTION gtk_file_chooser_unselect_filename ##### --> +<para> + +</para> + +@chooser: +@filename: + + +<!-- ##### FUNCTION gtk_file_chooser_select_all ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gtk_file_chooser_unselect_all ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gtk_file_chooser_get_filenames ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_current_folder ##### --> +<para> + +</para> + +@chooser: +@filename: + + +<!-- ##### FUNCTION gtk_file_chooser_get_current_folder ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_get_uri ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_uri ##### --> +<para> + +</para> + +@chooser: +@uri: + + +<!-- ##### FUNCTION gtk_file_chooser_select_uri ##### --> +<para> + +</para> + +@chooser: +@uri: + + +<!-- ##### FUNCTION gtk_file_chooser_unselect_uri ##### --> +<para> + +</para> + +@chooser: +@uri: + + +<!-- ##### FUNCTION gtk_file_chooser_get_uris ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_current_folder_uri ##### --> +<para> + +</para> + +@chooser: +@uri: + + +<!-- ##### FUNCTION gtk_file_chooser_get_current_folder_uri ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_preview_widget ##### --> +<para> + +</para> + +@chooser: +@preview_widget: + + +<!-- ##### FUNCTION gtk_file_chooser_get_preview_widget ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_preview_widget_active ##### --> +<para> + +</para> + +@chooser: +@active: + + +<!-- ##### FUNCTION gtk_file_chooser_get_preview_widget_active ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_get_preview_filename ##### --> +<para> + +</para> + +@file_chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_get_preview_uri ##### --> +<para> + +</para> + +@file_chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_extra_widget ##### --> +<para> + +</para> + +@chooser: +@extra_widget: + + +<!-- ##### FUNCTION gtk_file_chooser_get_extra_widget ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_add_filter ##### --> +<para> + +</para> + +@chooser: +@filter: + + +<!-- ##### FUNCTION gtk_file_chooser_remove_filter ##### --> +<para> + +</para> + +@chooser: +@filter: + + +<!-- ##### FUNCTION gtk_file_chooser_list_filters ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_set_filter ##### --> +<para> + +</para> + +@chooser: +@filter: + + +<!-- ##### FUNCTION gtk_file_chooser_get_filter ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder ##### --> +<para> + +</para> + +@chooser: +@folder: +@error: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder ##### --> +<para> + +</para> + +@chooser: +@folder: +@error: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folders ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder_uri ##### --> +<para> + +</para> + +@chooser: +@folder: +@error: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder_uri ##### --> +<para> + +</para> + +@chooser: +@folder: +@error: +@Returns: + + +<!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folder_uris ##### --> +<para> + +</para> + +@chooser: +@Returns: + + diff --git a/docs/reference/gtk/tmpl/gtkfilechooserdialog.sgml b/docs/reference/gtk/tmpl/gtkfilechooserdialog.sgml new file mode 100644 index 000000000..22217cb0d --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkfilechooserdialog.sgml @@ -0,0 +1,31 @@ +<!-- ##### SECTION Title ##### --> +GtkFileChooserDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gtk_file_chooser_dialog_new ##### --> +<para> + +</para> + +@title: +@parent: +@action: +@first_button_text: +@Varargs: +@Returns: + + diff --git a/docs/reference/gtk/tmpl/gtkfilechooserwidget.sgml b/docs/reference/gtk/tmpl/gtkfilechooserwidget.sgml new file mode 100644 index 000000000..d4705745e --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkfilechooserwidget.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +GtkFileChooserWidget + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gtk_file_chooser_widget_new ##### --> +<para> + +</para> + +@action: +@Returns: + + diff --git a/docs/reference/gtk/tmpl/gtkfilefilter.sgml b/docs/reference/gtk/tmpl/gtkfilefilter.sgml new file mode 100644 index 000000000..bab42a7d4 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkfilefilter.sgml @@ -0,0 +1,130 @@ +<!-- ##### SECTION Title ##### --> +gtkfilefilter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GtkFileFilter ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GtkFileFilterInfo ##### --> +<para> + +</para> + +@contains: +@filename: +@uri: +@display_name: +@mime_type: + +<!-- ##### ENUM GtkFileFilterFlags ##### --> +<para> + +</para> + +@GTK_FILE_FILTER_FILENAME: +@GTK_FILE_FILTER_URI: +@GTK_FILE_FILTER_DISPLAY_NAME: +@GTK_FILE_FILTER_MIME_TYPE: + +<!-- ##### USER_FUNCTION GtkFileFilterFunc ##### --> +<para> + +</para> + +@filter_info: +@data: +@Returns: + + +<!-- ##### FUNCTION gtk_file_filter_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gtk_file_filter_set_name ##### --> +<para> + +</para> + +@filter: +@name: + + +<!-- ##### FUNCTION gtk_file_filter_get_name ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION gtk_file_filter_add_mime_type ##### --> +<para> + +</para> + +@filter: +@mime_type: + + +<!-- ##### FUNCTION gtk_file_filter_add_pattern ##### --> +<para> + +</para> + +@filter: +@pattern: + + +<!-- ##### FUNCTION gtk_file_filter_add_custom ##### --> +<para> + +</para> + +@filter: +@needed: +@func: +@data: +@notify: + + +<!-- ##### FUNCTION gtk_file_filter_get_needed ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION gtk_file_filter_filter ##### --> +<para> + +</para> + +@filter: +@filter_info: +@Returns: + + |