summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2017-09-12 15:26:36 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2017-09-12 15:26:36 +0000
commit900314d4f4047e4c21130e8551c4b29436b960d0 (patch)
tree2fa344198400a8d1d0ed2d81f6789ed48eef9df8
parent141c3594d27be719da816775de788cbd6797375c (diff)
Documentation and copyright updates.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12450 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/Enumerations.H33
-rw-r--r--documentation/src/common.dox91
-rw-r--r--fluid/factory.cxx2
3 files changed, 70 insertions, 56 deletions
diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index c0fe027b2..a08e68864 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -42,14 +42,14 @@
FLTK defines some constants to help the programmer to
find out, for which FLTK version a program is compiled.
-
+
The following constants are defined:
*/
/*@{*/
/**
The major release version of this FLTK library.
- \sa FL_VERSION
+ \see FL_VERSION
*/
#define FL_MAJOR_VERSION 1
@@ -192,7 +192,7 @@
Event numbers can be converted to their actual names using the
\ref fl_eventnames[] array defined in \#include &lt;FL/names.h&gt;
- \sa Fl::event_text(), Fl::event_key(), class Fl::
+ \see Fl::event_text(), Fl::event_key(), class Fl::
*/
// DEV NOTE: Keep this list in sync with FL/names.h
enum Fl_Event { // events
@@ -412,7 +412,7 @@ enum Fl_Event { // events
/*@{*/
/** These constants determine when a callback is performed.
- \sa Fl_Widget::when();
+ \see Fl_Widget::when();
\todo doxygen comments for values are incomplete and maybe wrong or unclear
*/
enum Fl_When { // Fl_Widget::when():
@@ -430,13 +430,13 @@ enum Fl_When { // Fl_Widget::when():
/** \name Mouse and Keyboard Events
- This and the following constants define the non-ASCII keys on the
- keyboard for FL_KEYBOARD and FL_SHORTCUT events.
+ This and the following constants define the non-ASCII keys on the
+ keyboard for FL_KEYBOARD and FL_SHORTCUT events.
- \todo FL_Button and FL_key... constants could be structured better
- (use an enum or some doxygen grouping ?)
-
- \sa Fl::event_key() and Fl::get_key(int) (use ascii letters for all other keys):
+ \see Fl::event_key() and Fl::get_key(int) (use ASCII letters for all other keys):
+
+ \todo FL_Button and FL_key... constants could be structured better
+ (use an enum or some doxygen grouping ?)
*/
/*@{*/
@@ -509,9 +509,9 @@ enum Fl_When { // Fl_Widget::when():
/** \name Mouse Buttons
- These constants define the button numbers for FL_PUSH and FL_RELEASE events.
-
- \sa Fl::event_button()
+ These constants define the button numbers for FL_PUSH and FL_RELEASE events.
+
+ \see Fl::event_button()
*/
/*@{*/
@@ -531,7 +531,7 @@ enum Fl_When { // Fl_Widget::when():
/*@{*/ // group: Event States
// FIXME: it would be nice to have the modifiers in the upper 8 bit so that
-// a unicode ke (24bit) can be sent as an unsigned with the modifiers.
+// a unicode key (24bit) can be sent as an unsigned with the modifiers.
#define FL_SHIFT 0x00010000 ///< One of the shift keys is down
#define FL_CAPS_LOCK 0x00020000 ///< The caps lock is on
@@ -556,7 +556,7 @@ enum Fl_When { // Fl_Widget::when():
/** \name Box Types
\brief FLTK standard box types
-
+
This enum defines the standard box types included with FLTK.
\note The documented \p enum \p Fl_Boxtype contains some values (names)
@@ -569,9 +569,10 @@ enum Fl_When { // Fl_Widget::when():
on the screen remains. The FL_..._FRAME types only draw their edges,
leaving the interior unchanged. The blue color in Figure 1
is the area that is not drawn by the frame types.
-
+
\image html boxtypes.png "Figure 1: FLTK standard box types"
\image latex boxtypes.png "FLTK standard box types" width=10cm
+
\todo Description of boxtypes is incomplete.
See below for the defined enum Fl_Boxtype.
\see src/Fl_get_system_colors.cxx
diff --git a/documentation/src/common.dox b/documentation/src/common.dox
index 1a23ce7a4..9b6360fc5 100644
--- a/documentation/src/common.dox
+++ b/documentation/src/common.dox
@@ -182,22 +182,22 @@ for implementation details.
There are symbols for naming some of the more common colors:
-\li \p FL_BLACK
-\li \p FL_RED
-\li \p FL_GREEN
-\li \p FL_YELLOW
-\li \p FL_BLUE
-\li \p FL_MAGENTA
-\li \p FL_CYAN
-\li \p FL_WHITE
-\li \p FL_WHITE
+ - \p FL_BLACK
+ - \p FL_RED
+ - \p FL_GREEN
+ - \p FL_YELLOW
+ - \p FL_BLUE
+ - \p FL_MAGENTA
+ - \p FL_CYAN
+ - \p FL_WHITE
+ - \p FL_WHITE
Other symbols are used as the default colors for all FLTK widgets.
-\li \p FL_FOREGROUND_COLOR
-\li \p FL_BACKGROUND_COLOR
-\li \p FL_INACTIVE_COLOR
-\li \p FL_SELECTION_COLOR
+ - \p FL_FOREGROUND_COLOR
+ - \p FL_BACKGROUND_COLOR
+ - \p FL_INACTIVE_COLOR
+ - \p FL_SELECTION_COLOR
The full list of named color values can be found in
\ref enumerations_colors "FLTK Enumerations".
@@ -380,36 +380,49 @@ label string "@+92->".
The \p align() method positions the label. The following
constants are defined and may be OR'd together as needed:
-\li \p FL_ALIGN_CENTER - center the label in the widget.
-\li \p FL_ALIGN_TOP - align the label at the top of the widget.
-\li \p FL_ALIGN_BOTTOM - align the label at the bottom of the widget.
-\li \p FL_ALIGN_LEFT - align the label to the left of the widget.
-\li \p FL_ALIGN_RIGHT - align the label to the right of the widget.
-\li \p FL_ALIGN_LEFT_TOP - The label appears to the left of the widget, aligned at the top. Outside labels only.
-\li \p FL_ALIGN_RIGHT_TOP - The label appears to the right of the widget, aligned at the top. Outside labels only.
-\li \p FL_ALIGN_LEFT_BOTTOM - The label appears to the left of the widget, aligned at the bottom. Outside labels only.
-\li \p FL_ALIGN_RIGHT_BOTTOM - The label appears to the right of the widget, aligned at the bottom. Outside labels only.
-\li \p FL_ALIGN_INSIDE - align the label inside the widget.
-\li \p FL_ALIGN_CLIP - clip the label to the widget's bounding box.
-\li \p FL_ALIGN_WRAP - wrap the label text as needed.
-\li \p FL_ALIGN_TEXT_OVER_IMAGE - show the label text over the image.
-\li \p FL_ALIGN_IMAGE_OVER_TEXT - show the label image over the text (default).
-\li \p FL_ALIGN_IMAGE_NEXT_TO_TEXT - The image will appear to the left of the text.
-\li \p FL_ALIGN_TEXT_NEXT_TO_IMAGE - The image will appear to the right of the text.
-\li \p FL_ALIGN_IMAGE_BACKDROP - The image will be used as a background for the widget.
+ - \p FL_ALIGN_CENTER - center the label in the widget.
+ - \p FL_ALIGN_TOP - align the label at the top of the widget.
+ - \p FL_ALIGN_BOTTOM - align the label at the bottom of the widget.
+ - \p FL_ALIGN_LEFT - align the label to the left of the widget.
+ - \p FL_ALIGN_RIGHT - align the label to the right of the widget.
+ - \p FL_ALIGN_LEFT_TOP - The label appears to the left of the widget, aligned at the top. Outside labels only.
+ - \p FL_ALIGN_RIGHT_TOP - The label appears to the right of the widget, aligned at the top. Outside labels only.
+ - \p FL_ALIGN_LEFT_BOTTOM - The label appears to the left of the widget, aligned at the bottom. Outside labels only.
+ - \p FL_ALIGN_RIGHT_BOTTOM - The label appears to the right of the widget, aligned at the bottom. Outside labels only.
+ - \p FL_ALIGN_INSIDE - align the label inside the widget.
+ - \p FL_ALIGN_CLIP - clip the label to the widget's bounding box.
+ - \p FL_ALIGN_WRAP - wrap the label text as needed.
+ - \p FL_ALIGN_TEXT_OVER_IMAGE - show the label text over the image.
+ - \p FL_ALIGN_IMAGE_OVER_TEXT - show the label image over the text (default).
+ - \p FL_ALIGN_IMAGE_NEXT_TO_TEXT - The image will appear to the left of the text.
+ - \p FL_ALIGN_TEXT_NEXT_TO_IMAGE - The image will appear to the right of the text.
+ - \p FL_ALIGN_IMAGE_BACKDROP - The image will be used as a background for the widget.
\anchor common_labeltype
\par labeltype()
-The \p labeltype() method sets the type of the label. The
-following standard label types are included:
-
-\li \p FL_NORMAL_LABEL - draws the text.
-\li \p FL_NO_LABEL - does nothing.
-\li \p FL_SHADOW_LABEL - draws a drop shadow under the text.
-\li \p FL_ENGRAVED_LABEL - draws edges as though the text is engraved.
-\li \p FL_EMBOSSED_LABEL - draws edges as thought the text is raised.
-\li \p FL_ICON_LABEL - draws the icon associated with the text.
+The \p labeltype() method sets the type of the label.
+The following standard label types are included:
+
+ - \p FL_NORMAL_LABEL - draws the text.
+ - \p FL_NO_LABEL - does nothing.
+ - \p FL_SHADOW_LABEL - draws a drop shadow under the text.
+ - \p FL_ENGRAVED_LABEL - draws edges as though the text is engraved.
+ - \p FL_EMBOSSED_LABEL - draws edges as though the text is raised.
+ - \p FL_ICON_LABEL - draws the icon (Fl_Image) associated with the text.
+ - \p FL_IMAGE_LABEL - draws the image (Fl_Image) associated with the text.
+ - \p FL_MULTI_LABEL - draws multiple parts side by side, see Fl_Multi_Label.
+
+ \note Some of these labeltypes are no longer necessary for normal widgets.
+ Widgets allow for an image and a text side by side, depending on
+ the widget's align() flag. FL_MULTI_LABEL was designed to be used with
+ Fl_Menu_Item's to support icons or small images, typically left of the
+ menu text.\n
+ As of this writing (FLTK 1.4.0, Sep 2017) Fl_Menu_Items support only
+ one label part (text \b or image), but using Fl_Multi_Label as the
+ label can extend this to more than one part.
+
+ \see class Fl_Multi_Label, Fl_Widget::align()
\par image() and deimage()
diff --git a/fluid/factory.cxx b/fluid/factory.cxx
index d7133377e..7a4353d37 100644
--- a/fluid/factory.cxx
+++ b/fluid/factory.cxx
@@ -11,7 +11,7 @@
// to a factory instance for every class (both the ones defined
// here and ones in other files)
//
-// 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