Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::MouseCursor Class Reference

Class that allows access to the GUI system mouse cursor. More...

#include <CEGUIMouseCursor.h>

Inheritance diagram for CEGUI::MouseCursor:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::MouseCursor:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
EventMap
EventIterator

Public Member Functions

 MouseCursor (void)
 Constructor for MouseCursor objects.
 ~MouseCursor (void)
 Destructor for MouseCursor objects.
void setImage (const String &imageset, const String &image_name)
 Set the current mouse cursor image.
void setImage (const Image *image)
 Set the current mouse cursor image.
const ImagegetImage (void) const
 Get the current mouse cursor image.
void draw (void) const
 Makes the cursor draw itself.
void setPosition (const Point &position)
 Set the current mouse cursor position.
void offsetPosition (const Point &offset)
 Offset the mouse cursor position by the deltas specified in offset.
void setConstraintArea (const Rect *area)
 Set the area that the mouse cursor is constrained to.
void setUnifiedConstraintArea (const URect *area)
 Set the area that the mouse cursor is constrained to.
void hide (void)
 Hides the mouse cursor.
void show (void)
 Shows the mouse cursor.
bool isVisible (void) const
 return whether the mouse cursor is visible.
Point getPosition (void) const
 Return the current mouse cursor position as a pixel offset from the top-left corner of the display.
Rect getConstraintArea (void) const
 return the current constraint area of the mouse cursor.
const URectgetUnifiedConstraintArea (void) const
 return the current constraint area of the mouse cursor.
Point getDisplayIndependantPosition (void) const
 Return the current mouse cursor position as display resolution independant values.
void addEvent (const String &name)
 Add a new Event to the EventSet with the given name.
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected.
void removeAllEvents (void)
 Remove all Event objects from the EventSet.
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in the EventSet.
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes the named Event.
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes the specified group of the named Event.
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion.
virtual Event::Connection subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
 Subscribes the specified group of the named Event to a scripted funtion.
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object.
bool isMuted (void) const
 Return whether the EventSet is muted or not.
void setMutedState (bool setting)
 Set the mute state for this EventSet.
EventIterator getIterator (void) const
 Return a EventSet::EventIterator object to iterate over the available events.
 Singleton (void)

Static Public Member Functions

static MouseCursorgetSingleton (void)
 Return singleton MouseCursor object.
static MouseCursorgetSingletonPtr (void)
 Return pointer to singleton MouseCursor object.

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
static const String EventImageChanged
 The cursor image of the widget has changed.

Protected Types

typedef std::map< String,
Event * > 
EventMap

Protected Member Functions

virtual void onImageChanged (MouseCursorEventArgs &e)
 event triggered internally when image of mouse cursor changes
void addMouseCursorEvents (void)
 Add mouse cursor specific events.

Protected Attributes

EventMap d_events
bool d_muted
 true if events for this EventSet have been muted.

Static Protected Attributes

static MouseCursorms_Singleton = NULL

Detailed Description

Class that allows access to the GUI system mouse cursor.

The MouseCursor provides functionality to access the position and imagery of the mouse cursor / pointer

Definition at line 67 of file CEGUIMouseCursor.h.


Member Typedef Documentation

typedef ConstBaseIterator<EventMap> CEGUI::EventSet::EventIterator [inherited]
 

Definition at line 255 of file CEGUIEventSet.h.

typedef std::map<String, Event*> CEGUI::EventSet::EventMap [protected, inherited]
 

Definition at line 246 of file CEGUIEventSet.h.


Constructor & Destructor Documentation

CEGUI::MouseCursor::MouseCursor void   ) 
 

Constructor for MouseCursor objects.

Definition at line 56 of file CEGUIMouseCursor.cpp.

References addMouseCursorEvents(), CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, CEGUI::Vector3::d_z, CEGUI::Logger::getSingleton(), CEGUI::System::getSingleton(), CEGUI::Logger::logEvent(), and setConstraintArea().

CEGUI::MouseCursor::~MouseCursor void   ) 
 

Destructor for MouseCursor objects.

Definition at line 84 of file CEGUIMouseCursor.cpp.

References CEGUI::Logger::getSingleton(), and CEGUI::Logger::logEvent().


Member Function Documentation

