diff options
| author | Matthias Melcher <fltk@matthiasm.com> | 2018-06-23 16:47:40 +0000 |
|---|---|---|
| committer | Matthias Melcher <fltk@matthiasm.com> | 2018-06-23 16:47:40 +0000 |
| commit | a9fd08ff5ab8bbf3838200ceace671a72627d212 (patch) | |
| tree | b7821c8f82a8ab75c682d9175c24bfaaf2993501 /src/Fl_Window_Driver.cxx | |
| parent | 8c993648dbb568e35271ad4c8bd346d7eb97e69b (diff) | |
Doxygen: created Group to document drivers, disabled by default
Uncomment `ENABLED_SECTIONS += DriverDev` in documentation/Doxyfile.in
to enable driver documentation.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12968 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Window_Driver.cxx')
| -rw-r--r-- | src/Fl_Window_Driver.cxx | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/Fl_Window_Driver.cxx b/src/Fl_Window_Driver.cxx index 45e9c4b03..72a84ff62 100644 --- a/src/Fl_Window_Driver.cxx +++ b/src/Fl_Window_Driver.cxx @@ -17,6 +17,11 @@ // http://www.fltk.org/str.php // +/** + * @cond DriverDev + * @addtogroup DriverDeveloper + * @{ + */ #include <FL/Fl_Window_Driver.H> #include <FL/Fl_Overlay_Window.H> @@ -26,6 +31,13 @@ extern void fl_throw_focus(Fl_Widget *o); + +/** + * Create a new Window Driver. + * + * This calls should be derived into a new class that manages desktop windows + * on the target platform. + */ Fl_Window_Driver::Fl_Window_Driver(Fl_Window *win) : pWindow(win) { @@ -64,14 +76,31 @@ void Fl_Window_Driver::flush_Fl_Window() { pWindow->Fl_Window::flush(); } void Fl_Window_Driver::flush_menu() { pWindow->Fl_Window::flush(); } +/** + * Draw the window content. + * A new driver can add code before or after drawing an individua window. + */ void Fl_Window_Driver::draw() { pWindow->draw(); } +/** + * Prepare this window for rendering. + * A new driver may prepare bitmaps and clipping areas for calls to the + * Graphics driver. + */ void Fl_Window_Driver::make_current() { } +/** + * Make the window visble and raise it to the top. + */ void Fl_Window_Driver::show() { } void Fl_Window_Driver::show_menu() { pWindow->Fl_Window::show(); } +/** + * Change the window title. + * A new drive should provide an interface to change the title of the window + * in the title bar. + */ void Fl_Window_Driver::label(const char *name, const char *mininame) {} void Fl_Window_Driver::take_focus() @@ -279,6 +308,11 @@ void Fl_Window_Driver::resize_after_scale_change(int ns, float old_f, float new_ is_a_rescale_ = false; } +/** + * @} + * @endcond + */ + // // End of "$Id$". // |
