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

CEGUI::EventSet Class Reference

Class that collects together a set of Event objects. More...

#include <CEGUIEventSet.h>

Inheritance diagram for CEGUI::EventSet:

Inheritance graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
EventMap
EventIterator

Public Member Functions

 EventSet ()
 Constructor for EventSet objects.
virtual ~EventSet (void)
 Destructor for EventSet objects.
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.

Protected Types

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

Protected Member Functions

 EventSet (EventSet &e)
EventSetoperator= (EventSet &e)

Protected Attributes

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

Detailed Description

Class that collects together a set of Event objects.

The EventSet used to collect Event objects together, and allow access to them by a unique name

Definition at line 51 of file CEGUIEventSet.h.


Member Typedef Documentation

typedef ConstBaseIterator<EventMap> CEGUI::EventSet::EventIterator
 

Definition at line 255 of file CEGUIEventSet.h.

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

Definition at line 246 of file CEGUIEventSet.h.


Constructor & Destructor Documentation

CEGUI::EventSet::EventSet  ) 
 

Constructor for EventSet objects.

Definition at line 37 of file CEGUIEventSet.cpp.

CEGUI::EventSet::~EventSet void   )  [virtual]
 

Destructor for EventSet objects.

Definition at line 46 of file CEGUIEventSet.cpp.

References removeAllEvents().

CEGUI::EventSet::EventSet EventSet e  )  [inline, protected]
 

Definition at line 243 of file CEGUIEventSet.h.


Member Function Documentation

void CEGUI::EventSet::addEvent const String name  ) 
 

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 d_events, and 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(), CEGUI::MouseCursor::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::EventSet::fireEvent const String name,
EventArgs args,
const String eventNamespace = ""
[virtual]
 

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 d_events, 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(), CEGUI::MouseCursor::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().

EventSet::EventIterator CEGUI::EventSet::getIterator void   )  const
 

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

Definition at line 203 of file CEGUIEventSet.cpp.

References d_events.

bool CEGUI::EventSet::isEventPresent const String name  ) 
 

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 d_events.

Referenced by addEvent().

bool CEGUI::EventSet::isMuted void   )  const
 

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 d_muted.

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

EventSet& CEGUI::EventSet::operator= EventSet e  )  [inline, protected]
 

Definition at line 244 of file CEGUIEventSet.h.

void CEGUI::EventSet::removeAllEvents void   ) 
 

Remove all Event objects from the EventSet.

Returns:
Nothing

Definition at line 85 of file CEGUIEventSet.cpp.

References d_events.

Referenced by ~EventSet().

void CEGUI::EventSet::removeEvent const String name  ) 
 

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 d_events.

void CEGUI::EventSet::setMutedState bool  setting  ) 
 

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 d_muted.

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

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

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 d_events.

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

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 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 subscribeScriptedEvent().

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

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 subscribeEvent().

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

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 subscribeEvent().


Member Data Documentation

EventMap CEGUI::EventSet::d_events [protected]
 

Definition at line 247 of file CEGUIEventSet.h.

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

bool CEGUI::EventSet::d_muted [protected]
 

true if events for this EventSet have been muted.

Definition at line 249 of file CEGUIEventSet.h.

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


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