summaryrefslogtreecommitdiff
path: root/src/fl_file_dir.cxx
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-03 11:20:50 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-03 11:20:50 +0000
commitfabf5fc18167f73526c21842fa8e68da29647094 (patch)
treea5928a6b3f149ef4924574ce7854b55f621d9898 /src/fl_file_dir.cxx
parentb763b271a714628bf2a24571f9995b5d456b3070 (diff)
Fixed bad comments in fl_color_chooser, r g b param are in/out params and not in. Added param and return dox commands to these functions. Added a new Common Dialogs Module containing all fl_ask,fl,fl_color,fl_file dialogs. Fixed the fl_old_shortcut appearing in Fl_Button.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6367 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_file_dir.cxx')
-rw-r--r--src/fl_file_dir.cxx22
1 files changed, 18 insertions, 4 deletions
diff --git a/src/fl_file_dir.cxx b/src/fl_file_dir.cxx
index 093a915cd..0db2d3453 100644
--- a/src/fl_file_dir.cxx
+++ b/src/fl_file_dir.cxx
@@ -42,6 +42,8 @@ static void callback(Fl_File_Chooser *, void*) {
(*current_callback)(fc->value());
}
+/** \addtogroup group_comdlg
+ @{ */
/** \relatesalso Fl_File_Chooser
Set the file chooser callback
@@ -59,8 +61,15 @@ void fl_file_chooser_ok_label(const char *l) {
else current_label = fl_ok;
}
-/** \relatesalso Fl_File_Chooser
- Show a file chooser dialog and get a filename.
+/** \relates Fl_File_Chooser
+ Shows a file chooser dialog and get a filename.
+ \image html Fl_File_Chooser.jpg
+ \param message text in title bar
+ \param pat filename pattern filter
+ \param fname initial/default filename selection
+ \param relative 0 for absolute path name, relative path name otherwise
+ \return the user selected filename, in absolute or relative format
+ or NULL if user cancels
*/
char * // O - Filename or NULL
fl_file_chooser(const char *message, // I - Message in titlebar
@@ -136,8 +145,12 @@ fl_file_chooser(const char *message, // I - Message in titlebar
else return 0;
}
-/** \relatesalso Fl_File_Chooser
- Show a file chooser dialog and get a directory.
+/** \relates Fl_File_Chooser
+ Shows a file chooser dialog and get a directory.
+ \param[in] message title bar text
+ \param[in] fname initial/default directory name
+ \param[in] relative 0 for absolute path return, relative otherwise
+ \return the directory path string choosen by the user or NULL if user cancels
*/
char * // O - Directory or NULL
@@ -172,6 +185,7 @@ fl_dir_chooser(const char *message, // I - Message for titlebar
} else if (fc->value()) return (char *)fc->value();
else return 0;
}
+/** @} */
//