Defines the result of the context's consideration of user input.
More...
#include <Context.h>
|
bool | _handled |
| Reports if the event has been handled (and no one else needs to worry about it).
|
|
bool | _redraw |
| Reports if the event requires a redraw on the scene.
|
|
Defines the result of the context's consideration of user input.
Menge::SceneGraph::ContextResult::ContextResult |
( |
bool |
handled, |
|
|
bool |
needsRedraw |
|
) |
| |
|
inline |
Constructor.
- Parameters
-
handled | Set to true if the event has been handled and does not need to be considered by any other handler. |
needsRedraw | Set to true if the processing of the event requires a redraw. |
void Menge::SceneGraph::ContextResult::combine |
( |
const ContextResult & |
res | ) |
|
|
inline |
Combines the provided context result with this one; flags are combined with a boolean OR.
- Parameters
-
res | The context results to combine with this. |
bool Menge::SceneGraph::ContextResult::isHandled |
( |
| ) |
const |
|
inline |
Reports if the result considers the event handled.
- Returns
- True if the result considers the event handled, false otherwise.
bool Menge::SceneGraph::ContextResult::needsRedraw |
( |
| ) |
const |
|
inline |
Reports if the result believes the event handling requires a redraw.
- Returns
- True if the result requires a redraw, false otherwise.
Simple assignment operator overloaded.
- Parameters
-
- Returns
- A reference to this context result.
void Menge::SceneGraph::ContextResult::set |
( |
bool |
handled, |
|
|
bool |
redraw |
|
) |
| |
|
inline |
Sets the handled and needs redraw state simultaneously.
- Parameters
-
handled | True if the result should consider the event handled, false otherwise. |
redraw | True means the result should believe the event requires a redraw, otherwise false. |
void Menge::SceneGraph::ContextResult::setHandled |
( |
bool |
state | ) |
|
|
inline |
Sets the "handled" state to the given boolean state.
- Parameters
-
state | True means the result should consider the event handled, otherwise false. |
void Menge::SceneGraph::ContextResult::setNeedsRedraw |
( |
bool |
state | ) |
|
|
inline |
Sets the "needs redraw" state to the given boolean state.
- Parameters
-
state | True means the result should believe the event requires a redraw, otherwise false. |
The documentation for this class was generated from the following file: