Author: manolo
Date: 2011-12-07 05:49:55 -0800 (Wed, 07 Dec 2011)
New Revision: 9199
Log:
Fixed the Doxygen comments of the Fl_Overlay_Window class.
Modified:
branches/branch-3.0/include/fltk3/OverlayWindow.h
branches/branch-3.0/src/fltk3/OverlayWindow.cxx
branches/branch-3.0/src/fltk3/screen_xywh.cxx
Modified: branches/branch-3.0/include/fltk3/OverlayWindow.h
===================================================================
--- branches/branch-3.0/include/fltk3/OverlayWindow.h 2011-12-07 13:40:39 UTC
(rev 9198)
+++ branches/branch-3.0/include/fltk3/OverlayWindow.h 2011-12-07 13:49:55 UTC
(rev 9199)
@@ -48,8 +48,16 @@
overlay will blink if you change the image in the window.
*/
class FLTK3_EXPORT OverlayWindow : public fltk3::DoubleWindow {
+#ifndef FLTK3_DOXYGEN
friend class _Fl_Overlay;
+#endif
protected:
+ /**
+ You must subclass fltk3::OverlayWindow and provide this method.
+ It is just like a draw() method, except it draws the overlay.
+ The overlay will have already been "cleared" when this is called. You
+ can use any of the routines described in <fltk3/draw.h>.
+ */
virtual void draw_overlay() { /* must be overridden */ }
fltk3::Window *overlay_;
public:
@@ -58,19 +66,20 @@
void hide();
void resize(int,int,int,int);
~OverlayWindow();
+ /** Returns non-zero if there's hardware overlay support */
int can_do_overlay();
void redraw_overlay();
/**
+ See fltk3::OverlayWindow::OverlayWindow(int X, int Y, int W, int H, const
char *l)
+ */
+ OverlayWindow(int W, int H, const char *l=0)
+ : fltk3::DoubleWindow(W,H,l) {overlay_ = 0; force_doublebuffering_=1;
image(0); }
+ /**
Creates a new fltk3::OverlayWindow widget using the given
position, size, and label (title) string. If the
positions (x,y) are not given, then the window manager
will choose them.
*/
- OverlayWindow(int W, int H, const char *l=0)
- : fltk3::DoubleWindow(W,H,l) {overlay_ = 0; force_doublebuffering_=1;
image(0); }
- /**
- See fltk3::OverlayWindow::OverlayWindow(int W, int H, const char *l=0)
- */
OverlayWindow(int X, int Y, int W, int H, const char *l=0)
: fltk3::DoubleWindow(X,Y,W,H,l) {overlay_ = 0; force_doublebuffering_=1;
image(0); }
void show(int a, char **b) {DoubleWindow::show(a,b);}
Modified: branches/branch-3.0/src/fltk3/OverlayWindow.cxx
===================================================================
--- branches/branch-3.0/src/fltk3/OverlayWindow.cxx 2011-12-07 13:40:39 UTC
(rev 9198)
+++ branches/branch-3.0/src/fltk3/OverlayWindow.cxx 2011-12-07 13:49:55 UTC
(rev 9199)
@@ -25,13 +25,6 @@
// http://www.fltk.org/str.php
//
-/** \fn virtual void fltk3::OverlayWindow::draw_overlay() = 0
- You must subclass fltk3::OverlayWindow and provide this method.
- It is just like a draw() method, except it draws the overlay.
- The overlay will have already been "cleared" when this is called. You
- can use any of the routines described in <fltk3/draw.h>.
-*/
-
// A window using double-buffering and able to draw an overlay
// on top of that. Uses the hardware to draw the overlay if
// possible, otherwise it just draws in the front buffer.
Modified: branches/branch-3.0/src/fltk3/screen_xywh.cxx
===================================================================
--- branches/branch-3.0/src/fltk3/screen_xywh.cxx 2011-12-07 13:40:39 UTC
(rev 9198)
+++ branches/branch-3.0/src/fltk3/screen_xywh.cxx 2011-12-07 13:49:55 UTC
(rev 9199)
@@ -181,7 +181,7 @@
}
#endif // WIN32
-#ifndef FL_DOXYGEN
+#ifndef FLTK3_DOXYGEN
void fltk3::call_screen_init() {
screen_init();
}
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
