diff options
| author | Yuval Adam <yuv.adm@gmail.com> | 2014-08-08 14:42:07 +0300 |
|---|---|---|
| committer | Yuval Adam <yuv.adm@gmail.com> | 2014-08-08 14:42:07 +0300 |
| commit | a6163888f3c56123b1db313743c6147ba498732c (patch) | |
| tree | ff7d15d991d1d09ba6cbc0cec80924f57445bfdd /third_party/windows/fltk-1.1.10/documentation/Fl_Group.html | |
| parent | c3e4c9a25c2910d2d66d52215b3406b13d5b23d5 (diff) | |
Add third_party libs
Diffstat (limited to 'third_party/windows/fltk-1.1.10/documentation/Fl_Group.html')
| -rw-r--r-- | third_party/windows/fltk-1.1.10/documentation/Fl_Group.html | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/third_party/windows/fltk-1.1.10/documentation/Fl_Group.html b/third_party/windows/fltk-1.1.10/documentation/Fl_Group.html new file mode 100644 index 0000000..cba185d --- /dev/null +++ b/third_party/windows/fltk-1.1.10/documentation/Fl_Group.html @@ -0,0 +1,190 @@ +<HTML>
+<HEAD>
+ <TITLE>Fl_Group</TITLE>
+</HEAD>
+<BODY>
+<!-- NEW PAGE -->
+<H2><A name=Fl_Group>class Fl_Group</A></H2>
+<HR>
+<H3>Class Hierarchy</H3>
+<UL>
+<PRE>
+<A href=Fl_Widget.html#Fl_Widget>Fl_Widget</A>
+ |
+ +----<B>Fl_Group</B>
+ |
+ +----<A href=Fl_Browser_.html#Fl_Browser_>Fl_Browser_</A>, <A href=Fl_Color_Chooser.html#Fl_Color_Chooser>Fl_Color_Chooser</A>, <A href=Fl_Help_View.html#Fl_Help_View>Fl_Help_View</A>, <A href=Fl_Input_Choice.html#Fl_Input_Choice>Fl_Input_Choice</A>, <A href=Fl_Pack.html#Fl_Pack>Fl_Pack</A>,
+ <A href=Fl_Scroll.html#Fl_Scroll>Fl_Scroll</A>, <A href=Fl_Tabs.html#Fl_Tabs>Fl_Tabs</A>, <A href=Fl_Spinner.html#Fl_Spinner>Fl_Spinner</A>, <A href=Fl_Tabs.html#Fl_Tabs>Fl_Tabs</A>, <A href=Fl_Text_Display.html#Fl_Text_Display>Fl_Text_Display</A>, <A href=Fl_Tile.html#Fl_Tile>Fl_Tile</A>,
+ <A href=Fl_Window.html#Fl_Window>Fl_Window</A>, <A href=Fl_Wizard.html#Fl_Wizard>Fl_Wizard</A>
+</PRE>
+</UL>
+<H3>Include Files</H3>
+<UL>
+<PRE>
+#include <FL/Fl_Group.H>
+</PRE>
+</UL>
+<H3>Description</H3>
+ The <TT>Fl_Group</TT> class is the FLTK container widget. It maintains
+an array of child widgets. These children can themselves be any widget
+including <TT>Fl_Group</TT>. The most important subclass of <TT>Fl_Group</TT>
+ is <A href=Fl_Window.html#Fl_Window><TT>Fl_Window</TT></A>, however
+groups can also be used to control radio buttons or to enforce resize
+behavior.
+<H3>Methods</H3>
+<CENTER>
+<TABLE width=90% summary="Fl_Group methods.">
+<TR><TD align=left valign=top>
+<UL>
+<LI><A href=#Fl_Group.Fl_Group>Fl_Group</A></LI>
+<LI><A href=#Fl_Group.~Fl_Group>~Fl_Group</A></LI>
+<LI><A href=#Fl_Group.add>add</A></LI>
+<LI><A href=#Fl_Group.add_resizable>add_resizable</A></LI>
+</UL>
+</TD><TD align=left valign=top>
+<UL>
+<LI><A href=#Fl_Group.array>array</A></LI>
+<LI><A href=#Fl_Group.begin>begin</A></LI>
+<LI><A href=#Fl_Group.child>child</A></LI>
+<LI><A href=#Fl_Group.children>children</A></LI>
+</UL>
+</TD><TD align=left valign=top>
+<UL>
+<LI><A href="#Fl_Group.clear">clear</A></LI>
+<LI><A href="#Fl_Group.clip_children">clip_children</A></LI>
+<LI><A href=#Fl_Group.current>current</A></LI>
+</UL>
+</TD><TD align=left valign=top>
+<UL>
+<LI><A href=#Fl_Group.end>end</A></LI>
+<LI><A href=#Fl_Group.find>find</A></LI>
+<LI><A href=#Fl_Group.init_sizes>init_sizes</A></LI>
+</UL>
+</TD><TD align=left valign=top>
+<UL>
+<LI><A href=#Fl_Group.insert>insert</A></LI>
+<LI><A href=#Fl_Group.remove>remove</A></LI>
+<LI><A href=#Fl_Group.resizable>resizable</A></LI>
+</UL>
+</TD></TR>
+</TABLE>
+</CENTER>
+<H4><A name=Fl_Group.Fl_Group>Fl_Group::Fl_Group(int x, int y, int w,
+int h, const char *label = 0)</A></H4>
+ Creates a new <TT>Fl_Group</TT> widget using the given position, size,
+and label string. The default boxtype is <TT>FL_NO_BOX</TT>.
+<H4><A name=Fl_Group.~Fl_Group>virtual Fl_Group::~Fl_Group()</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_Group</TT> and all of it's children can be automatic (local)
+variables, but you must declare the <TT>Fl_Group</TT> <I>first</I>, so
+that it is destroyed last.
+<H4><A name=Fl_Group.add>void Fl_Group::add(Fl_Widget &w)
+<BR> void Fl_Group::add(Fl_Widget *w)</A></H4>
+
+The widget is removed from it's current group (if any) and then added
+to the end of this group.
+
+<H4><A name="Fl_Group.clear">void Fl_Group::clear()</A></H4>
+
+<p>The <tt>clear()</tt> method deletes all child widgets from
+memory recursively.</p>
+
+<p>This method differs from the <a
+href='#Fl_Group.remove'><tt>remove()</tt></a> method in that it
+affects all child widgets and deletes them from memory.</p>
+
+<H4><A name="Fl_Group.clip_children">void Fl_Group::clip_children(int c);<br>
+int Fl_Group::clip_children();</A></H4>
+
+The first method controls whether the group widget clips the drawing of
+child widgets to its bounding box.
+
+<p>The second method returns the current clipping mode.
+
+<p>The default is to not clip (0) the drawing of child widgets.
+
+<H4><A name="Fl_Group.init_sizes">void Fl_Group::init_sizes()</A></H4>
+
+The <TT>Fl_Group</TT> widget keeps track of the original widget sizes and
+positions when resizing occurs so that if you resize a window back to its
+original size the widgets will be in the correct places. If you rearrange
+the widgets in your group, call this method to register the new arrangement
+with the <TT>Fl_Group</TT> that contains them.
+
+<H4><A name=Fl_Group.insert>void Fl_Group::insert(Fl_Widget &w, int n)</A></H4>
+
+The widget is removed from it's current group (if any) and then
+inserted into this group. It is put at index <TT>n</TT> (or at the end
+if <tt>n >= children()</tt>. This can also be used to rearrange
+the widgets inside a group.
+
+<H4>void Fl_Group::insert(Fl_Widget &w, Fl_Widget* beforethis)</H4>
+
+This does <tt>insert(w, find(beforethis))</tt>. This will append the
+widget if <tt>beforethis</tt> is not in the group.
+
+<H4><A name=Fl_Group.remove>void Fl_Group::remove(Fl_Widget &w)</A></H4>
+
+<p>Removes a widget from the group but does not delete it. This
+method does nothing if the widget is not a child of the
+group.</p>
+
+<p>This method differs from the <a
+href='#Fl_Group.clear'><tt>clear()</tt></a> method in that it
+only affects a single widget and does not delete it from
+memory.</p>
+
+<H4><A name=Fl_Group.current>static Fl_Group *Fl_Group::current()
+<BR> static void Fl_Group::current(Fl_Group *w)</A></H4>
+<TT>current()</TT> returns the currently active group. The Fl_Widget
+ constructor automatically does <tt>current()->add(widget)</tt> if this is not null.
+ To prevent new widgets from being added to a group, call <TT>Fl_Group::current(0)</TT>.
+<H4><A name=Fl_Group.begin>void Fl_Group::begin()</A></H4>
+<TT>begin()</TT> sets the current group so you can build the widget
+tree by just constructing the widgets. <TT>begin()</TT> is
+automatically called by the constructor for Fl_Group (and thus for
+Fl_Window as well). <TT>begin()</TT> <i>is exactly the same as</i> <TT>current(this)</TT>.
+<P><I>Don't forget to <TT>end()</TT> the group or window!</I></P>
+<H4><A name=Fl_Group.end>void Fl_Group::end()</A></H4>
+<TT>end()</TT> <i>is exactly the same as</i> <TT>current(this->parent())</TT>. Any new widgets
+added to the widget tree will be added to the parent of the group.
+<H4><A name=Fl_Group.array>const Fl_Widget **Fl_Group::array() const</A></H4>
+ Returns a pointer to the array of children. <I>This pointer is only
+ valid until the next time a child is added or removed.</I>
+<H4><A name=Fl_Group.child>Fl_Widget *Fl_Group::child(int n) const</A></H4>
+ Returns <tt>array()[n]</tt>. <i>No range checking is done!</i>
+<H4><A name=Fl_Group.children>int Fl_Group::children() const</A></H4>
+ Returns how many child widgets the group has.
+<H4><A name=Fl_Group.find>int Fl_Group::find(const Fl_Widget *w) const
+<BR> int Fl_Group::find(const Fl_Widget &w) const</A></H4>
+ Searches the child array for the widget and returns the index. Returns <A
+href=#Fl_Group.children><TT>children()</TT></A> if the widget is <TT>
+NULL</TT> or not found.
+<H4><A name=Fl_Group.resizable>void Fl_Group::resizable(Fl_Widget *box)
+<BR> void Fl_Group::resizable(Fl_Widget &box)
+<BR> Fl_Widget *Fl_Group::resizable() const</A></H4>
+ The resizable widget defines the resizing box for the group. When the
+group is resized it calculates a new size and position for all of its
+children. Widgets that are horizontally or vertically inside the
+dimensions of the box are scaled to the new size. Widgets outside the
+box are moved.
+<P>In these examples the gray area is the resizable:
+<BR></P>
+<P align=center><IMG align=TOP SRC="resizebox1.gif" ALT="Resizeable groups">
+<IMG align=TOP SRC="resizebox2.gif" ALT="Resizeable groups"></P>
+<P>The resizable may be set to the group itself (this is the default
+value for an <TT>Fl_Group</TT>, although <TT>NULL</TT> is the default
+for <TT>Fl_Window</TT> and <TT>Fl_Pack</TT>), in which case all the
+contents are resized.
+If the resizable is <TT>NULL</TT> then all widgets remain a fixed size
+and distance from the top-left corner. </P>
+<P>It is possible to achieve any type of resize behavior by using an
+invisible <TT>Fl_Box</TT> as the resizable and/or by using a hierarchy
+of child <TT>Fl_Group</TT>'s. </P>
+
+<H4><A name=Fl_Group.add_resizable>Fl_Group
+&Fl_Group::add_resizable(Fl_Widget &box)</A></H4>
+ Adds a widget to the group and makes it the resizable widget.
+</BODY></HTML>
|