#ifndef FUNC_STATUS_H
#define FUNC_STATUS_H
-#include <string>
+#include "support/docstring.h"
+
+
+namespace lyx {
/// The status of a function.
private:
enum StatusCodes {
- ///
+ /// Command can be executed
OK = 0,
- ///
+ /// This command does not exist, possibly because it is not
+ /// compiled in (e.g. LFUN_THESAURUS) or the user mistyped
+ /// it in the minibuffer. UNKNOWN commands have no menu entry.
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
};
unsigned int v_;
- std::string message_;
+ docstring message_;
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;
///
- void message(std::string const & m);
+ void message(docstring const & m);
///
- std::string const & message() const;
+ docstring const & message() const;
};
+
+} // namespace lyx
+
#endif