From 034148b289ded6e5b4c8231d089c8c82ee39cea9 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Mon, 15 May 2017 14:26:02 +0000 Subject: Improve and clarify Fl_Clock documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12236 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Clock.H | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) (limited to 'FL') diff --git a/FL/Fl_Clock.H b/FL/Fl_Clock.H index 94fe04624..dccc549e6 100644 --- a/FL/Fl_Clock.H +++ b/FL/Fl_Clock.H @@ -3,7 +3,7 @@ // // Clock header file for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2010 by Bill Spitzak and others. +// Copyright 1998-2017 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -26,19 +26,22 @@ #include "Fl_Widget.H" #endif -// values for type: +// Values for type(): +// Please change doxygen documentation below (class Fl_Clock_Output) +// accordingly as well when changing the following type values: + #define FL_SQUARE_CLOCK 0 /**< type() of Square Clock variant */ #define FL_ROUND_CLOCK 1 /**< type() of Round Clock variant */ #define FL_ANALOG_CLOCK FL_SQUARE_CLOCK /**< An analog clock is square */ #define FL_DIGITAL_CLOCK FL_SQUARE_CLOCK /**< Not yet implemented */ // fabien: Please keep the horizontal formatting of both images in class desc, -// don't lose vert. space for nothing! +// don't lose vertical space for nothing! /** \class Fl_Clock_Output \brief This widget can be used to display a program-supplied time. - + The time shown on the clock is not updated. To display the current time, use Fl_Clock instead. @@ -50,6 +53,16 @@ \htmlonly \endhtmlonly \image latex clock.png "FL_SQUARE_CLOCK type" width=4cm \image latex round_clock.png "FL_ROUND_CLOCK type" width=4cm + + Values for clock type() (\#include \): + + \code + #define FL_SQUARE_CLOCK 0 // Square Clock variant + #define FL_ROUND_CLOCK 1 // Round Clock variant + #define FL_ANALOG_CLOCK FL_SQUARE_CLOCK // An analog clock is square + #define FL_DIGITAL_CLOCK FL_SQUARE_CLOCK // Not yet implemented + \endcode + */ class FL_EXPORT Fl_Clock_Output : public Fl_Widget { int hour_, minute_, second_; @@ -100,7 +113,9 @@ public: Fl_Clock is provided for Forms compatibility. It installs a 1-second timeout callback using Fl::add_timeout(). - You can choose the rounded or square type of the clock with type(), see below. + You can choose the rounded or square type of the clock with type(). + Please see Fl_Clock_Output widget for applicable values. + \htmlonly
type() FL_SQUARE_CLOCK and FL_ROUND_CLOCK
\endhtmlonly \image html clock.png @@ -109,6 +124,8 @@ public: \htmlonly
\endhtmlonly \image latex clock.png "FL_SQUARE_CLOCK type" width=4cm \image latex round_clock.png "FL_ROUND_CLOCK type" width=4cm + + \see class Fl_Clock_Output */ class FL_EXPORT Fl_Clock : public Fl_Clock_Output { public: -- cgit v1.2.3