mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-21 23:51:25 +00:00
7915d583c2
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@8070 a592a061-630c-0410-9148-cb99ea01b6c8
94 lines
2.3 KiB
C++
94 lines
2.3 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file dispatchresult.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author none
|
|
* \author Lars Gullik Bjønnes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#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.
|
|
*/
|
|
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;
|
|
}
|
|
private:
|
|
bool dispatched_;
|
|
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
|