diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-13 19:28:54 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-13 19:28:54 +0000 |
| commit | d7b88a3bcc7e76f38ee5799be7722fd5a10781ef (patch) | |
| tree | d8984d45424c9b2cdb199c1918f38bfea4a8211d /documentation/Fl_Scroll.html | |
| parent | 30fa233681467b82b165e7d42cd0bea778b93768 (diff) | |
Updated all links so they work between files.
Revision 1.
git-svn-id: file:///fltk/svn/fltk/trunk@219 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Scroll.html')
| -rw-r--r-- | documentation/Fl_Scroll.html | 232 |
1 files changed, 98 insertions, 134 deletions
diff --git a/documentation/Fl_Scroll.html b/documentation/Fl_Scroll.html index 41136476c..2140e93d1 100644 --- a/documentation/Fl_Scroll.html +++ b/documentation/Fl_Scroll.html @@ -1,135 +1,99 @@ -<html> -<body> - -<hr break> - -<h2><a name="Fl_Scroll">class Fl_Scroll</a></h2> - -<hr> - -<h3>Class Hierarchy</h3> - -<ul><pre> -<a href="#Fl_Group">Fl_Group</a> +<HTML><BODY> +<HR break> +<H2><A name=Fl_Scroll>class Fl_Scroll</A></H2> +<HR> +<H3>Class Hierarchy</H3> +<UL> +<PRE> +<A href=Fl_Group.html#Fl_Group>Fl_Group</A> | - +----<b>Fl_Scroll</b> -</pre></ul> - -<h3>Include Files</h3> - -<ul><pre> -#include <FL/Fl_Scroll.H> -</pre></ul> - -<h3>Description</h3> - -This container widget lets you maneuver around a set of widgets -much larger than your window. If the child widgets are larger than -the size of this object then scrollbars will appear so that you can -scroll over to them: - -<p><img src=Fl_Scroll.gif> - -<p>If all of the child widgets are packed together into a solid -rectangle then you want to set <tt>box()</tt> to <tt>FL_NO_BOX</tt> or -one of the <tt>_FRAME</tt> types. This will result in the best output. -However, if the child widgets are a sparse arrangment you must set -<tt>box()</tt> to a real <tt>_BOX</tt> type. This can result in some -blinking during redrawing, but that can be solved by using a -<tt>Fl_Double_Window</tt>. - -<p>This widget can also be used to pan around a single child widget -"canvas". This child widget should be of your own class, with a -<tt>draw()</tt> method that draws the contents. The scrolling is done -by changing the <tt>x()</tt> and <tt>y()</tt> of the widget, so this -child must use the <tt>x()</tt> and <tt>y()</tt> to position it's -drawing. To speed up drawing it should test <a -href=fl_clip><tt>fl_clip()</tt></a>. - -<p>Another very useful child is a single <a -href="#Fl_Pack"><tt>Fl_Pack</tt></a>, which is itself a group that -packs it's children together and changes size to surround them. -Filling the <tt>Fl_Pack</tt> with <a href="#Fl_Tab"><tt>Fl_Tab</tt></a> -groups (and then putting normal widgets inside those) gives you a very -powerful scrolling list of individually-openable panels. - -<p>Fluid lets you create these, but you can only lay out objects that -fit inside the <tt>Fl_Scroll</tt> without scrolling. Be sure to leave -space for the scrollbars, as Fluid won't show these either. - -<p><i>You cannot use <tt>Fl_Window</tt> as a child of this since the -clipping is not conveyed to it when drawn, and it will draw over the -scrollbars and neighboring objects.</i> - -<h3>Methods</h3> - -<ul> - <li><a href="#Fl_Scroll.Fl_Scroll">Fl_Scroll</a> - <li><a href="#Fl_Scroll.~Fl_Scroll">~Fl_Scroll</a> - <li><a href="#Fl_Scroll.align">align</a> - <li><a href="#Fl_Scroll.position">position</a> - <li><a href="#Fl_Scroll.type">type</a> - <li><a href="#Fl_Scroll.xposition">xposition</a> - <li><a href="#Fl_Scroll.yposition">yposition</a> -</ul> - -<h4><a name="Fl_Scroll.Fl_Scroll">Fl_Scroll::Fl_Scroll(int x, int y, int w, int h, const char *label = 0)</a></h4> - -Creates a new <tt>Fl_Scroll</tt> widget using the given position, size, and -label string. The default boxtype is <tt>FL_NO_BOX</tt>. - -<h4><a name="Fl_Scroll.~Fl_Scroll">virtual Fl_Scroll::~Fl_Scroll()</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. A kludge has been done so the -<tt>Fl_Scroll</tt> and all of it's children can be automatic (local) -variables, but you must declare the <tt>Fl_Scroll</tt> <i>first</i>, so -that it is destroyed last. - -<h4><a name="Fl_Scroll.type">void Fl_Widget::type(int)</a></h4> - -By default you can scroll in both directions, and the scrollbars -disappear if the data will fit in the area of the scroll. <tt>type()</tt> -can change this: - -<ul> - <li><tt>0</tt> - No scrollbars - - <li><tt>Fl_Scroll::HORIZONTAL</tt> - Only a horizontal scrollbar. - - <li><tt>Fl_Scroll::VERTICAL</tt> - Only a vertical scrollbar. - - <li><tt>Fl_Scroll::BOTH</tt> - The default is both scrollbars. - - <li><tt>Fl_Scroll::HORIZONTAL_ALWAYS</tt> - Horizontal scrollbar - always on, vertical always off. - - <li><tt>Fl_Scroll::VERTICAL_ALWAYS</tt> - Vertical scrollbar always on, - horizontal always off. - - <li><tt>Fl_Scroll::BOTH_ALWAYS</tt> - Both always on. -</ul> - -<h4><a name="Fl_Scroll.align">void Fl_Scroll::scrollbar.align(int)<br> -void Fl_Scroll::hscrollbar.align(int)</a></h4> - -This is used to change what side the scrollbars are drawn on. If the -<tt>FL_ALIGN_LEFT</tt> bit is on, the vertical scrollbar is on the -left. If the <tt>FL_ALIGN_TOP</tt> bit is on, the horizontal scrollbar -is on the top. - -<h4><a name="Fl_Scroll.xposition">int Fl_Scroll::xposition() const</a></h4> - -Gets the current horizontal scrolling position. - -<h4><a name="Fl_Scroll.yposition">int Fl_Scroll::yposition() const</a></h4> - -Gets the current vertical scrolling position. - -<h4><a name="Fl_Scroll.position">void Fl_Scroll::position(int w, int h)</a></h4> - -Sets the upper-lefthand corner of the scrolling region. - -</body> -</html> + +----<B>Fl_Scroll</B> +</PRE> +</UL> +<H3>Include Files</H3> +<UL> +<PRE> +#include <FL/Fl_Scroll.H> +</PRE> +</UL> +<H3>Description</H3> + This container widget lets you maneuver around a set of widgets much +larger than your window. If the child widgets are larger than the size +of this object then scrollbars will appear so that you can scroll over +to them: +<P><IMG src=./Fl_Scroll.gif></P> +<P>If all of the child widgets are packed together into a solid +rectangle then you want to set <TT>box()</TT> to <TT>FL_NO_BOX</TT> or +one of the <TT>_FRAME</TT> types. This will result in the best output. + However, if the child widgets are a sparse arrangment you must set <TT> +box()</TT> to a real <TT>_BOX</TT> type. This can result in some +blinking during redrawing, but that can be solved by using a <TT> +Fl_Double_Window</TT>. </P> +<P>This widget can also be used to pan around a single child widget +"canvas". This child widget should be of your own class, with a <TT> +draw()</TT> method that draws the contents. The scrolling is done by +changing the <TT>x()</TT> and <TT>y()</TT> of the widget, so this child +must use the <TT>x()</TT> and <TT>y()</TT> to position it's drawing. + To speed up drawing it should test <A href=fl_clip><TT>fl_clip()</TT></A> +. </P> +<P>Another very useful child is a single <A href=Fl_Pack.html#Fl_Pack><TT> +Fl_Pack</TT></A>, which is itself a group that packs it's children +together and changes size to surround them. Filling the <TT>Fl_Pack</TT> + with <A href=#Fl_Tab><TT>Fl_Tab</TT></A> groups (and then putting +normal widgets inside those) gives you a very powerful scrolling list +of individually-openable panels. </P> +<P>Fluid lets you create these, but you can only lay out objects that +fit inside the <TT>Fl_Scroll</TT> without scrolling. Be sure to leave +space for the scrollbars, as Fluid won't show these either. </P> +<P><I>You cannot use <TT>Fl_Window</TT> as a child of this since the +clipping is not conveyed to it when drawn, and it will draw over the +scrollbars and neighboring objects.</I></P> +<H3>Methods</H3> +<UL> +<LI><A href=#Fl_Scroll.Fl_Scroll>Fl_Scroll</A></LI> +<LI><A href=#Fl_Scroll.~Fl_Scroll>~Fl_Scroll</A></LI> +<LI><A href=#Fl_Scroll.align>align</A></LI> +<LI><A href=#Fl_Scroll.position>position</A></LI> +<LI><A href=#Fl_Scroll.type>type</A></LI> +<LI><A href=#Fl_Scroll.xposition>xposition</A></LI> +<LI><A href=#Fl_Scroll.yposition>yposition</A></LI> +</UL> +<H4><A name=Fl_Scroll.Fl_Scroll>Fl_Scroll::Fl_Scroll(int x, int y, int +w, int h, const char *label = 0)</A></H4> + Creates a new <TT>Fl_Scroll</TT> widget using the given position, +size, and label string. The default boxtype is <TT>FL_NO_BOX</TT>. +<H4><A name=Fl_Scroll.~Fl_Scroll>virtual Fl_Scroll::~Fl_Scroll()</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. A kludge has been done so the <TT> +Fl_Scroll</TT> and all of it's children can be automatic (local) +variables, but you must declare the <TT>Fl_Scroll</TT><I>first</I>, so +that it is destroyed last. +<H4><A name=Fl_Scroll.type>void Fl_Widget::type(int)</A></H4> + By default you can scroll in both directions, and the scrollbars +disappear if the data will fit in the area of the scroll. <TT>type()</TT> + can change this: +<UL> +<LI><TT>0</TT> - No scrollbars </LI> +<LI><TT>Fl_Scroll::HORIZONTAL</TT> - Only a horizontal scrollbar. </LI> +<LI><TT>Fl_Scroll::VERTICAL</TT> - Only a vertical scrollbar. </LI> +<LI><TT>Fl_Scroll::BOTH</TT> - The default is both scrollbars. </LI> +<LI><TT>Fl_Scroll::HORIZONTAL_ALWAYS</TT> - Horizontal scrollbar + always on, vertical always off. </LI> +<LI><TT>Fl_Scroll::VERTICAL_ALWAYS</TT> - Vertical scrollbar always on, + horizontal always off. </LI> +<LI><TT>Fl_Scroll::BOTH_ALWAYS</TT> - Both always on. </LI> +</UL> +<H4><A name=Fl_Scroll.align>void Fl_Scroll::scrollbar.align(int) +<BR> void Fl_Scroll::hscrollbar.align(int)</A></H4> + This is used to change what side the scrollbars are drawn on. If the <TT> +FL_ALIGN_LEFT</TT> bit is on, the vertical scrollbar is on the left. + If the <TT>FL_ALIGN_TOP</TT> bit is on, the horizontal scrollbar is on +the top. +<H4><A name=Fl_Scroll.xposition>int Fl_Scroll::xposition() const</A></H4> + Gets the current horizontal scrolling position. +<H4><A name=Fl_Scroll.yposition>int Fl_Scroll::yposition() const</A></H4> + Gets the current vertical scrolling position. +<H4><A name=Fl_Scroll.position>void Fl_Scroll::position(int w, int h)</A> +</H4> + Sets the upper-lefthand corner of the scrolling region. </BODY></HTML>
\ No newline at end of file |