void CEGUI::EventSet::addEvent const String name  )  [inherited]
 

Add a new Event to the EventSet with the given name.

Parameters:
name String object containing the name to give the new Event. The name must be unique for the EventSet.
Returns:
Nothing
Exceptions:
AlreadyExistsException Thrown if an Event already exists named name.

Definition at line 55 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, and CEGUI::EventSet::isEventPresent().

Referenced by CEGUI::Checkbox::addCheckboxEvents(), CEGUI::Combobox::addComboboxEvents(), CEGUI::ComboDropList::addComboDropListEvents(), CEGUI::DragContainer::addDragContainerEvents(), CEGUI::Editbox::addEditboxEvents(), CEGUI::FrameWindow::addFrameWindowEvents(), CEGUI::ListHeaderSegment::addHeaderSegmentEvents(), CEGUI::ItemListBase::addItemListBaseEvents(), CEGUI::Listbox::addListboxEvents(), CEGUI::ListHeader::addListHeaderEvents(), CEGUI::MenuBase::addMenuBaseEvents(), CEGUI::MenuItem::addMenuItemEvents(), addMouseCursorEvents(), CEGUI::MultiColumnList::addMultiColumnListboxEvents(), CEGUI::MultiLineEditbox::addMultiLineEditboxEvents(), CEGUI::ProgressBar::addProgressBarEvents(), CEGUI::PushButton::addPushButtonEvents(), CEGUI::RadioButton::addRadioButtonEvents(), CEGUI::ScrollablePane::addScrollablePaneEvents(), CEGUI::Scrollbar::addScrollbarEvents(), CEGUI::ScrolledContainer::addScrolledContainerEvents(), CEGUI::Slider::addSliderEvents(), CEGUI::Spinner::addSpinnerEvents(), CEGUI::Window::addStandardEvents(), CEGUI::TabButton::addTabButtonEvents(), CEGUI::TabControl::addTabControlEvents(), CEGUI::Thumb::addThumbEvents(), CEGUI::Tooltip::addTooltipEvents(), CEGUI::Renderer::Renderer(), and CEGUI::GlobalEventSet::subscribeEvent().

void CEGUI::MouseCursor::addMouseCursorEvents void   )  [protected]
 

Add mouse cursor specific events.

Definition at line 247 of file CEGUIMouseCursor.cpp.

References CEGUI::EventSet::addEvent(), and EventImageChanged.

Referenced by MouseCursor().

void CEGUI::MouseCursor::draw void   )  const
 

Makes the cursor draw itself.

Returns:
Nothing

Definition at line 114 of file CEGUIMouseCursor.cpp.

References CEGUI::Image::draw(), and CEGUI::System::getSingleton().

Referenced by CEGUI::System::renderGUI().

void CEGUI::EventSet::fireEvent const String name,
EventArgs args,
const String eventNamespace = ""
[virtual, inherited]
 

Fires the named event passing the given EventArgs object.

Parameters:
name String object holding the name of the Event that is to be fired (triggered)
args The EventArgs (or derived) object that is to be bassed to each subscriber of the Event. Once all subscribers have been called the 'handled' field of the event is updated appropriately.
eventNamespace String object describing the global event namespace prefix for this event.
Returns:
Nothing.
Exceptions:
UnknownObjectException Thrown if no Event named name was found in the EventSet.

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 160 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, CEGUI::EventSet::d_muted, CEGUI::GlobalEventSet::fireEvent(), and CEGUI::GlobalEventSet::getSingleton().

