DigitalSpaces::DICEGUIDragContainer Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	isDraggingEnabled ()
	Return whether dragging is currently enabled for this DragContainer.
void	setDraggingEnabled (bool setting)
	Set whether dragging is currently enabled for this DragContainer.
bool	isBeingDragged ()
	Return whether the DragContainer is currently being dragged.
float	getPixelDragThreshold ()
	Return the current drag threshold in pixels.
void	setPixelDragThreshold (float pixels)
	Set the current drag threshold in pixels.
float	getDragAlpha ()
	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.
DICEGUIImage *	getDragCursorImage ()
	Return the Image currently set to be used for the mouse cursor when a drag operation is in progress.
void	setDragCursorImage (DICEGUIImage *image)
	Set the Image to be used for the mouse cursor when a drag operation is in progress.
void	setDragCursorImage (CEGUIMouseCursorImage image)
	Set the Image to be used for the mouse cursor when a drag operation is in progress.
void	setDragCursorImage (const char *imageset, const char *image)
	Set the Image to be used for the mouse cursor when a drag operation is in progress.
DICEGUIWindow *	getCurrentDropTarget ()
	Return the Window object that is the current drop target for the DragContainer.

---

Member Function Documentation

bool DigitalSpaces::DICEGUIDragContainer::isDraggingEnabled

(

)

Return whether dragging is currently enabled for this DragContainer.

Returns:

• true if dragging is enabled and the DragContainer may be dragged.
• false if dragging is disabled and the DragContainer may not be dragged.

void DigitalSpaces::DICEGUIDragContainer::setDraggingEnabled

(

bool

setting

)

Set whether dragging is currently enabled for this DragContainer.

Parameters:

setting

true to enable dragging so that the DragContainer may be dragged. false to disabled dragging so that the DragContainer may not be dragged.

Returns:

Nothing.

bool DigitalSpaces::DICEGUIDragContainer::isBeingDragged

(

)

Return whether the DragContainer is currently being dragged.

Returns:

• true if the DragContainer is being dragged.
• false if te DragContainer is not being dragged.

float DigitalSpaces::DICEGUIDragContainer::getPixelDragThreshold

(

)

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.

Returns:

float value indicating the current drag threshold value.

void DigitalSpaces::DICEGUIDragContainer::setPixelDragThreshold

(

float

pixels

)

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.

Parameters:

pixels

float value indicating the new drag threshold value.

Returns:

Nothing.

float DigitalSpaces::DICEGUIDragContainer::getDragAlpha

(

)

Return the alpha value that will be set on the DragContainer while a drag operation is in progress.

Returns:

Current alpha value to use whilst dragging.

void DigitalSpaces::DICEGUIDragContainer::setDragAlpha

(

float

alpha

)

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.

Parameters:

alpha

Alpha value to use whilst dragging.

Returns:

Nothing.

DICEGUIImage* DigitalSpaces::DICEGUIDragContainer::getDragCursorImage

(

)

Return the Image currently set to be used for the mouse cursor when a drag operation is in progress.

Returns:

Image object currently set to be used as the mouse cursor when dragging.

void DigitalSpaces::DICEGUIDragContainer::setDragCursorImage

(

DICEGUIImage *

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.

Parameters:

image

Image object to be used as the mouse cursor while dragging.

Returns:

Nothing.

void DigitalSpaces::DICEGUIDragContainer::setDragCursorImage

(

CEGUIMouseCursorImage

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.

Parameters:

image

One of the MouseCursorImage enumerated values.

Returns:

Nothing.

void DigitalSpaces::DICEGUIDragContainer::setDragCursorImage	(	const char *	imageset,
		const char *	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.

Parameters:

	imageset	String holding the name of the Imageset that contains the Image to be used.
	image	Image defined for the Imageset imageset to be used as the mouse cursor when dragging.

Returns:

Nothing.

Exceptions:

UnknownObjectException

thrown if either imageset or image are unknown.

DICEGUIWindow* DigitalSpaces::DICEGUIDragContainer::getCurrentDropTarget

(

)

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.

Returns:

Pointer to a Window object that contains the DragContainer whilst being dragged, or 0 to indicate no current target.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h