src/dispatchresult.h

   1 // -*- C++ -*-
   2 /**
   3  * \file dispatchresult.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author none
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef DISPATCH_RESULT_H
  14 #define DISPATCH_RESULT_H
  15
  16 /** Dispatch result codes
  17         DISPATCHED          = the inset caught the action
  18         DISPATCHED_NOUPDATE = the inset caught the action and no update
  19                         is needed to redraw the inset
  20         FINISHED            = the inset must be unlocked as a result
  21                         of the action
  22         FINISHED_RIGHT      = FINISHED, but move the cursor RIGHT from
  23                         the inset.
  24         FINISHED_UP         = FINISHED, but move the cursor UP from
  25                         the inset.
  26         FINISHED_DOWN       = FINISHED, but move the cursor DOWN from
  27                         the inset.
  28         UNDISPATCHED        = the action was not catched, it should be
  29                         dispatched by lower level insets
  30 */
  31 enum dispatch_result_t {
  32         NONE = 0,
  33         FINISHED,
  34         FINISHED_RIGHT,
  35         FINISHED_UP,
  36         FINISHED_DOWN
  37 };
  38
  39
  40 /** \c DispatchResult is a wrapper for dispatch_result_t.
  41  *  It can be forward-declared and passed as a function argument without
  42  *  having to expose insetbase.h.
  43  */
  44 class DispatchResult {
  45 public:
  46         DispatchResult()
  47                 : dispatched_(false), val_(NONE) {}
  48         explicit
  49         DispatchResult(bool dis)
  50                 : dispatched_(dis), update_(false), val_(NONE) {}
  51         DispatchResult(bool dis, bool update)
  52                 : dispatched_(dis), update_(true), val_(NONE) {}
  53         DispatchResult(bool dis, dispatch_result_t val)
  54                 : dispatched_(dis), update_(false), val_(val) {}
  55         dispatch_result_t val() const { return val_; }
  56         bool dispatched() const {
  57                 return dispatched_;
  58         }
  59         void dispatched(bool dis) {
  60                 dispatched_ = dis;
  61         }
  62         bool update() const {
  63                 return update_;
  64         }
  65         void update(bool up) {
  66                 update_ = up;
  67         }
  68 private:
  69         bool dispatched_;
  70         bool update_;
  71         dispatch_result_t val_;
  72 };
  73
  74
  75 inline
  76 bool operator==(DispatchResult const & lhs, DispatchResult const & rhs)
  77 {
  78         return lhs.dispatched() == rhs.dispatched() && lhs.val() == rhs.val();
  79 }
  80
  81
  82 inline
  83 bool operator!=(DispatchResult const & lhs, DispatchResult const & rhs)
  84 {
  85         return !(lhs == rhs);
  86 }
  87
  88 #endif // DISPATCH_RESULT_H