Referenced by CEGUI::ScrollablePane::handleAutoSizePaneChanged(), CEGUI::Window::onActivated(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onAlwaysOnTopChanged(), CEGUI::ScrolledContainer::onAutoSizeSettingChanged(), CEGUI::ScrollablePane::onAutoSizeSettingChanged(), CEGUI::Window::onCaptureGained(), CEGUI::Window::onCaptureLost(), CEGUI::MultiLineEditbox::onCaratMoved(), CEGUI::Editbox::onCaratMoved(), CEGUI::Combobox::onCaratMoved(), CEGUI::Window::onCharacter(), CEGUI::Window::onChildAdded(), CEGUI::Window::onChildRemoved(), CEGUI::ListHeaderSegment::onClickableSettingChanged(), CEGUI::TabButton::onClicked(), CEGUI::PushButton::onClicked(), CEGUI::MenuItem::onClicked(), CEGUI::Window::onClippingChanged(), CEGUI::FrameWindow::onCloseClicked(), CEGUI::ScrolledContainer::onContentChanged(), CEGUI::ScrollablePane::onContentPaneChanged(), CEGUI::ScrollablePane::onContentPaneScrolled(), CEGUI::Window::onDeactivated(), CEGUI::Window::onDestructionStarted(), CEGUI::Window::onDisabled(), CEGUI::Tooltip::onDisplayTimeChanged(), CEGUI::DragContainer::onDragAlphaChanged(), CEGUI::Window::onDragDropItemDropped(), CEGUI::Window::onDragDropItemEnters(), CEGUI::Window::onDragDropItemLeaves(), CEGUI::DragContainer::onDragDropTargetChanged(), CEGUI::DragContainer::onDragEnabledChanged(), CEGUI::DragContainer::onDragEnded(), CEGUI::DragContainer::onDragMouseCursorChanged(), CEGUI::ListHeader::onDragMoveSettingChanged(), CEGUI::DragContainer::onDragPositionChanged(), CEGUI::ListHeader::onDragSizeSettingChanged(), CEGUI::DragContainer::onDragStarted(), CEGUI::DragContainer::onDragThresholdChanged(), CEGUI::Combobox::onDropListDisplayed(), CEGUI::Combobox::onDroplistRemoved(), CEGUI::MultiLineEditbox::onEditboxFullEvent(), CEGUI::Editbox::onEditboxFullEvent(), CEGUI::Combobox::onEditboxFullEvent(), CEGUI::Window::onEnabled(), CEGUI::Tooltip::onFadeTimeChanged(), CEGUI::Window::onFontChanged(), CEGUI::Window::onHidden(), CEGUI::Window::onHorizontalAlignmentChanged(), CEGUI::ScrollablePane::onHorzScrollbarModeChanged(), CEGUI::MultiLineEditbox::onHorzScrollbarModeChanged(), CEGUI::MultiColumnList::onHorzScrollbarModeChanged(), CEGUI::Listbox::onHorzScrollbarModeChanged(), CEGUI::Combobox::onHorzScrollbarModeChanged(), CEGUI::Tooltip::onHoverTimeChanged(), CEGUI::Window::onIDChanged(), onImageChanged(), CEGUI::Window::onInheritsAlphaChanged(), CEGUI::Editbox::onInvalidEntryAttempted(), CEGUI::Combobox::onInvalidEntryAttempted(), CEGUI::Window::onKeyDown(), CEGUI::Window::onKeyUp(), CEGUI::MultiColumnList::onListColumnMoved(), CEGUI::MultiColumnList::onListColumnSized(), CEGUI::MultiColumnList::onListContentsChanged(), CEGUI::Listbox::onListContentsChanged(), CEGUI::ItemListBase::onListContentsChanged(), CEGUI::Combobox::onListContentsChanged(), CEGUI::ComboDropList::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionChanged(), CEGUI::Editbox::onMaskCodePointChanged(), CEGUI::Editbox::onMaskedRenderingModeChanged(), CEGUI::MultiLineEditbox::onMaximumTextLengthChanged(), CEGUI::Editbox::onMaximumTextLengthChanged(), CEGUI::Combobox::onMaximumTextLengthChanged(), CEGUI::Spinner::onMaximumValueChanged(), CEGUI::Window::onMetricsChanged(), CEGUI::Spinner::onMinimumValueChanged(), CEGUI::Window::onMouseButtonDown(), CEGUI::Window::onMouseButtonUp(), CEGUI::Window::onMouseClicked(), CEGUI::Window::onMouseDoubleClicked(), CEGUI::Window::onMouseEnters(), CEGUI::Window::onMouseLeaves(), CEGUI::Window::onMouseMove(), CEGUI::Window::onMouseTripleClicked(), CEGUI::Window::onMouseWheel(), CEGUI::ListHeaderSegment::onMovableSettingChanged(), CEGUI::Window::onMoved(), CEGUI::Listbox::onMultiselectModeChanged(), CEGUI::MultiColumnList::onNominatedSelectColumnChanged(), CEGUI::MultiColumnList::onNominatedSelectRowChanged(), CEGUI::Window::onParentDestroyChanged(), CEGUI::Window::onParentSized(), CEGUI::MenuBase::onPopupClosed(), CEGUI::MenuBase::onPopupOpened(), CEGUI::ProgressBar::onProgressChanged(), CEGUI::ProgressBar::onProgressDone(), CEGUI::MultiLineEditbox::onReadOnlyChanged(), CEGUI::Editbox::onReadOnlyChanged(), CEGUI::Combobox::onReadOnlyChanged(), CEGUI::Window::onRenderingEnded(), CEGUI::Window::onRenderingStarted(), CEGUI::FrameWindow::onRollupToggled(), CEGUI::Scrollbar::onScrollConfigChanged(), CEGUI::Scrollbar::onScrollPositionChanged(), CEGUI::ListHeader::onSegmentAdded(), CEGUI::ListHeaderSegment::onSegmentClicked(), CEGUI::ListHeader::onSegmentClicked(), CEGUI::ListHeaderSegment::onSegmentDragPositionChanged(), CEGUI::ListHeaderSegment::onSegmentDragStart(), CEGUI::ListHeaderSegment::onSegmentDragStop(), CEGUI::ListHeader::onSegmentOffsetChanged(), CEGUI::ListHeader::onSegmentRemoved(), CEGUI::ListHeader::onSegmentSequenceChanged(), CEGUI::ListHeaderSegment::onSegmentSized(), CEGUI::ListHeader::onSegmentSized(), CEGUI::TabControl::onSelectionChanged(), CEGUI::MultiColumnList::onSelectionChanged(), CEGUI::Listbox::onSelectionChanged(), CEGUI::MultiColumnList::onSelectionModeChanged(), CEGUI::Checkbox::onSelectStateChange(), CEGUI::RadioButton::onSelectStateChanged(), CEGUI::Window::onShown(), CEGUI::Window::onSized(), CEGUI::ListHeaderSegment::onSizingSettingChanged(), CEGUI::MultiColumnList::onSortColumnChanged(), CEGUI::ListHeader::onSortColumnChanged(), CEGUI::MultiColumnList::onSortDirectionChanged(), CEGUI::ListHeaderSegment::onSortDirectionChanged(), CEGUI::ListHeader::onSortDirectionChanged(), CEGUI::Listbox::onSortModeChanged(), CEGUI::Combobox::onSortModeChanged(), CEGUI::ListHeader::onSortSettingChanged(), CEGUI::ListHeaderSegment::onSplitterDoubleClicked(), CEGUI::ListHeader::onSplitterDoubleClicked(), CEGUI::Spinner::onStepChanged(), CEGUI::Editbox::onTextAcceptedEvent(), CEGUI::Combobox::onTextAcceptedEvent(), CEGUI::Window::onTextChanged(), CEGUI::Spinner::onTextInputModeChanged(), CEGUI::Editbox::onTextInvalidatedEvent(), CEGUI::Combobox::onTextInvalidatedEvent(), CEGUI::MultiLineEditbox::onTextSelectionChanged(), CEGUI::Editbox::onTextSelectionChanged(), CEGUI::Combobox::onTextSelectionChanged(), CEGUI::Thumb::onThumbPositionChanged(), CEGUI::Thumb::onThumbTrackEnded(), CEGUI::Slider::onThumbTrackEnded(), CEGUI::Scrollbar::onThumbTrackEnded(), CEGUI::Thumb::onThumbTrackStarted(), CEGUI::Slider::onThumbTrackStarted(), CEGUI::Scrollbar::onThumbTrackStarted(), CEGUI::Tooltip::onTooltipActive(), CEGUI::Tooltip::onTooltipInactive(), CEGUI::Editbox::onValidationStringChanged(), CEGUI::Combobox::onValidationStringChanged(), CEGUI::Spinner::onValueChanged(), CEGUI::Slider::onValueChanged(), CEGUI::Window::onVerticalAlignmentChanged(), CEGUI::ScrollablePane::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onVertScrollbarModeChanged(), CEGUI::MultiColumnList::onVertScrollbarModeChanged(), CEGUI::Listbox::onVertScrollbarModeChanged(), CEGUI::Combobox::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onWordWrapModeChanged(), CEGUI::Window::onZChanged(), CEGUI::DirectX81Renderer::setDisplaySize(), CEGUI::OpenGLRenderer::setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().

Rect CEGUI::MouseCursor::getConstraintArea void   )  const
 

