DigitalSpaces::DICEGUIListHeaderSegment Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	isSizingEnabled ()
	Return whether this segment can be sized.
CEGUIListHeaderSegmentSortDirection	getSortDirection ()
	Return the current sort direction set for this segment.
bool	isDragMovingEnabled ()
	Return whether drag moving is enabled for this segment.
void	getDragMoveOffset (out_Pairf *offset)
	Return the current drag move position offset (in pixels relative to the top-left corner of the segment).
bool	isClickable ()
	Return whether the segment is clickable.
bool	isSegmentHovering ()
	Return whether the segment is currently in its hovering state.
bool	isSegmentPushed ()
	Return whether the segment is currently in its pushed state.
bool	isSplitterHovering ()
	Return whether the splitter is currently in its hovering state.
bool	isBeingDragMoved ()
	Return whether the segment is currently being drag-moved.
bool	isBeingDragSized ()
	Return whether the segment is currently being drag-moved.
DICEGUIImage *	getSizingCursorImage ()
DICEGUIImage *	getMovingCursorImage ()
void	setSizingEnabled (bool setting)
	Set whether this segment can be sized.
void	setSortDirection (CEGUIListHeaderSegmentSortDirection sort_dir)
	Set the current sort direction set for this segment.
void	setDragMovingEnabled (bool setting)
	Set whether drag moving is allowed for this segment.
void	setClickable (bool setting)
	Set whether the segment is clickable.
void	setSizingCursorImage (DICEGUIImage *image)
void	setSizingCursorImage (const char *imageset, const char *image)
void	setMovingCursorImage (DICEGUIImage *image)
void	setMovingCursorImage (const char *imageset, const char *image)

---

Member Function Documentation

bool DigitalSpaces::DICEGUIListHeaderSegment::isSizingEnabled

(

)

Return whether this segment can be sized.

Returns:

true if the segment can be horizontally sized, false if the segment can not be horizontally sized.

CEGUIListHeaderSegmentSortDirection DigitalSpaces::DICEGUIListHeaderSegment::getSortDirection

(

)

Return the current sort direction set for this segment.

Note that this has no impact on the way the segment functions (aside from the possibility of varied rendering). This is intended as a 'helper setting' to classes that make use of the ListHeaderSegment objects.

Returns:

One of the SortDirection enumerated values indicating the current sort direction set for this segment.

bool DigitalSpaces::DICEGUIListHeaderSegment::isDragMovingEnabled

(

)

Return whether drag moving is enabled for this segment.

Returns:

true if the segment can be drag moved, false if the segment can not be drag moved.

void DigitalSpaces::DICEGUIListHeaderSegment::getDragMoveOffset

(

out_Pairf *

offset

)

Return the current drag move position offset (in pixels relative to the top-left corner of the segment).

Returns:

Point object describing the drag move offset position.

bool DigitalSpaces::DICEGUIListHeaderSegment::isClickable

(

)

Return whether the segment is clickable.

Returns:

true if the segment can be clicked, false of the segment can not be clicked (so no highlighting or events will happen).

bool DigitalSpaces::DICEGUIListHeaderSegment::isSegmentHovering

(

)

Return whether the segment is currently in its hovering state.

bool DigitalSpaces::DICEGUIListHeaderSegment::isSegmentPushed

(

)

Return whether the segment is currently in its pushed state.

bool DigitalSpaces::DICEGUIListHeaderSegment::isSplitterHovering

(

)

Return whether the splitter is currently in its hovering state.

bool DigitalSpaces::DICEGUIListHeaderSegment::isBeingDragMoved

(

)

Return whether the segment is currently being drag-moved.

bool DigitalSpaces::DICEGUIListHeaderSegment::isBeingDragSized

(

)

Return whether the segment is currently being drag-moved.

DICEGUIImage* DigitalSpaces::DICEGUIListHeaderSegment::getSizingCursorImage

(

)

DICEGUIImage* DigitalSpaces::DICEGUIListHeaderSegment::getMovingCursorImage

(

)

void DigitalSpaces::DICEGUIListHeaderSegment::setSizingEnabled

(

bool

setting

)

Set whether this segment can be sized.

Parameters:

setting

true if the segment may be horizontally sized, false if the segment may not be horizontally sized.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeaderSegment::setSortDirection

(

CEGUIListHeaderSegmentSortDirection

sort_dir

)

Set the current sort direction set for this segment.

Note that this has no impact on the way the segment functions (aside from the possibility of varied rendering). This is intended as a 'helper setting' to classes that make use of the ListHeaderSegment objects.

Parameters:

sort_dir

One of the SortDirection enumerated values indicating the current sort direction set for this segment.

Returns:

Nothing

void DigitalSpaces::DICEGUIListHeaderSegment::setDragMovingEnabled

(

bool

setting

)

Set whether drag moving is allowed for this segment.

Parameters:

setting

true if the segment may be drag moved, false if the segment may not be drag moved.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeaderSegment::setClickable

(

bool

setting

)

Set whether the segment is clickable.

Parameters:

setting

true if the segment may be clicked, false of the segment may not be clicked (so no highlighting or events will happen).

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeaderSegment::setSizingCursorImage

(

DICEGUIImage *

image

)

void DigitalSpaces::DICEGUIListHeaderSegment::setSizingCursorImage	(	const char *	imageset,
		const char *	image
	)

void DigitalSpaces::DICEGUIListHeaderSegment::setMovingCursorImage

(

DICEGUIImage *

image

)

void DigitalSpaces::DICEGUIListHeaderSegment::setMovingCursorImage	(	const char *	imageset,
		const char *	image
	)

---

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

• CEGUIInterfaces/CEGUIInterfaces.h