summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl_Copy_Surface.H21
-rw-r--r--FL/Fl_Gl_Window_Driver.H11
-rw-r--r--FL/Fl_Graphics_Driver.H18
-rw-r--r--FL/Fl_Image_Surface.H11
-rw-r--r--FL/Fl_Native_File_Chooser.H11
-rw-r--r--FL/Fl_PostScript.H13
-rw-r--r--FL/Fl_Screen_Driver.H22
-rw-r--r--FL/Fl_System_Driver.H11
-rw-r--r--FL/Fl_Window_Driver.H22
9 files changed, 125 insertions, 15 deletions
diff --git a/FL/Fl_Copy_Surface.H b/FL/Fl_Copy_Surface.H
index ffe24fe83..fbf710c4d 100644
--- a/FL/Fl_Copy_Surface.H
+++ b/FL/Fl_Copy_Surface.H
@@ -66,10 +66,19 @@ public:
};
-/** A base class describing the interface between FLTK and draw-to-clipboard operations.
- This class is only for internal use by the FLTK library.
- A supported platform should implement the virtual methods of this class
- in order to support drawing to the clipboard through class Fl_Copy_Surface.
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
+/**
+ * A base class describing the interface between FLTK and draw-to-clipboard operations.
+ *
+ * This class is only for internal use by the FLTK library.
+ *
+ * A supported platform should implement the virtual methods of this class
+ * in order to support drawing to the clipboard through class Fl_Copy_Surface.
*/
class Fl_Copy_Surface_Driver : public Fl_Widget_Surface {
friend class Fl_Copy_Surface;
@@ -90,6 +99,10 @@ protected:
static Fl_Copy_Surface_Driver *newCopySurfaceDriver(int w, int h);
};
+/**
+ * @}
+ * @endcond
+ */
#endif // Fl_Copy_Surface_H
diff --git a/FL/Fl_Gl_Window_Driver.H b/FL/Fl_Gl_Window_Driver.H
index 1b5d36bfd..ccad677b7 100644
--- a/FL/Fl_Gl_Window_Driver.H
+++ b/FL/Fl_Gl_Window_Driver.H
@@ -17,6 +17,12 @@
// http://www.fltk.org/str.php
//
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
#ifndef Fl_Gl_Window_Driver_H
#define Fl_Gl_Window_Driver_H
@@ -202,6 +208,11 @@ class Fl_X11_Gl_Window_Driver : public Fl_Gl_Window_Driver {
#endif /* Fl_Gl_Window_Driver_H */
+/**
+ * @}
+ * @endcond
+ */
+
//
// End of "$Id$".
//
diff --git a/FL/Fl_Graphics_Driver.H b/FL/Fl_Graphics_Driver.H
index 96aed31b5..f80934bce 100644
--- a/FL/Fl_Graphics_Driver.H
+++ b/FL/Fl_Graphics_Driver.H
@@ -17,6 +17,12 @@
// http://www.fltk.org/str.php
//
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
/** \file Fl_Graphics_Driver.H
\brief declaration of class Fl_Graphics_Driver.
*/
@@ -51,6 +57,7 @@ struct Fl_Fontdesc;
#define FL_REGION_STACK_SIZE 10
#define FL_MATRIX_STACK_SIZE 32
+
/**
An abstract class subclassed for each graphics driver FLTK uses.
Typically, FLTK applications do not use directly objects from this class. Rather, they perform
@@ -58,14 +65,14 @@ struct Fl_Fontdesc;
Drawing operations are functionally presented in \ref drawing and as function lists
in the \ref fl_drawings and \ref fl_attributes modules.
- \p <tt>Fl_Surface_Device::surface()->driver()</tt>
+ <tt>Fl_Surface_Device::surface()->driver()</tt>
gives at any time the graphics driver used by all drawing operations.
For compatibility with older FLTK versions, the \ref fl_graphics_driver global variable gives the same result.
Its value changes when
drawing operations are directed to another drawing surface by Fl_Surface_Device::push_current() /
Fl_Surface_Device::pop_current() / Fl_Surface_Device::set_current().
- \p The Fl_Graphics_Driver class is of interest if one wants to perform new kinds of drawing operations.
+ The Fl_Graphics_Driver class is of interest if one wants to perform new kinds of drawing operations.
An example would be to draw to an SVG file. This would require to create a new class,
say SVG_Graphics_Driver, derived from class Fl_Graphics_Driver, and another new class,
say SVG_Surface, derived from class Fl_Surface_Device. The new SVG_Graphics_Driver class should
@@ -73,7 +80,7 @@ struct Fl_Fontdesc;
and have them draw into SVG files. Alternatively, class SVG_Graphics_Driver could implement only some
virtual methods, and only part of FLTK drawing functions would be usable when drawing to SVG files.
- \p The Fl_Graphics_Driver class is essential for developers of the FLTK library.
+ The Fl_Graphics_Driver class is essential for developers of the FLTK library.
Each platform supported by FLTK requires to create a derived class of Fl_Graphics_Driver that
implements all its virtual member functions according to the platform.
*/
@@ -550,6 +557,11 @@ protected:
#endif // FL_GRAPHICS_DRIVER_H
+/**
+ * @}
+ * @endcond
+ */
+
//
// End of "$Id$".
//
diff --git a/FL/Fl_Image_Surface.H b/FL/Fl_Image_Surface.H
index e411822c9..69093ecf1 100644
--- a/FL/Fl_Image_Surface.H
+++ b/FL/Fl_Image_Surface.H
@@ -90,6 +90,12 @@ public:
};
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
/** A base class describing the interface between FLTK and draw-to-image operations.
This class is only for internal use by the FLTK library.
A supported platform should implement the virtual methods of this class
@@ -116,6 +122,11 @@ protected:
static Fl_Image_Surface_Driver *newImageSurfaceDriver(int w, int h, int high_res, Fl_Offscreen off);
};
+/**
+ * @}
+ * @endcond
+ */
+
#endif // Fl_Image_Surface_H
//
diff --git a/FL/Fl_Native_File_Chooser.H b/FL/Fl_Native_File_Chooser.H
index ec88a925f..22b5dd354 100644
--- a/FL/Fl_Native_File_Chooser.H
+++ b/FL/Fl_Native_File_Chooser.H
@@ -167,6 +167,12 @@ public:
int show() ;
};
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
/** Represents the interface between FLTK and a native file chooser.
This class is only for internal use by the FLTK library.
A platform that wants to provide a native file chooser implements all virtual methods
@@ -258,6 +264,11 @@ public:
virtual int show() ;
};
+/**
+ * @}
+ * @endcond
+ */
+
#endif /*FL_NATIVE_FILE_CHOOSER_H*/
diff --git a/FL/Fl_PostScript.H b/FL/Fl_PostScript.H
index 2272c6316..de90bd225 100644
--- a/FL/Fl_PostScript.H
+++ b/FL/Fl_PostScript.H
@@ -33,6 +33,12 @@ extern "C" {
}
/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
+/**
\brief PostScript graphical backend.
*
PostScript text uses vectorial fonts when using the FLTK standard fonts
@@ -75,7 +81,7 @@ public:
#ifndef FL_DOXYGEN
enum SHAPE{NONE=0, LINE, LOOP, POLYGON, POINTS};
-class Clip {
+ class Clip {
public:
int x, y, w, h;
Clip *prev;
@@ -226,6 +232,11 @@ class Clip {
};
/**
+ * @}
+ * @endcond
+ */
+
+/**
To send graphical output to a PostScript file.
This class is used exactly as the Fl_Printer class except for the begin_job() call,
two variants of which are usable and allow to specify what page format and layout are desired.
diff --git a/FL/Fl_Screen_Driver.H b/FL/Fl_Screen_Driver.H
index ff9dfa32d..1af64cba7 100644
--- a/FL/Fl_Screen_Driver.H
+++ b/FL/Fl_Screen_Driver.H
@@ -16,6 +16,12 @@
// http://www.fltk.org/str.php
//
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
#ifndef FL_SCREEN_DRIVER_H
#define FL_SCREEN_DRIVER_H
@@ -40,10 +46,13 @@ class Fl_RGB_Image;
class Fl_Group;
class Fl_Input;
-/** A base class describing the interface between FLTK and screen-related operations.
-This class is only for internal use by the FLTK library.
-Each supported platform implements several of the virtual methods of this class.
-*/
+/**
+ * A base class describing the interface between FLTK and screen-related operations.
+ *
+ * This class is only for internal use by the FLTK library.
+ *
+ * Each supported platform implements several of the virtual methods of this class.
+ */
class FL_EXPORT Fl_Screen_Driver {
protected:
@@ -187,6 +196,11 @@ public:
#endif // !FL_SCREEN_DRIVER_H
+/**
+ * @}
+ * @endcond
+ */
+
//
// End of "$Id$".
//
diff --git a/FL/Fl_System_Driver.H b/FL/Fl_System_Driver.H
index 7a4cc18a7..9b5a04f7e 100644
--- a/FL/Fl_System_Driver.H
+++ b/FL/Fl_System_Driver.H
@@ -17,6 +17,12 @@
// http://www.fltk.org/str.php
//
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
/** \file Fl_System_Driver.H
\brief declaration of class Fl_System_Driver.
*/
@@ -232,6 +238,11 @@ public:
#endif // FL_SYSTEM_DRIVER_H
+/**
+ * @}
+ * @endcond
+ */
+
//
// End of "$Id$".
//
diff --git a/FL/Fl_Window_Driver.H b/FL/Fl_Window_Driver.H
index dac150186..056a4adab 100644
--- a/FL/Fl_Window_Driver.H
+++ b/FL/Fl_Window_Driver.H
@@ -17,6 +17,12 @@
// http://www.fltk.org/str.php
//
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
/** \file Fl_Window_Driver.H
\brief declaration of class Fl_Window_Driver.
*/
@@ -35,9 +41,14 @@ class Fl_Image;
class Fl_RGB_Image;
/**
- \brief A base class for platform specific window handling code.
- This class is only for internal use by the FLTK library.
- Each supported platform implements several of the virtual methods of this class.
+ * \brief A base class for platform specific window handling code.
+ *
+ * This class is only for internal use by the FLTK library.
+ *
+ * When porting FLTK to a new platform, many mothods in this class provide
+ * a minimal default implementation. Some methods must be overridden to make
+ * sure that the Graphics Driver will draw into the bitmap associated with
+ * this window.
*/
class FL_EXPORT Fl_Window_Driver
{
@@ -186,6 +197,11 @@ public:
#endif // FL_WINDOW_DRIVER_H
+/**
+ * @}
+ * @endcond
+ */
+
//
// End of "$Id$".
//
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-08 13:12:57 +0000