return the current constraint area of the mouse cursor.

Returns:
Rect object describing the active area that the mouse cursor is constrained to.

Definition at line 219 of file CEGUIMouseCursor.cpp.

References CEGUI::URect::asAbsolute(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), and CEGUI::Renderer::getSize().

Referenced by CEGUI::Titlebar::onMouseButtonDown().

Point CEGUI::MouseCursor::getDisplayIndependantPosition void   )  const
 

Return the current mouse cursor position as display resolution independant values.

Returns:
Point object describing the current mouse cursor position as resolution independant values that range from 0.0f to 1.0f, where 0.0f represents the left-most and top-most positions, and 1.0f represents the right-most and bottom-most positions.

Definition at line 236 of file CEGUIMouseCursor.cpp.

References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::System::getSingleton().

const Image* CEGUI::MouseCursor::getImage void   )  const [inline]
 

Get the current mouse cursor image.

Returns:
The current image used to draw mouse cursor.

Definition at line 144 of file CEGUIMouseCursor.h.

Referenced by CEGUI::Tooltip::positionSelf(), and setImage().

EventSet::EventIterator CEGUI::EventSet::getIterator void   )  const [inherited]
 

Return a EventSet::EventIterator object to iterate over the available events.

Definition at line 203 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Point CEGUI::MouseCursor::getPosition void   )  const [inline]
 

