summaryrefslogtreecommitdiff
path: root/documentation/Fl_Overlay_Window.html
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-14 22:12:25 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-14 22:12:25 +0000
commit497afccb07164373e0de6639e754d7d691f1926f (patch)
tree449d0b92ceb05f39617fe8fc2876d16eecde7460 /documentation/Fl_Overlay_Window.html
parente08fffdfe08bbc9320e39a15d162b6501abd4925 (diff)
Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Overlay_Window.html')
-rw-r--r--documentation/Fl_Overlay_Window.html59
1 files changed, 0 insertions, 59 deletions
diff --git a/documentation/Fl_Overlay_Window.html b/documentation/Fl_Overlay_Window.html
deleted file mode 100644
index bf5f9e333..000000000
--- a/documentation/Fl_Overlay_Window.html
+++ /dev/null
@@ -1,59 +0,0 @@
-<HTML>
-<HEAD>
- <TITLE>Fl_Overlay_Window</TITLE>
-</HEAD>
-<BODY>
-<!-- NEW PAGE -->
-<H2><A name=Fl_Overlay_Window>class Fl_Overlay_Window</A></H2>
-<HR>
-<H3>Class Hierarchy</H3>
-<UL>
-<PRE>
-<A href=Fl_Double_Window.html#Fl_Double_Window>Fl_Double_Window</A>
- |
- +----<B>Fl_Overlay_Window</B>
-</PRE>
-</UL>
-<H3>Include Files</H3>
-<UL>
-<PRE>
-#include &lt;FL/Fl_Overlay_Window.H&gt;
-</PRE>
-</UL>
-<H3>Description</H3>
- This window provides double buffering and also the ability to draw the
-&quot;overlay&quot; which is another picture placed on top of the main image. The
-overlay is designed to be a rapidly-changing but simple graphic such as
-a mouse selection box. <TT>Fl_Overlay_Window</TT> uses the overlay
-planes provided by your graphics hardware if they are available.
-<P>If no hardware support is found the overlay is simulated by drawing
-directly into the on-screen copy of the double-buffered window, and
-&quot;erased&quot; by copying the backbuffer over it again. This means the
-overlay will blink if you change the image in the window. </P>
-<H3>Methods</H3>
-<UL>
-<LI><A href=#Fl_Overlay_Window.Fl_Overlay_Window>Fl_Overlay_Window</A></LI>
-<LI><A href=#Fl_Overlay_Window.~Fl_Overlay_Window>~Fl_Overlay_Window</A></LI>
-<LI><A href=#Fl_Overlay_Window.draw_overlay>draw_overlay</A></LI>
-<LI><A href=#Fl_Overlay_Window.redraw_overlay>redraw_overlay</A></LI>
-</UL>
-<H4><A name=Fl_Overlay_Window.Fl_Overlay_Window>
-Fl_Overlay_Window::Fl_Overlay_Window(int x, int y, int w, int h, const
-char *label = 0)</A></H4>
- Creates a new <TT>Fl_Overlay_Window</TT> widget using the given
-position, size, and label (title) string.
-<H4><A name=Fl_Overlay_Window.~Fl_Overlay_Window>virtual
-Fl_Overlay_Window::~Fl_Overlay_Window()</A></H4>
- Destroys the window and all child widgets.
-<H4><A name=Fl_Overlay_Window.draw_overlay>virtual void
-Fl_Overlay_Window::draw_overlay() = 0</A></H4>
- You must subclass <TT>Fl_Overlay_Window</TT> and provide this method.
- It is just like a <TT>draw()</TT> method, except it draws the overlay.
- The overlay will have already been &quot;cleared&quot; when this is called. You
-can use any of the routines described in <A href="drawing.html#drawing">&lt;FL/fl_draw.H&gt;</A>.
-<H4><A name=Fl_Overlay_Window.redraw_overlay>void Fl_Overlay_Window::redraw_overlay()</A>
-</H4>
- Call this to indicate that the overlay data has changed and needs to
-be redrawn. The overlay will be clear until the first time this is
-called, so if you want an initial display you must call this after
-calling <TT>show()</TT>. </BODY></HTML>