MouseEvent Class Reference

#include <mouseevent.h>

Inheritance diagram for MouseEvent:

Public Member Functions
	MouseEvent (Widget *const source, const MouseEventTypeT type, const MouseButtonT button, const int x, const int y, const int clickCount)
MouseButtonT	getButton () const
int	getX () const
int	getY () const
int	getClickCount () const
MouseEventTypeT	getType () const
void	setX (int n)
void	setY (int n)
Public Member Functions inherited from InputGuiEvent
	InputGuiEvent (Widget *const source)
void	consume ()
bool	isConsumed () const
Public Member Functions inherited from Event
	Event (Widget *const source)
virtual	~Event ()
Widget *	getSource () const

Protected Attributes
MouseEventTypeT	mType
MouseButtonT	mButton
int	mX
int	mY
int	mClickCount
Protected Attributes inherited from InputGuiEvent
bool	mIsConsumed
Protected Attributes inherited from Event
Widget *	mSource

Friends
class	Gui

Detailed Description

Represents a mouse event.

Author

Olof Naessén

Definition at line 80 of file mouseevent.h.

Constructor & Destructor Documentation

MouseEvent()

MouseEvent::MouseEvent ( Widget *const  source, const MouseEventTypeT  type, const MouseButtonT  button, const int  x, const int  y, const int  clickCount  )

inline

Constructor.

Parameters

source	The source widget of the mouse event.
type	The type of the mouse event.
button	The button of the mouse event.
x	The x coordinate of the event relative to the source widget.
y	The y coordinate of the event relative the source widget.
clickCount	The number of clicks generated with the same button. It's set to zero if another button is used.

Definition at line 94 of file mouseevent.h.

                                         :
            InputGuiEvent(source),
            mType(type),
            mButton(button),
            mX(x),
            mY(y),
            mClickCount(clickCount)
        {
        }

Member Function Documentation

getButton()

MouseButtonT MouseEvent::getButton ( ) const

inline

Gets the button of the mouse event.

Returns

The button of the mouse event.

Definition at line 116 of file mouseevent.h.

        { return mButton; }

References mButton.

Referenced by WhoIsOnline::handleLink(), CheckBox::mouseClicked(), RadioButton::mouseClicked(), InventoryWindow::mouseClicked(), MailWindow::mouseClicked(), ServerDialog::mouseClicked(), GuiTable::mouseDragged(), ItemShortcutContainer::mouseDragged(), ListBox::mouseDragged(), SpellShortcutContainer::mouseDragged(), VirtShortcutContainer::mouseDragged(), OutfitWindow::mouseDragged(), Button::mousePressed(), DropDown::mousePressed(), GuiTable::mousePressed(), ItemShortcutContainer::mousePressed(), ScrollArea::mousePressed(), Slider::mousePressed(), TabbedArea::mousePressed(), TextBox::mousePressed(), TextField::mousePressed(), WindowMenu::mousePressed(), ChatWindow::mousePressed(), EquipmentWindow::mousePressed(), Minimap::mousePressed(), MiniStatusWindow::mousePressed(), NpcDialog::mousePressed(), OutfitWindow::mousePressed(), ShortcutWindow::mousePressed(), Button::mouseReleased(), ItemShortcutContainer::mouseReleased(), PlayerBox::mouseReleased(), ScrollArea::mouseReleased(), ShopListBox::mouseReleased(), VirtShortcutContainer::mouseReleased(), Minimap::mouseReleased(), OutfitWindow::mouseReleased(), and ListBox::mouseReleased1().

getClickCount()

int MouseEvent::getClickCount ( ) const

inline

Gets the number of clicks generated with the same button. It's set to zero if another button is used.

Returns

The number of clicks generated with the same button.

Definition at line 147 of file mouseevent.h.

        { return mClickCount; }

References mClickCount.

Referenced by MailWindow::mouseClicked(), ServerDialog::mouseClicked(), CharacterDisplay::mousePressed(), and ListBox::mouseReleased().

getType()

MouseEventTypeT MouseEvent::getType ( ) const

inline

Gets the type of the event.

Returns

The type of the event.

Definition at line 155 of file mouseevent.h.

        { return mType; }

References mType.

Referenced by ItemContainer::mouseReleased(), and ShopListBox::mouseReleased().

getX()

int MouseEvent::getX ( ) const

inline

Gets the x coordinate of the mouse event. The coordinate relative to widget the mouse listener receiving the events have registered to.

Returns

The x coordinate of the mouse event.

See also

Widget::addMouseListener, Widget::removeMouseListener

Definition at line 127 of file mouseevent.h.

        { return mX; }

References mX.

