Author: manolo
Date: 2011-12-07 05:40:39 -0800 (Wed, 07 Dec 2011)
New Revision: 9198
Log:
Fixed the Doxygen comments of the Fl_Overlay_Window class.
The description of Fl_Overlay_Window ::draw_overlay() didn't appear in Doxygen,
and Fl_Overlay_Window::can_do_overlay() wasn't commented.
Modified:
branches/branch-1.3/FL/Fl_Overlay_Window.H
branches/branch-1.3/src/Fl_Overlay_Window.cxx
Modified: branches/branch-1.3/FL/Fl_Overlay_Window.H
===================================================================
--- branches/branch-1.3/FL/Fl_Overlay_Window.H 2011-12-06 21:08:07 UTC (rev
9197)
+++ branches/branch-1.3/FL/Fl_Overlay_Window.H 2011-12-07 13:40:39 UTC (rev
9198)
@@ -36,8 +36,18 @@
overlay will blink if you change the image in the window.
*/
class FL_EXPORT Fl_Overlay_Window : public Fl_Double_Window {
+#ifndef FL_DOXYGEN
friend class _Fl_Overlay;
+#endif
+protected:
+ /**
+ You must subclass Fl_Overlay_Window 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 <FL/fl_draw.H>.
+ */
virtual void draw_overlay() = 0;
+private:
Fl_Window *overlay_;
public:
void show();
@@ -45,21 +55,24 @@
void hide();
void resize(int,int,int,int);
~Fl_Overlay_Window();
+ /** Returns non-zero if there's hardware overlay support */
int can_do_overlay();
void redraw_overlay();
+protected:
/**
- Creates a new Fl_Overlay_Window 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.
- */
+ See Fl_Overlay_Window::Fl_Overlay_Window(int X, int Y, int W, int H, const
char *l=0)
+ */
Fl_Overlay_Window(int W, int H, const char *l=0)
: Fl_Double_Window(W,H,l) {overlay_ = 0; force_doublebuffering_=1;
image(0); }
- /**
- See Fl_Overlay_Window::Fl_Overlay_Window(int W, int H, const char *l=0)
- */
- Fl_Overlay_Window(int X, int Y, int W, int H, const char *l=0)
+ /**
+ Creates a new Fl_Overlay_Window 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.
+ */
+ Fl_Overlay_Window(int X, int Y, int W, int H, const char *l=0)
: Fl_Double_Window(X,Y,W,H,l) {overlay_ = 0; force_doublebuffering_=1;
image(0); }
+public:
void show(int a, char **b) {Fl_Double_Window::show(a,b);}
};
Modified: branches/branch-1.3/src/Fl_Overlay_Window.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Overlay_Window.cxx 2011-12-06 21:08:07 UTC
(rev 9197)
+++ branches/branch-1.3/src/Fl_Overlay_Window.cxx 2011-12-07 13:40:39 UTC
(rev 9198)
@@ -16,19 +16,13 @@
// http://www.fltk.org/str.php
//
-/** \fn virtual void Fl_Overlay_Window::draw_overlay() = 0
- You must subclass Fl_Overlay_Window 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 <FL/fl_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.
#include <config.h>
-#include <FL/Fl.H>
+#include <FL/Fl.H>g
#include <FL/Fl_Overlay_Window.H>
#include <FL/fl_draw.H>
#include <FL/x.H>
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