Return the current mouse cursor position as a pixel offset from the top-left corner of the display.

Returns:
Point object describing the mouse cursor position in screen pixels.

Definition at line 247 of file CEGUIMouseCursor.h.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), and CEGUI::Tooltip::positionSelf().

MouseCursor & CEGUI::MouseCursor::getSingleton void   )  [static]
 

Return singleton MouseCursor object.

Returns:
Singleton MouseCursor object

Reimplemented from CEGUI::Singleton< MouseCursor >.

Definition at line 268 of file CEGUIMouseCursor.cpp.

Referenced by CEGUI::Window::generateAutoRepeatEvent(), CEGUI::ListHeaderSegment::initDragMoving(), CEGUI::ListHeaderSegment::initSegmentHoverState(), CEGUI::ListHeaderSegment::initSizingHoverState(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseLeaves(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMousePosition(), CEGUI::System::injectMouseWheelChange(), CEGUI::Titlebar::onCaptureLost(), CEGUI::MenuItem::onCaptureLost(), CEGUI::ButtonBase::onCaptureLost(), CEGUI::DragContainer::onDragPositionChanged(), CEGUI::EventPusher::OnMouse(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::Window::onMouseEnters(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::Tooltip::positionSelf(), CEGUI::System::renderGUI(), CEGUI::ListHeader::segmentDragHandler(), CEGUI::ListHeader::segmentMovedHandler(), CEGUI::FrameWindow::setCursorForPoint(), and CEGUI::DragContainer::updateActiveMouseCursor().

MouseCursor * CEGUI::MouseCursor::getSingletonPtr void   )  [static]
 

Return pointer to singleton MouseCursor object.

Returns:
Pointer to singleton MouseCursor object

Reimplemented from CEGUI::Singleton< MouseCursor >.

Definition at line 274 of file CEGUIMouseCursor.cpp.

Referenced by CEGUI::System::~System().

const URect & CEGUI::MouseCursor::getUnifiedConstraintArea void   )  const
 

return the current constraint area of the mouse cursor.

Returns:
URect object describing the active area that the mouse cursor is constrained to.

Definition at line 227 of file CEGUIMouseCursor.cpp.

void CEGUI::MouseCursor::hide void   )  [inline]
 

Hides the mouse cursor.

Returns:
Nothing.

Definition at line 217 of file CEGUIMouseCursor.h.

bool CEGUI::EventSet::isEventPresent const String name  )  [inherited]
 

Checks to see if an Event with the given name is present in the EventSet.

Returns:
true if an Event named name was found, or false if the Event was not found

Definition at line 102 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::addEvent().

bool CEGUI::EventSet::isMuted void   )  const [inherited]
 

