]> git.lyx.org Git - lyx.git/blobdiff - src/dispatchresult.h
float2string #4 (Spacing)
[lyx.git] / src / dispatchresult.h
index 19aa2b979c44ec0564fad1bb5a0fe6c147f57090..d5133fd5a1f3c5aa75068aff026ff6e0d4e59c30 100644 (file)
 #ifndef DISPATCH_RESULT_H
 #define DISPATCH_RESULT_H
 
-/** Dispatch result codes
-       DISPATCHED          = the inset caught the action
-       DISPATCHED_NOUPDATE = the inset caught the action and no update
-                       is needed to redraw the inset
-       FINISHED            = the inset must be unlocked as a result
-                       of the action
-       FINISHED_RIGHT      = FINISHED, but move the cursor RIGHT from
-                       the inset.
-       FINISHED_UP         = FINISHED, but move the cursor UP from
-                       the inset.
-       FINISHED_DOWN       = FINISHED, but move the cursor DOWN from
-                       the inset.
-       FINISHED_POP       = FINISHED, but move the cursor out the inset
-                       (possibly more than one level)
-       UNDISPATCHED        = the action was not catched, it should be
-                       dispatched by lower level insets
-*/
-enum dispatch_result_t {
-       NONE = 0,
-       FINISHED,
-       FINISHED_RIGHT,
-       FINISHED_UP,
-       FINISHED_DOWN
-};
-
-
-/** \c DispatchResult is a wrapper for dispatch_result_t.
- *  It can be forward-declared and passed as a function argument without
- *  having to expose insetbase.h.
- */
+/// Maybe this can go entirely
 class DispatchResult {
 public:
-       DispatchResult()
-               : dispatched_(false), val_(NONE) {}
-       explicit
-       DispatchResult(bool dis)
-               : dispatched_(dis), update_(false), val_(NONE) {}
-       DispatchResult(bool dis, bool update)
-               : dispatched_(dis), update_(true), val_(NONE) {}
-       DispatchResult(bool dis, dispatch_result_t val)
-               : dispatched_(dis), update_(false), val_(val) {}
-       dispatch_result_t val() const { return val_; }
-       void val(dispatch_result_t drt) {
-               val_ = drt;
-       }
-       bool dispatched() const {
-               return dispatched_;
-       }
-       void dispatched(bool dis) {
-               dispatched_ = dis;
-       }
-       bool update() const {
-               return update_;
-       }
-       void update(bool up) {
-               update_ = up;
-       }
+       ///
+       DispatchResult() : dispatched_(false), update_(false) {}
+       ///
+       DispatchResult(bool disp, bool upd) : dispatched_(disp), update_(upd) {}
+       //
+       bool dispatched() const { return dispatched_; }
+       ///
+       void dispatched(bool disp) { dispatched_ = disp; }
+       ///
+       bool update() const { return update_; }
+       ///
+       void update(bool up) { update_ = up; }
 private:
+       /// was the event fully dispatched?
        bool dispatched_;
+       /// do we need to redraw the screen afterwards?
        bool update_;
-       dispatch_result_t val_;
 };
 
-
-inline
-bool operator==(DispatchResult const & lhs, DispatchResult const & rhs)
-{
-       return lhs.dispatched() == rhs.dispatched() && lhs.val() == rhs.val();
-}
-
-
-inline
-bool operator!=(DispatchResult const & lhs, DispatchResult const & rhs)
-{
-       return !(lhs == rhs);
-}
-
 #endif // DISPATCH_RESULT_H