diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-14 15:45:27 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-14 15:45:27 +0000 |
| commit | ce4d0fd5d86a1f725aba6093d9674b993d437d6c (patch) | |
| tree | 4839ae652332f4ec80de23a21fb0ddd702a20330 /src/Fl_File_Icon2.cxx | |
| parent | 7f4e2867e84826d237e48f01f25de168cfdb986b (diff) | |
Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6239 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_File_Icon2.cxx')
| -rw-r--r-- | src/Fl_File_Icon2.cxx | 29 |
1 files changed, 12 insertions, 17 deletions
diff --git a/src/Fl_File_Icon2.cxx b/src/Fl_File_Icon2.cxx index 7ab1bda72..303c0e1f5 100644 --- a/src/Fl_File_Icon2.cxx +++ b/src/Fl_File_Icon2.cxx @@ -98,10 +98,7 @@ static char *get_kde_val(char *str, const char *key); static const char *kdedir = NULL; -// -// 'Fl_File_Icon::load()' - Load an icon file... -// - +/** Loads the specified icon image. The format is deduced from the filename.*/ void Fl_File_Icon::load(const char *f) // I - File to read from { @@ -124,10 +121,7 @@ Fl_File_Icon::load(const char *f) // I - File to read from } -// -// 'Fl_File_Icon::load_fti()' - Load an SGI-format FTI file... -// - +/** Loads an SGI icon file.*/ int // O - 0 on success, non-zero on error Fl_File_Icon::load_fti(const char *fti) // I - File to read from { @@ -341,12 +335,8 @@ Fl_File_Icon::load_fti(const char *fti) // I - File to read from } -// -// 'Fl_File_Icon::load_image()' - Load an image icon file... -// - -int // O - 0 on success, non-0 on error -Fl_File_Icon::load_image(const char *ifile) // I - File to read from +/** Load an image icon file from an image filename. Returns 0 on success, non-0 on error. */ +int Fl_File_Icon::load_image(const char *ifile) // I - File to read from { Fl_Shared_Image *img; // Image file @@ -587,9 +577,14 @@ Fl_File_Icon::load_image(const char *ifile) // I - File to read from } -// -// 'Fl_File_Icon::load_system_icons()' - Load the standard system icons/filetypes. - +/** Loads all system-defined icons. This call is useful when using the + FileChooser widget and should be used when the application + starts: + + <UL><PRE> + Fl_File_Icon::load_system_icons(); + </PRE></UL> +*/ void Fl_File_Icon::load_system_icons(void) { int i; // Looping var |