Return whether the EventSet is muted or not.

Returns:
  • true if the EventSet is muted. All requests to fire events will be ignored.
  • false if the EventSet is not muted. All requests to fire events are processed as normal.

Definition at line 184 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

Referenced by CEGUI::Spinner::onTextInputModeChanged(), and CEGUI::Spinner::onValueChanged().

bool CEGUI::MouseCursor::isVisible void   )  const [inline]
 

return whether the mouse cursor is visible.

Returns:
true if the mouse cursor is visible, false if the mouse cursor is hidden.

Definition at line 237 of file CEGUIMouseCursor.h.

void CEGUI::MouseCursor::offsetPosition const Point offset  ) 
 

Offset the mouse cursor position by the deltas specified in offset.

Parameters:
offset Point object which describes the amount to move the cursor in each axis.
Returns:
Nothing.

Definition at line 137 of file CEGUIMouseCursor.cpp.

References CEGUI::Vector2::d_x, CEGUI::Vector3::d_x, CEGUI::Vector2::d_y, and CEGUI::Vector3::d_y.

Referenced by CEGUI::System::injectMouseMove().

void CEGUI::MouseCursor::onImageChanged MouseCursorEventArgs e  )  [protected, virtual]
 

event triggered internally when image of mouse cursor changes

Definition at line 262 of file CEGUIMouseCursor.cpp.

References EventImageChanged, EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by setImage().

void CEGUI::EventSet::removeAllEvents void   )  [inherited]
 

Remove all Event objects from the EventSet.

Returns:
Nothing

Definition at line 85 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::~EventSet().

void CEGUI::EventSet::removeEvent const String name  )  [inherited]
 

Removes the Event with the given name. All connections to the event are disconnected.

Parameters:
name String object containing the name of the Event to remove. If no such Event exists, nothing happens.
Returns:
Nothing.

Definition at line 69 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

void CEGUI::MouseCursor::setConstraintArea const Rect area  ) 
 

Set the area that the mouse cursor is constrained to.

Parameters:
area Pointer to a Rect object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current Renderer screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current Renderer screen area.
Returns:
Nothing.

Definition at line 170 of file CEGUIMouseCursor.cpp.

References cegui_reldim, CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::URect::d_max, CEGUI::URect::d_min, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::UVector2::d_x, CEGUI::UVector2::d_y, CEGUI::Rect::getHeight(), CEGUI::Rect::getIntersection(), CEGUI::Renderer::getRect(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), and CEGUI::Rect::getWidth().

Referenced by MouseCursor(), CEGUI::Titlebar::onCaptureLost(), and CEGUI::Titlebar::onMouseButtonDown().

void CEGUI::MouseCursor::setImage const Image image  ) 
 

Set the current mouse cursor image.

Definition at line 93 of file CEGUIMouseCursor.cpp.

References CEGUI::MouseCursorEventArgs::image, and onImageChanged().

void CEGUI::MouseCursor::setImage const String imageset,
const String image_name
 

Set the current mouse cursor image.

Parameters:
imageset String object holding the name of the Imageset that contains the desired Image.
image_name String object holding the name of the desired Image on Imageset imageset.
Returns:
Nothing.
Exceptions:
UnknownObjectException thrown if imageset is not known, or if imageset contains no Image named image_name.

Definition at line 105 of file CEGUIMouseCursor.cpp.

References getImage(), and CEGUI::ImagesetManager::getSingleton().

Referenced by CEGUI::ListHeaderSegment::initDragMoving(), CEGUI::ListHeaderSegment::initSegmentHoverState(), CEGUI::ListHeaderSegment::initSizingHoverState(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::Window::onMouseEnters(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::setCursorForPoint(), and CEGUI::DragContainer::updateActiveMouseCursor().

void CEGUI::EventSet::setMutedState bool  setting  )  [inherited]
 

Set the mute state for this EventSet.

Parameters:
setting 
  • true if the EventSet is to be muted (no further event firing requests will be honoured until EventSet is unmuted).
  • false if the EventSet is not to be muted and all events should fired as requested.
Returns:
Nothing.

Definition at line 193 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

Referenced by CEGUI::Spinner::onTextInputModeChanged(), and CEGUI::Spinner::onValueChanged().

void CEGUI::MouseCursor::setPosition const Point position  ) 
 