Referenced by Window::getResizeHandles(), GuiTable::mouseDragged(), ItemShortcutContainer::mouseDragged(), Slider::mouseDragged(), SpellShortcutContainer::mouseDragged(), VirtShortcutContainer::mouseDragged(), Window::mouseDragged(), ChatWindow::mouseDragged(), OutfitWindow::mouseDragged(), ShortcutWindow::mouseDragged(), Viewport::mouseDragged(), BrowserBox::mouseMoved(), ItemContainer::mouseMoved(), ItemShortcutContainer::mouseMoved(), SpellShortcutContainer::mouseMoved(), StaticBrowserBox::mouseMoved(), VirtShortcutContainer::mouseMoved(), BrowserBox::mousePressed(), EmotePage::mousePressed(), GuiTable::mousePressed(), ItemContainer::mousePressed(), ItemShortcutContainer::mousePressed(), SpellShortcutContainer::mousePressed(), StaticBrowserBox::mousePressed(), TabbedArea::mousePressed(), TextBox::mousePressed(), TextField::mousePressed(), VirtShortcutContainer::mousePressed(), OutfitWindow::mousePressed(), ItemContainer::mouseReleased(), ItemShortcutContainer::mouseReleased(), SpellShortcutContainer::mouseReleased(), VirtShortcutContainer::mouseReleased(), and OutfitWindow::mouseReleased().

getY()

int MouseEvent::getY ( ) const

inline

Gets the y coordinate of the mouse event. The coordinate relative to widget the mouse listener receiving the events have registered to.

Returns

The y coordinate of the mouse event.

See also

Widget::addMouseListener, Widget::removeMouseListener

Definition at line 138 of file mouseevent.h.

        { return mY; }

References mY.

Referenced by Window::getResizeHandles(), GuiTable::mouseDragged(), ItemShortcutContainer::mouseDragged(), ListBox::mouseDragged(), Slider::mouseDragged(), SpellShortcutContainer::mouseDragged(), VirtShortcutContainer::mouseDragged(), Window::mouseDragged(), ChatWindow::mouseDragged(), OutfitWindow::mouseDragged(), ShortcutWindow::mouseDragged(), Viewport::mouseDragged(), BrowserBox::mouseMoved(), ItemContainer::mouseMoved(), ItemShortcutContainer::mouseMoved(), SpellShortcutContainer::mouseMoved(), StaticBrowserBox::mouseMoved(), VirtShortcutContainer::mouseMoved(), BrowserBox::mousePressed(), EmotePage::mousePressed(), GuiTable::mousePressed(), ItemContainer::mousePressed(), ItemShortcutContainer::mousePressed(), ListBox::mousePressed(), PopupList::mousePressed(), SpellShortcutContainer::mousePressed(), StaticBrowserBox::mousePressed(), TabbedArea::mousePressed(), VirtShortcutContainer::mousePressed(), OutfitWindow::mousePressed(), ItemContainer::mouseReleased(), ItemShortcutContainer::mouseReleased(), ListBox::mouseReleased(), PopupList::mouseReleased(), ShopListBox::mouseReleased(), SpellShortcutContainer::mouseReleased(), VirtShortcutContainer::mouseReleased(), OutfitWindow::mouseReleased(), and ListBox::mouseReleased1().

setX()

void MouseEvent::setX ( int  n )

inline

Definition at line 158 of file mouseevent.h.

        { mX = n; }

References mX.

setY()

void MouseEvent::setY ( int  n )

inline

Definition at line 161 of file mouseevent.h.

        { mY = n; }

References mY.

Friends And Related Function Documentation

Gui

friend class Gui

friend

Gui is a friend of this class in order to be able to manipulate the protected member variables of this class and at the same time keep the MouseEvent class as const as possible. Gui needs to update the x och y coordinates for the coordinates to be relative to widget the mouse listener receiving the events have registered to.

Definition at line 199 of file mouseevent.h.

Field Documentation

mButton

MouseButtonT MouseEvent::mButton

protected

Holds the button of the mouse event.

Definition at line 173 of file mouseevent.h.

Referenced by getButton().

mClickCount

int MouseEvent::mClickCount

protected

The number of clicks generated with the same button. It's set to zero if another button is used.

Definition at line 189 of file mouseevent.h.

Referenced by getClickCount().

mType

MouseEventTypeT MouseEvent::mType

protected

Holds the type of the mouse event.

Definition at line 168 of file mouseevent.h.

Referenced by getType().

mX

int MouseEvent::mX

protected

Holds the x-coordinate of the mouse event.

Definition at line 178 of file mouseevent.h.

Referenced by getX(), and setX().

mY

int MouseEvent::mY

protected

Holds the y-coordinate of the mouse event.

Definition at line 183 of file mouseevent.h.

Referenced by getY(), and setY().

---

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

• src/events/mouseevent.h (986a3bf)