callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libgimp/gimpfileselection.[ch] document the two widgets.

Browse Source 
2000-02-08  Michael Natterer  <mitch@gimp.org>

	* libgimp/gimpfileselection.[ch]
	* libgimp/gimppatheditor.[ch]: document the two widgets.
This commit is contained in:
Michael Natterer
2000-02-08 21:59:31 +00:00
committed by Michael Natterer
parent 6fe8e7ee61
commit 7d39b971d7
16 changed files with 245 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
devel-docs/ChangeLog
View File

@ -1,3 +1,11 @@
2000-02-08 Michael Natterer <mitch@gimp.org>
* libgimp/libgimp-decl.txt
* libgimp/tmpl/gimpexport.sgml
* libgimp/tmpl/gimpfileselection.sgml
* libgimp/tmpl/gimppatheditor.sgml: updated from the libgimp
sources. Added some more documentation to the sgml templates.
Tue Feb 8 00:51:54 CET 2000 Sven Neumann <sven@gimp.org>
* libgimp/gimpexport.sgml: documented the enums

4
devel-docs/libgimp/libgimp-decl.txt
View File

@ -2298,7 +2298,7 @@ void
<FUNCTION>
<NAME>gimp_file_selection_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gchar *title,gchar *filename,gboolean dir_only,gboolean check_valid
gchar *title,gchar *filename,gboolean dir_only,gboolean check_valid
</FUNCTION>
<FUNCTION>
<NAME>gimp_file_selection_get_filename</NAME>
@ -2708,7 +2708,7 @@ void
<FUNCTION>
<NAME>gimp_path_editor_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gchar *filesel_title,gchar *path
gchar *filesel_title,gchar *path
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_editor_get_path</NAME>

2
devel-docs/libgimp/tmpl/gimpexport.sgml
View File

@ -35,7 +35,7 @@ as it will most probably have to open a dialog.
@CAN_HANDLE_INDEXED: Use if the plug_in can save INDEXED images.
@CAN_HANDLE_ALPHA: Use if the plugin can save an alpha channel with
all image_types.
@CAN_HANDLE_LAYERS: Use if the plugin can save multiple layers.
@CAN_HANDLE_LAYERS: Use if the plugin can save multiple layers.
@CAN_HANDLE_LAYERS_AS_ANIMATION: Use if the plugin can save multiple layers
but treats them as frames in an animation.
@NEEDS_ALPHA: Use if the plugin needs an alpha channels and can't save

26
devel-docs/libgimp/tmpl/gimpfileselection.sgml
View File

@ -2,11 +2,28 @@
GimpFileSelection
<!-- ##### SECTION Short_Description ##### -->
Widget for entering a filename.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to enter filenames or directories.
</para>
<para>
There is a #GtkEntry for entering the filename manually and a "..."
button which will pop up a #GtkFileSelection dialog.
</para>
<para>
You can restrict the #GimpFileSelection to directories. In this case
the filename listbox of the #GtkFileSelection dialog will be hidden.
</para>
<para>
If you specify @check_valid as #TRUE in gimp_file_selection_new()
the entered filename will be checked for validity and a pixmap will be
shown which indicates if the file exists or not.
</para>
<para>
Whenever the user changes the filename, the "filename_changed" signal
will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -22,7 +39,8 @@ GimpFileSelection
<!-- ##### MACRO GIMP_FILE_SELECTION ##### -->
<para>
Checks if the passed pointer is a pointer to a #GimpFileSelection and
performes the cast if valid.
</para>
@obj: The pointer to cast.
@ -60,7 +78,7 @@ GimpFileSelection
<!-- ##### SIGNAL GimpFileSelection::filename-changed ##### -->
<para>
This signal is emitted whenever the user changes the filename.
</para>
@gimpfileselection: the object which received the signal.

26
devel-docs/libgimp/tmpl/gimppatheditor.sgml
View File

@ -2,17 +2,33 @@
GimpPathEditor
<!-- ##### SECTION Short_Description ##### -->
Widget for editing a file search path.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to edit file search paths.
</para>
<para>
It shows a list of all directories which are in the search path. You
can click a directory to select it. The widget provides a
#GimpFileSelection to change the currently selected directory.
</para>
<para>
There are buttons to add or delete directories as well as "up" and "down"
buttons to change the order in which the directories will be searched.
</para>
<para>
Whenever the user adds, deletes, changes or reorders a directory of
the search path, the "path_changed" signal will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpFileSelection
</para>
<para>
#G_SEARCHPATH_SEPARATOR
</para>
<!-- ##### STRUCT GimpPathEditor ##### -->
<para>
@ -22,7 +38,8 @@ GimpPathEditor
<!-- ##### MACRO GIMP_PATH_EDITOR ##### -->
<para>
Checks if the passed pointer is a pointer to a #GimpPathEditor and
performes the cast if valid.
</para>
@obj: The pointer to cast.
@ -49,7 +66,8 @@ GimpPathEditor
<!-- ##### SIGNAL GimpPathEditor::path-changed ##### -->
<para>
This signal is emitted whenever the user adds, deletes, modifies or
reorders an element of the search path.
</para>
@gimppatheditor: the object which received the signal.