Set the current mouse cursor position.

Parameters:
position Point object describing the new location for the mouse. This will be clipped to within the renderer screen area.

Definition at line 126 of file CEGUIMouseCursor.cpp.

References CEGUI::Vector2::d_x, CEGUI::Vector3::d_x, CEGUI::Vector2::d_y, and CEGUI::Vector3::d_y.

Referenced by CEGUI::System::injectMousePosition(), and CEGUI::EventPusher::OnMouse().

void CEGUI::MouseCursor::setUnifiedConstraintArea const URect area  ) 
 

Set the area that the mouse cursor is constrained to.

Parameters:
area Pointer to a URect object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current Renderer screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current Renderer screen area.
Returns:
Nothing.

Definition at line 197 of file CEGUIMouseCursor.cpp.

References cegui_reldim, CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::URect::d_max, CEGUI::URect::d_min, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::UVector2::d_x, CEGUI::UVector2::d_y, CEGUI::Rect::getHeight(), CEGUI::Renderer::getRect(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), and CEGUI::Rect::getWidth().

void CEGUI::MouseCursor::show void   )  [inline]
 

Shows the mouse cursor.

Returns:
Nothing.

Definition at line 227 of file CEGUIMouseCursor.h.

CEGUI::Singleton< MouseCursor >::Singleton void   )  [inline, inherited]
 

Definition at line 58 of file CEGUISingleton.h.

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Group  group,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the specified group of the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
group Group which is to be subscribed to. Subscription groups are called in ascending order.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 145 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 129 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::addTab(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::StaticText::initialise(), CEGUI::Spinner::initialise(), CEGUI::Slider::initialise(), CEGUI::Scrollbar::initialise(), CEGUI::ScrollablePane::initialise(), CEGUI::MultiLineEditbox::initialise(), CEGUI::MultiColumnList::initialise(), CEGUI::Listbox::initialise(), CEGUI::Combobox::initialise(), CEGUI::ScrolledContainer::onChildAdded(), and CEGUI::EventSet::subscribeScriptedEvent().

Event::Connection CEGUI::EventSet::subscribeScriptedEvent const String name,
Event::Group  group,
const String subscriber_name
[virtual, inherited]
 

Subscribes the specified group of the named Event to a scripted funtion.

Parameters:
name String object containing the name of the Event to subscribe to.
group Group which is to be subscribed to. Subscription groups are called in ascending order.
subscriber_name String object containing the name of the script funtion that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Definition at line 120 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::subscribeEvent().

Event::Connection CEGUI::EventSet::subscribeScriptedEvent const String name,
const String subscriber_name
[virtual, inherited]
 

Subscribes the named Event to a scripted funtion.

Parameters:
name String object containing the name of the Event to subscribe to.
subscriber_name String object containing the name of the script funtion that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Definition at line 111 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::subscribeEvent().


Member Data Documentation

EventMap CEGUI::EventSet::d_events [protected, inherited]
 

Definition at line 247 of file CEGUIEventSet.h.

Referenced by CEGUI::EventSet::addEvent(), CEGUI::GlobalEventSet::fireEvent(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::getIterator(), CEGUI::EventSet::isEventPresent(), CEGUI::EventSet::removeAllEvents(), CEGUI::EventSet::removeEvent(), CEGUI::GlobalEventSet::subscribeEvent(), and CEGUI::EventSet::subscribeEvent().

bool CEGUI::EventSet::d_muted [protected, inherited]
 

true if events for this EventSet have been muted.

Definition at line 249 of file CEGUIEventSet.h.

Referenced by CEGUI::GlobalEventSet::fireEvent(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::isMuted(), and CEGUI::EventSet::setMutedState().

const String CEGUI::MouseCursor::EventImageChanged [static]
 

The cursor image of the widget has changed.

Referenced by addMouseCursorEvents(), and onImageChanged().

const String CEGUI::MouseCursor::EventNamespace [static]
 

Namespace for global events.

Referenced by onImageChanged().

MouseCursor * CEGUI::Singleton< MouseCursor >::ms_Singleton = NULL [static, protected, inherited]
 

Definition at line 44 of file CEGUIMouseCursor.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:06:37 2005 for Crazy Eddies GUI System by  doxygen 1.4.3