The document associated with the canvas.
More...
#include <client.h>
Public Member Functions |
| | Client () |
| virtual | ~Client () |
| virtual bool | OnButtonPressed (ItemClient *client, unsigned button, double x, double y, unsigned state) |
| virtual bool | OnButtonReleased (ItemClient *client, unsigned button, double x, double y, unsigned state) |
| virtual bool | OnMotion (ItemClient *client, double x, double y, unsigned state) |
| virtual bool | OnDrag (ItemClient *client, double x, double y, unsigned state) |
| virtual bool | OnLeaveNotify (unsigned state) |
| Canvas * | GetCanvas (void) |
Detailed Description
The document associated with the canvas.
The Client object might represent the document or its view. This class is used to propagate mouse events to the document.
Definition at line 43 of file client.h.
Constructor & Destructor Documentation
The standard constructor.
| virtual gccv::Client::~Client |
( |
| ) |
|
|
virtual |
Member Function Documentation
| gccv::Client::GetCanvas |
( |
void |
| ) |
|
|
inline |
- Returns
- the associated canvas.
Definition at line 124 of file client.h.
| virtual bool gccv::Client::OnButtonPressed |
( |
ItemClient * |
client, |
|
|
unsigned |
button, |
|
|
double |
x, |
|
|
double |
y, |
|
|
unsigned |
state |
|
) |
| |
|
virtual |
- Parameters
-
| client | the ItemClient for the Item at the event position if any. |
| button | the mouse button. |
| x | horizontal event position. |
| y | vertical event position. |
| state | the GdkModifierType value for the event. |
Called when a mouse button is pressed. client is NULL when there is no Item at the event position, or the Item does not have an associated ItemClient.
- Returns
- true to stop other handlers from being invoked for the event. false to propagate the event further.
Reimplemented in gcp::View.
| virtual bool gccv::Client::OnButtonReleased |
( |
ItemClient * |
client, |
|
|
unsigned |
button, |
|
|
double |
x, |
|
|
double |
y, |
|
|
unsigned |
state |
|
) |
| |
|
virtual |
- Parameters
-
| client | the ItemClient for the Item at the event position if any. |
| button | the mouse button. |
| x | horizontal event position. |
| y | vertical event position. |
| state | the GdkModifierType value for the event. |
Called when a mouse button is released. client is NULL when there is no Item at the event position, or the Item does not have an associated ItemClient.
- Returns
- true to stop other handlers from being invoked for the event. false to propagate the event further.
Reimplemented in gcp::View.
| virtual bool gccv::Client::OnDrag |
( |
ItemClient * |
client, |
|
|
double |
x, |
|
|
double |
y, |
|
|
unsigned |
state |
|
) |
| |
|
virtual |
- Parameters
-
| client | the ItemClient for the Item at the event position if any. |
| x | horizontal event position. |
| y | vertical event position. |
| state | the GdkModifierType value for the event. |
Called when the mouse moves over the canvas, with at least one button pressed. client is NULL when there is no Item at the event position, or the Item does not have an associated ItemClient.
- Returns
- true to stop other handlers from being invoked for the event. false to propagate the event further.
Reimplemented in gcp::View.
| virtual bool gccv::Client::OnLeaveNotify |
( |
unsigned |
state | ) |
|
|
virtual |
- Parameters
-
| state | the GdkModifierType value for the event. |
Called when the mouse leaves the Canvas.
- Returns
- true to stop other handlers from being invoked for the event. false to propagate the event further.
Reimplemented in gcp::View.
| virtual bool gccv::Client::OnMotion |
( |
ItemClient * |
client, |
|
|
double |
x, |
|
|
double |
y, |
|
|
unsigned |
state |
|
) |
| |
|
virtual |
- Parameters
-
| client | the ItemClient for the Item at the event position if any. |
| x | horizontal event position. |
| y | vertical event position. |
| state | the GdkModifierType value for the event. |
Called when the mouse moves over the canvas, with no button pressed. client is NULL when there is no Item at the event position, or the Item does not have an associated ItemClient. @return true to stop other handlers from being invoked for the event. false to propagate the event further.
Reimplemented in gcp::View.
Member Data Documentation
The associated canvas.
Definition at line 124 of file client.h.
The documentation for this class was generated from the following file:
