From 950ea3384cf2da77cefb3712f9a108e70bf0f80b Mon Sep 17 00:00:00 2001 From: Georg Baum Date: Thu, 21 Apr 2005 09:27:40 +0000 Subject: [PATCH] FuncStatus documentation from Andre and me git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@9847 a592a061-630c-0410-9148-cb99ea01b6c8 --- src/ChangeLog | 8 ++++++++ src/FuncStatus.h | 21 +++++++++++++-------- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index f471e172cb..9ca05a27b8 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,11 @@ +2005-04-21 Georg Baum + + * FuncStatus.h (StatusCodes): document + +2005-04-21 André Pönitz + + * FuncStatus.h (enabled, onoff): document + 2005-04-19 Angus Leeming * BufferView_pimpl.C (cursorToggle): no longer test whether diff --git a/src/FuncStatus.h b/src/FuncStatus.h index 3f5d7b14c1..6db5832d96 100644 --- a/src/FuncStatus.h +++ b/src/FuncStatus.h @@ -21,15 +21,19 @@ class FuncStatus private: enum StatusCodes { - /// + /// Command can be executed OK = 0, - /// + /// It is unknown wether the command can be executed or not UNKNOWN = 1, - /// - DISABLED = 2, // Command cannot be executed - /// + /// Command cannot be executed + DISABLED = 2, + /// Command is on (i. e. the menu item has a checkmark + /// and the toolbar icon is pushed). + /// Not all commands use this ON = 4, - /// + /// Command is off (i. e. the menu item has no checkmark + /// and the toolbar icon is not pushed). + /// Not all commands use this OFF = 8 }; @@ -51,12 +55,13 @@ public: /// void enabled(bool b); - /// + /// tells whether it can be invoked (otherwise it will be grayed-out). bool enabled() const; /// void setOnOff(bool b); - /// + /// tells whether the menu item should have a check mark + /// (or the toolbar icon should be pushed). bool onoff(bool b) const; ///