summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2003-07-18 05:53:21 +0000
committerMatthias Melcher <fltk@matthiasm.com>2003-07-18 05:53:21 +0000
commit4042047358c4a9ebb8f61007ec27c7f66fd0a79e (patch)
tree586cc59db657251c68e9bb3b32dbdac132c65b2b /documentation
parent91721061895a16fea93a866061e632c8a6556088 (diff)
updated documentation and Fl_Dial. STR #101, 94, 99
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@3049 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Fl_Double_Window.html5
-rw-r--r--documentation/Fl_Menu_.html22
-rw-r--r--documentation/drawing.html15
3 files changed, 32 insertions, 10 deletions
diff --git a/documentation/Fl_Double_Window.html b/documentation/Fl_Double_Window.html
index 25161e516..bfc5ad5c8 100644
--- a/documentation/Fl_Double_Window.html
+++ b/documentation/Fl_Double_Window.html
@@ -34,7 +34,6 @@ does not exist for every visual.
<UL>
<LI><A href=#Fl_Double_Window.Fl_Double_Window>Fl_Double_Window</A></LI>
<LI><A href=#Fl_Double_Window.~Fl_Double_Window>~Fl_Double_Window</A></LI>
-<LI><A href=#Fl_Double_Window.pixmap>pixmap</A></LI>
</UL>
<H4><A name=Fl_Double_Window.Fl_Double_Window>
Fl_Double_Window::Fl_Double_Window(int x, int y, int w, int h, const
@@ -46,8 +45,4 @@ Fl_Double_Window::~Fl_Double_Window()</A></H4>
The destructor <I>also deletes all the children</I>. This allows a
whole tree to be deleted at once, without having to keep a pointer to
all the children in the user code.
-<H4><A name="Fl_Double_Window.pixmap">ulong Fl_Double_Window::pixmap() const</a></h4>
-
-Returns the off-screen pixmap or back buffer. This value is zero until
-the first time <tt>flush()</tt> is called.
</BODY></HTML>
diff --git a/documentation/Fl_Menu_.html b/documentation/Fl_Menu_.html
index bc34198f6..7a1bbe7f5 100644
--- a/documentation/Fl_Menu_.html
+++ b/documentation/Fl_Menu_.html
@@ -111,7 +111,9 @@ item at the end. To copy a menu array you need to copy
<TT>NULL</TT> this returns zero (an empty menu will return 1).
<H4><A name=Fl_Menu_.add>int Fl_Menu_::add(const char* label, const
-char* shortcut, Fl_Callback*, void *user_data=0, int flags=0)</a></h4>
+char* shortcut, Fl_Callback*, void *user_data=0, int flags=0)</a><br>
+int Fl_Menu_::add(const char* label, int shortcut, Fl_Callback*,
+void *user_data=0, int flags=0)</h4>
Adds a new menu item, with a <TT>title</TT> string, <TT> shortcut</TT>
string, <TT>callback</TT>, argument to the callback, and flags. If
@@ -129,6 +131,24 @@ this new one. Otherwise this new one is added to the end of the
correct menu or submenu. The return value is the offset into the array
that the new entry was placed at.</P>
+<P>Shortcut can be 0L, or either a modifier/key combination (for example
+FL_CTRL+'A') or a string describing the shortcut in one of two ways:</p>
+
+<pre>
+ [#+^]<ascii_value>     eg. "97", "^97", "+97", "#97"
+ [#+^]<ascii_char>      eg. "a", "^a", "+a", "#a"
+</pre>
+..where <ascii_value> is a decimal value representing an ascii character
+(eg. 97 is the ascii for 'a'), and the optional prefixes enhance the value
+that follows. Multiple prefixes must appear in the above order.
+<pre>
+ # - Alt
+ + - Shift
+ ^ - Control
+</pre>
+Text shortcuts are converted to integer shortcut by calling
+<tt>int fl_old_shortcut(const char*)</tt>.
+
<P>The return value is the index into the array that the entry was put. </P>
<h4>int Fl_Menu_::add(const char *)</H4>
diff --git a/documentation/drawing.html b/documentation/drawing.html
index e88eed887..375649af6 100644
--- a/documentation/drawing.html
+++ b/documentation/drawing.html
@@ -494,11 +494,16 @@ want a circle as part of a complex polygon you must use <TT>fl_arc()</TT>.
It is undefined whether this location or the characters are
modified by the current transformation.
-<H4>void fl_draw(const char *, float x, float y)
-<BR>void fl_draw(const char *, int n, float x, float y)</H4>
+<H4>void fl_draw(const char *, int x, int y)
+<BR>void fl_draw(const char *, int n, int x, int y)</H4>
<P>Draw a nul-terminated string or an array of <TT>n</TT> characters
-starting at the given location.
+starting at the given location. Text is aligned to the left and to
+the baseline of the font. To align to the bottom, subtract fl_descent() from
+<i>y</i>. To align to the top, subtract fl_descent() and add fl_height().
+This version of fl_draw provides direct access to
+the text drawing function of the underlying OS. It does not apply any
+special handling to control characters.
<H4>void fl_draw(const char *, int x, int y, int w, int h,
Fl_Align align, Fl_Image *img = 0, int draw_symbols = 1)</H4>
@@ -507,7 +512,7 @@ Fl_Align align, Fl_Image *img = 0, int draw_symbols = 1)</H4>
labels. The string is formatted and aligned inside the passed
box. Handles '\t' and '\n', expands all other control
characters to ^X, and aligns inside or against the edges of the
-box. See <A
+box described by <i>x</i>, <i>y</i>, <i>w</i> and <i>h</i>. See <A
href="Fl_Widget.html#Fl_Widget.align"><TT>Fl_Widget::align()</TT></A>
for values for <TT>align</TT>. The value
<TT>FL_ALIGN_INSIDE</TT> is ignored, as this function always
@@ -520,6 +525,8 @@ image is drawn above or below the text as specified by the
<P>The <TT>draw_symbols</TT> argument specifies whether or not
to look for symbol names starting with the "@" character.
+<P>The text length is limited to 1024 caracters per line.
+
<H4>void fl_measure(const char *, int &amp;w, int &amp;h, int draw_symbols = 1)</H4>
<P>Measure how wide and tall the string will be when printed by