Inheritance diagram for CEGUI::DragContainer:
Public Member Functions | |
DragContainer (const String &type, const String &name) | |
Constructor for DragContainer objects. | |
virtual | ~DragContainer (void) |
Destructor for DragContainer objects. | |
bool | isDraggingEnabled (void) const |
Return whether dragging is currently enabled for this DragContainer. | |
void | setDraggingEnabled (bool setting) |
Set whether dragging is currently enabled for this DragContainer. | |
bool | isBeingDragged (void) const |
Return whether the DragContainer is currently being dragged. | |
float | getPixelDragThreshold (void) const |
Return the current drag threshold in pixels. | |
void | setPixelDragThreshold (float pixels) |
Set the current drag threshold in pixels. | |
float | getDragAlpha (void) const |
Return the alpha value that will be set on the DragContainer while a drag operation is in progress. | |
void | setDragAlpha (float alpha) |
Set the alpha value to be set on the DragContainer when a drag operation is in progress. | |
const Image * | getDragCursorImage (void) const |
Return the Image currently set to be used for the mouse cursor when a drag operation is in progress. | |
void | setDragCursorImage (const Image *image) |
Set the Image to be used for the mouse cursor when a drag operation is in progress. | |
void | setDragCursorImage (MouseCursorImage image) |
Set the Image to be used for the mouse cursor when a drag operation is in progress. | |
void | setDragCursorImage (const String &imageset, const String &image) |
Set the Image to be used for the mouse cursor when a drag operation is in progress. | |
Window * | getCurrentDropTarget (void) const |
Return the Window object that is the current drop target for the DragContainer. | |
Static Public Attributes | |
static const String | WidgetTypeName |
Type name for DragContainer. | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventDragStarted |
Name of the event fired when the user begins dragging the thumb. | |
static const String | EventDragEnded |
Name of the event fired when the user releases the thumb. | |
static const String | EventDragPositionChanged |
Event fired when the drag position has changed. | |
static const String | EventDragEnabledChanged |
Event fired when dragging is enabled or disabled. | |
static const String | EventDragAlphaChanged |
Event fired when the alpha value used when dragging is changed. | |
static const String | EventDragMouseCursorChanged |
Event fired when the mouse cursor used when dragging is changed. | |
static const String | EventDragThresholdChanged |
Event fired when the drag pixel threshold is changed. | |
static const String | EventDragDropTargetChanged |
Event fired when the drop target changes. | |
Protected Member Functions | |
void | addDragContainerEvents (void) |
Adds events specific to the DragContainer base class. | |
bool | isDraggingThresholdExceeded (const Point &local_mouse) |
Return whether the required minimum movement threshold before initiating dragging has been exceeded. | |
void | initialiseDragging (void) |
Initialise the required states to put the window into dragging mode. | |
void | doDragging (const Point &local_mouse) |
Update state for window dragging. | |
void | updateActiveMouseCursor (void) const |
Method to update mouse cursor image. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
void | drawSelf (float z) |
Perform the actual rendering for this Window. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseButtonUp (MouseEventArgs &e) |
Handler called when a mouse button has been released within this window's area. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
virtual void | onCaptureLost (WindowEventArgs &e) |
Handler called when this window loses capture of mouse inputs. | |
virtual void | onAlphaChanged (WindowEventArgs &e) |
Handler called when the window's alpha blend value is changed. | |
virtual void | onClippingChanged (WindowEventArgs &e) |
Handler called when the window's setting for being clipped by it's parent is changed. | |
virtual void | onDragStarted (WindowEventArgs &e) |
Method called when dragging commences. | |
virtual void | onDragEnded (WindowEventArgs &e) |
Method called when dragging ends. | |
virtual void | onDragPositionChanged (WindowEventArgs &e) |
Method called when the dragged object position is changed. | |
virtual void | onDragEnabledChanged (WindowEventArgs &e) |
Method called when the dragging state is enabled or disabled. | |
virtual void | onDragAlphaChanged (WindowEventArgs &e) |
Method called when the alpha value to use when dragging is changed. | |
virtual void | onDragMouseCursorChanged (WindowEventArgs &e) |
Method called when the mouse cursor to use when dragging is changed. | |
virtual void | onDragThresholdChanged (WindowEventArgs &e) |
Method called when the movement threshold required to trigger dragging is changed. | |
virtual void | onDragDropTargetChanged (DragDropEventArgs &e) |
Method called when the current drop target of this DragContainer changes. | |
Protected Attributes | |
bool | d_draggingEnabled |
True when dragging is enabled. | |
bool | d_leftMouseDown |
True when left mouse button is down. | |
bool | d_dragging |
true when being dragged. | |
Point | d_dragPoint |
point we are being dragged at. | |
Point | d_startPosition |
position prior to dragging. | |
float | d_dragThreshold |
Pixels mouse must move before dragging commences. | |
float | d_dragAlpha |
Alpha value to set when dragging. | |
float | d_storedAlpha |
Alpha value to re-set when dragging ends. | |
bool | d_storedClipState |
Parent clip state to re-set. | |
Window * | d_dropTarget |
Target window for possible drop operation. | |
const Image * | d_dragCursorImage |
Image to use for mouse cursor when dragging. |
|
Adds events specific to the DragContainer base class.
|
|
Update state for window dragging.
|
|
Perform the actual rendering for this Window.
Reimplemented from CEGUI::Window. |
|
Return the Window object that is the current drop target for the DragContainer. The drop target for a DragContainer is basically the Window that the DragContainer is within while being dragged. The drop target may be 0 to indicate no target.
|
|
Return the alpha value that will be set on the DragContainer while a drag operation is in progress.
|
|
Return the Image currently set to be used for the mouse cursor when a drag operation is in progress.
|
|
Return the current drag threshold in pixels. The drag threshold is the number of pixels that the mouse must be moved with the left button held down in order to commence a drag operation.
|
|
Initialise the required states to put the window into dragging mode.
|
|
Return whether the DragContainer is currently being dragged.
|
|
Return whether dragging is currently enabled for this DragContainer.
|
|
Return whether the required minimum movement threshold before initiating dragging has been exceeded.
|
|
Handler called when the window's alpha blend value is changed.
Reimplemented from CEGUI::Window. |
|
Handler called when this window loses capture of mouse inputs.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's setting for being clipped by it's parent is changed.
Reimplemented from CEGUI::Window. |
|
Method called when the alpha value to use when dragging is changed.
|
|
Method called when the current drop target of this DragContainer changes.
|
|
Method called when the dragging state is enabled or disabled.
|
|
Method called when dragging ends.
|
|
Method called when the mouse cursor to use when dragging is changed.
|
|
Method called when the dragged object position is changed.
|
|
Method called when dragging commences.
|
|
Method called when the movement threshold required to trigger dragging is changed.
|
|
Handler called when a mouse button has been depressed within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been released within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse cursor has been moved within this window's area.
Reimplemented from CEGUI::Window. |
|
Set the alpha value to be set on the DragContainer when a drag operation is in progress. This method can be used while a drag is in progress to update the alpha. Note that the normal setAlpha method does not affect alpha while a drag is in progress, but once the drag operation has ended, any value set via setAlpha will be restored.
|
|
Set the Image to be used for the mouse cursor when a drag operation is in progress. This method may be used during a drag operation to update the current mouse cursor image.
|
|
Set the Image to be used for the mouse cursor when a drag operation is in progress. This method may be used during a drag operation to update the current mouse cursor image.
|
|
Set the Image to be used for the mouse cursor when a drag operation is in progress. This method may be used during a drag operation to update the current mouse cursor image.
|
|
Set whether dragging is currently enabled for this DragContainer.
|
|
Set the current drag threshold in pixels. The drag threshold is the number of pixels that the mouse must be moved with the left button held down in order to commence a drag operation.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |