summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorMichael R Sweet <michael.r.sweet@gmail.com>2002-03-25 21:08:42 +0000
committerMichael R Sweet <michael.r.sweet@gmail.com>2002-03-25 21:08:42 +0000
commit6c796f88c7459fa4262f936dc9c7c02fa01e95e7 (patch)
tree9f1d5d4e8e4f4f709f11f3c95701c14e41a3483c /documentation
parentd7f353ddd120228a1a4444ff0dec2146de7cd980 (diff)
Rename all remaining functions that don't start with fl_ to
fl_foo. (filename_xyz becomes fl_filename_xyz, down becomes fl_down, define_FL_PLASTIC_BOX becomes fl_define_FL_PLASTIC_BOX, etc.) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2026 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Fl_File_Browser.html6
-rw-r--r--documentation/Fl_File_Chooser.html8
-rw-r--r--documentation/functions.html24
-rw-r--r--documentation/migration.html61
4 files changed, 82 insertions, 17 deletions
diff --git a/documentation/Fl_File_Browser.html b/documentation/Fl_File_Browser.html
index 6b8cbadc2..6137bdddc 100644
--- a/documentation/Fl_File_Browser.html
+++ b/documentation/Fl_File_Browser.html
@@ -56,8 +56,10 @@ uchar iconsize() const</A></H4>
<H4><A NAME="Fl_File_Browser.filter">void filter(const char *pattern)<BR>
const char *filter() const</A></H4>
-<P>Sets or gets the filename filter. The pattern matching uses the
-<CODE>filename_match()</CODE> function in FLTK.
+<P>Sets or gets the filename filter. The pattern matching uses
+the <A
+HREF="functions.html#fl_filename_match"><CODE>fl_filename_match()</CODE></A>
+function in FLTK.
<H4><A NAME="Fl_File_Browser.filetype">void filetype(int type)<BR>
int filetype() const</A></H4>
diff --git a/documentation/Fl_File_Chooser.html b/documentation/Fl_File_Chooser.html
index a38e945da..0e1db01af 100644
--- a/documentation/Fl_File_Chooser.html
+++ b/documentation/Fl_File_Chooser.html
@@ -59,9 +59,11 @@ above. The <CODE>pathname</CODE> argument can be a directory name or a
complete file name (in which case the corresponding file is highlighted
in the list and in the filename input field.)
-<P>The <CODE>pattern</CODE> argument can be a <CODE>NULL</CODE> string or
-<CODE>"*"</CODE> to list all files. See the FLTK documentation on
-<CODE>filename_match()</CODE> for other kinds of patterns.
+<P>The <CODE>pattern</CODE> argument can be a <CODE>NULL</CODE>
+string or <CODE>"*"</CODE> to list all files. See the FLTK
+documentation on <A
+HREF="functions.html#fl_filename_match"><CODE>fl_filename_match()</CODE></A>
+for other kinds of patterns.
<P>The <CODE>type</CODE> argument can be one of the following:
diff --git a/documentation/functions.html b/documentation/functions.html
index a227ff5c7..4a8f827e9 100644
--- a/documentation/functions.html
+++ b/documentation/functions.html
@@ -128,8 +128,8 @@ or <tt>NULL</tt> if Cancel is chosen.
<P><tt>message</tt> is a string used to title the window.
<P><tt>pattern</tt> is used to limit the files listed in a directory to
-those matching the pattern. This matching is done by <A href=#filename_match>
-<tt>filename_match()</tt></A>. Use <tt>NULL</tt> to show all files.
+those matching the pattern. This matching is done by <A href=#fl_filename_match>
+<tt>fl_filename_match()</tt></A>. Use <tt>NULL</tt> to show all files.
<P><tt>fname</tt> is a default filename to fill in the chooser with.
If this is <tt>NULL</tt> then the last filename that was choosen is
@@ -148,7 +148,7 @@ currently popped-up file chooser. This could be used to preview the
contents of the file. It has to be reasonably fast, and cannot create
FLTK windows.
-<h3><A name=filename_list>int filename_list(const char *d, dirent
+<h3><A name=fl_filename_list>int fl_filename_list(const char *d, dirent
***list)</A></h3>
This is a portable and const-correct wrapper for the
@@ -169,27 +169,27 @@ an attempt is made to put unpadded numbers in consecutive order.
<ul><pre>for (int i = return_value; i &gt; 0;) free((void*)(list[--i]));
free((void*)list);</pre></ul>
-<h3><A name=filename_isdir>int filename_isdir(const char *f)</A></h3>
+<h3><A name=fl_filename_isdir>int fl_filename_isdir(const char *f)</A></h3>
Returns non-zero if the file exists and is a directory.
-<h3><A name=filename_name>const char *filename_name(const char *f)</A></h3>
+<h3><A name=fl_filename_name>const char *fl_filename_name(const char *f)</A></h3>
Returns a pointer to the character after the last slash, or to the
start of the filename if there is none.
-<h3><A name=filename_ext>const char *filename_ext(const char *f)</A></h3>
+<h3><A name=fl_filename_ext>const char *fl_filename_ext(const char *f)</A></h3>
-Returns a pointer to the last period in <tt>filename_name(f)</tt>, or
+Returns a pointer to the last period in <tt>fl_filename_name(f)</tt>, or
a pointer to the trailing nul if none.
-<h3><A name=filename_setext>char *filename_setext(char *f, const char
+<h3><A name=fl_filename_setext>char *fl_filename_setext(char *f, const char
*ext)</A></h3>
-Does <tt>strcpy(filename_ext(f), ext ? ext : &quot;&quot;)</tt>. Returns a
+Does <tt>strcpy(fl_filename_ext(f), ext ? ext : &quot;&quot;)</tt>. Returns a
pointer to <tt>f</tt>.
-<h3><A name=filename_expand>int filename_expand(char *out, const char
+<h3><A name=fl_filename_expand>int fl_filename_expand(char *out, const char
*in)</A></h3>
Splits <tt>in</tt> at each slash character. Replaces any occurrance
@@ -203,7 +203,7 @@ be the same buffer). Returns non-zero if any changes were made. <I>In
true retro programming style, it is up to you to provide a buffer big
enough for the result. 1024 characters should be enough.</I>
-<h3><A name=filename_absolute>int filename_absolute(char *out, const
+<h3><A name=fl_filename_absolute>int fl_filename_absolute(char *out, const
char *in)</A></h3>
If <tt>in</tt> does not start with a slash, this prepends the current
@@ -214,7 +214,7 @@ changes were made. <I>In true retro programming style, it is up to you
to provide a buffer big enough for the result. 1024 characters should
be enough.</I>
-<h3><A name=filename_match>int filename_match(const char *f, const char
+<h3><A name=fl_filename_match>int fl_filename_match(const char *f, const char
*pattern)</A></h3>
Returns true if <tt>f</tt> matches <tt>pattern</tt>. The following
diff --git a/documentation/migration.html b/documentation/migration.html
index 060fe7f13..def6c4b36 100644
--- a/documentation/migration.html
+++ b/documentation/migration.html
@@ -29,6 +29,67 @@ to be ported to the new <A
HREF="Fl_File_Chooser.html"><TT>Fl_File_Chooser</TT></A>
class.</P>
+<H2>Function Names</H2>
+
+<P>Some function names have changed from FLTK 1.0.x to 1.1.x in
+order to avoid name space collisions. The following table shows
+the old and new function names:</P>
+
+<CENTER><TABLE WIDTH="80%" BORDER="1">
+<TR>
+ <TH>Old 1.0.x Name</TH>
+ <TH>New 1.1.x Name</TH>
+</TR>
+<TR>
+ <TD>contrast()</TD>
+ <TD>fl_contrast()</TD>
+</TR>
+<TR>
+ <TD>down()</TD>
+ <TD>fl_down()</TD>
+</TR>
+<TR>
+ <TD>filename_absolute()</TD>
+ <TD>fl_filename_absolute()</TD>
+</TR>
+<TR>
+ <TD>filename_expand()</TD>
+ <TD>fl_filename_expand()</TD>
+</TR>
+<TR>
+ <TD>filename_ext()</TD>
+ <TD>fl_filename_ext()</TD>
+</TR>
+<TR>
+ <TD>filename_isdir()</TD>
+ <TD>fl_filename_isdir()</TD>
+</TR>
+<TR>
+ <TD>filename_list()</TD>
+ <TD>fl_filename_list()</TD>
+</TR>
+<TR>
+ <TD>filename_match()</TD>
+ <TD>fl_filename_match()</TD>
+</TR>
+<TR>
+ <TD>filename_name()</TD>
+ <TD>fl_filename_name()</TD>
+</TR>
+<TR>
+ <TD>filename_relative()</TD>
+ <TD>fl_filename_relative()</TD>
+</TR>
+<TR>
+ <TD>frame()</TD>
+ <TD>fl_frame()</TD>
+</TR>
+<TR>
+ <TD>inactive()</TD>
+ <TD>fl_inactive()</TD>
+</TR>
+</TABLE></CENTER>
+
<H2>Image Support</H2>
<P>Image support in FLTK has been significantly revamped in