Wt::SDLInput Class Reference

useful for transforming SDL events to normal Event More...

#include <sdlinput.h>

Inheritance diagram for Wt::SDLInput:

[legend]Collaboration diagram for Wt::SDLInput:

[legend]List of all members.

Public Member Functions
void	setKeyboardGrabber (Widget *w)
void	releaseKeyboardGrab ()
Widget *	keyboardGrabber () const
void	setMouseGrabber (Widget *w)
Widget *	mouseGrabber () const
void	releaseMouseGrab ()
Static Public Member Functions
static DERIVED *	instance ()
template<class GRANDCHILD>
static DERIVED *	instance ()
	instantiates the pointer compatible child of DERIVED aka grandchild
static DERIVED *	existingInstance ()
static void	init ()
static void	quit ()
Protected Member Functions
	SDLInput ()
Static Protected Member Functions
static void	handleKeyEvent (const SDL_Event *event)
static void	handleMouseEvent (const SDL_Event *event)
static void	handleActiveEvent (const SDL_Event *event)
static void	handleQuitEvent (const SDL_Event *event)
static void	handleVideoResizeEvent (const SDL_Event *event)
static void	handleUnusualEvent (const SDL_Event *event)
static DERIVED *	load ()
	try to load the instance
Static Protected Attributes
static DERIVED *	instance_ = 0
Private Attributes
Widget *	keyboard_grabber
Widget *	mouse_grabber
Static Private Attributes
static EventInfo	previous_position_
static EventInfo	previous_button_
static const FlagMap	buttonMap
	static members
static const FlagMap	wheelMap
static const FlagMap	keyMap
Friends
class	Singleton< SDLInput >
Classes
class	EventInfo
	converted event to wt semantics More...

---

Detailed Description

useful for transforming SDL events to normal Event

Definition at line 36 of file sdlinput.h.

---

Constructor & Destructor Documentation

Wt::SDLInput::SDLInput

(

)

[protected]

Definition at line 131 of file sdlinput.cpp.

References Wt::SDLEvent::Active, handleActiveEvent(), handleKeyEvent(), handleMouseEvent(), handleQuitEvent(), handleUnusualEvent(), handleVideoResizeEvent(), Wt::Singleton< DERIVED >::instance(), Wt::SDLEvent::KeyDown, Wt::SDLEvent::KeyUp, Wt::SDLEvent::MouseButtonDown, Wt::SDLEvent::MouseButtonUp, Wt::SDLEvent::MouseMotion, Wt::SDLEvent::Quit, Wt::SDLEvent::SysWM, Wt::SDLEvent::VideoExpose, and Wt::SDLEvent::VideoResize.

        : Singleton<SDLInput>(this),
        keyboard_grabber(0),
mouse_grabber(0) {
    SDLEvent& sdlevent = *SDLEvent::instance();
    sdlevent[SDLEvent::Active] = &handleActiveEvent;
    sdlevent[SDLEvent::KeyDown] = &handleKeyEvent;
    sdlevent[SDLEvent::KeyUp] = &handleKeyEvent;
    sdlevent[SDLEvent::MouseMotion] = &handleMouseEvent;
    sdlevent[SDLEvent::MouseButtonDown] = &handleMouseEvent;
    sdlevent[SDLEvent::MouseButtonUp] = &handleMouseEvent;
    sdlevent[SDLEvent::Quit] = &handleQuitEvent;
    sdlevent[SDLEvent::VideoResize] = &handleVideoResizeEvent;
    sdlevent[SDLEvent::SysWM] = &handleUnusualEvent;
    sdlevent[SDLEvent::VideoExpose] = &handleUnusualEvent;
}

Here is the call graph for this function:

---

Member Function Documentation

template<class DERIVED>

static DERIVED* Wt::Singleton< DERIVED >::existingInstance

(

)

[inline, static, inherited]

Definition at line 36 of file singleton.h.

Referenced by Wt::Application::exit(), Wt::Application::postEvent(), Wt::Application::sendEvent(), and Wt::Application::sendPostedEvents().

                                       {
        return instance_;
    }

void Wt::SDLInput::handleActiveEvent

(

const SDL_Event *

event

)

[static, protected]

Definition at line 262 of file sdlinput.cpp.

References Wt::FocusEvent::ActiveWindow, Wt::Event::FocusIn, Wt::Event::FocusOut, Wt::RootWindow::instance(), Wt::Event::Leave, Wt::Application::postEvent(), previous_position_, trace, and Wt::SDLInput::EventInfo::widget.

Referenced by SDLInput().

                                                       {
    if (event->active.state & SDL_APPMOUSEFOCUS &&
            !event->active.gain) {
        trace("sdlactive", "Application mouse lost...\n");
        // we are out of SDL window. We have to send Leave event
        if (previous_position_.widget) {
            Application::postEvent(previous_position_.widget,
                                   new Event(Event::Leave));
        }
        previous_position_.widget = 0;
    }
    if (event->active.state & SDL_APPINPUTFOCUS) {
        trace("sdlactive", "Application Focus...\n");
        Application::postEvent(RootWindow::instance()->focusWidget(),
                               new FocusEvent((event->active.gain) ?
                                              Event::FocusIn :
                                              Event::FocusOut,
                                              FocusEvent::ActiveWindow));
    }
    // if deiconify
    /// this doesn't look usefull
    if (event->active.state & SDL_APPACTIVE && event->active.gain) {
        trace("sdlactive", "Deiconify...\n");
        //RootWindow::rootWindow()->update();
    }
}

Here is the call graph for this function:

void Wt::SDLInput::handleKeyEvent

(

const SDL_Event *

event

)

[static, protected]

Definition at line 172 of file sdlinput.cpp.

References Wt::Widget::focusWidget(), Wt::Singleton< DERIVED >::instance(), Wt::RootWindow::instance(), Wt::Object::isDescendant(), Wt::Key_Backtab, Wt::Key_Tab, keyMap, Wt::Event::KeyPress, Wt::Event::KeyRelease, Wt::Application::postEvent(), Wt::ShiftButton, and Wt::FlagMap::state().

Referenced by SDLInput().

                                                    {
    switch(event->type) {
    case SDL_KEYDOWN:
    case SDL_KEYUP: {
            const SDL_KeyboardEvent *ke = reinterpret_cast<
                                          const SDL_KeyboardEvent *>(event);
            int keymap_state = keyMap.state(ke->keysym.mod);
            int sym = ke->keysym.sym;
            if (ke->keysym.sym == SDLK_TAB) {
                sym = (keymap_state & ShiftButton) ? Key_Backtab : Key_Tab;
            }
            Widget *w = RootWindow::instance()->focusWidget();
            Widget *kg = SDLInput::instance()->keyboardGrabber();
            w = (!kg || w->isDescendant(kg)) ? w : kg;
            Application::postEvent(w, new KeyEvent((ke->type == SDL_KEYDOWN) ?
                                                   Event::KeyPress :
                                                   Event::KeyRelease,
                                                   sym, keymap_state));
        }
        break;
    default:
        assert(0);
        break;
    }
    return;
}

Here is the call graph for this function:

void Wt::SDLInput::handleMouseEvent

(

const SDL_Event *

event

)

[static, protected]

Todo:

drag n' drop

Definition at line 200 of file sdlinput.cpp.

References Wt::SDLInput::EventInfo::button, Wt::SDLInput::EventInfo::button_event_type, Wt::Event::Enter, Wt::Event::Leave, Wt::Widget::mapFromGlobal(), Wt::Event::MouseButtonDblClick, Wt::MouseButtonMask, Wt::Event::MouseMove, Wt::Widget::mouseTracking, Wt::SDLInput::EventInfo::point, Wt::Application::postEvent(), previous_button_, previous_position_, Wt::SDLInput::EventInfo::state, trace, Wt::SDLInput::EventInfo::wheel_delta, Wt::SDLInput::EventInfo::widget, Wt::Point::x(), and Wt::Point::y().

Referenced by SDLInput().

                                                      {
    const EventInfo ei(event);

    // let's skip this event if we can't find the originating
    // widget i.e. window resize
    if (!ei.widget)
        return;

    // position in widget coordinates
    const Point& wp = ei.widget->mapFromGlobal(ei.point);

    trace("sdlinput", "Position [%d, %d] button %d (%d) state %d wheel %d\n",
          ei.point.x(), ei.point.y(), ei.button,
          ei.button_event_type, ei.state, ei.wheel_delta);
    trace("sdlinput") << "Inside " << ei.widget << std::endl;
    trace("sdlinput", "Widget's corrds [%d, %d]\n", wp.x(), wp.y());

    switch(event->type) {
    case SDL_MOUSEMOTION:
        if ((ei.state & MouseButtonMask) || ei.widget->mouseTracking) {
            Application::postEvent(ei.widget, new MouseEvent(Event::MouseMove,
                                   wp, ei.point, ei.button, ei.state));
        }

        if (ei.widget != previous_position_.widget) {
            if (previous_position_.widget) {
                Application::postEvent(previous_position_.widget,
                                       new Event(Event::Leave));
            }
            Application::postEvent(ei.widget,
                                   new Event(Event::Enter));
        }
        previous_position_ = ei;
        break;
    case SDL_MOUSEBUTTONDOWN:
        if (ei.wheel_delta) {
            Application::postEvent(ei.widget, new WheelEvent(wp,
                                   ei.point, ei.wheel_delta, ei.button));
            break;
        }
        // check for double click
        if (ei == previous_button_) {
            Application::postEvent(ei.widget, new MouseEvent(
                                       Event::MouseButtonDblClick, wp,
                                       ei.point, ei.button, ei.state));
            break;
        }
        previous_button_ = ei;
    case SDL_MOUSEBUTTONUP:
        if (!ei.wheel_delta) {
            Application::postEvent(ei.widget, new MouseEvent(
                                       ei.button_event_type, wp,
                                       ei.point, ei.button, ei.state));
        }
        break;
    default:
        assert(0);
        break;
    }
    return;
}

Here is the call graph for this function:

void Wt::SDLInput::handleQuitEvent

(

const SDL_Event *

event

)

[static, protected]

Definition at line 289 of file sdlinput.cpp.

References Wt::Application::exit().

Referenced by SDLInput().

                                                {
    Application::exit();
}

Here is the call graph for this function:

void Wt::SDLInput::handleUnusualEvent

(

const SDL_Event *

event

)

[static, protected]

Definition at line 297 of file sdlinput.cpp.

References Warn.

Referenced by SDLInput().

                                                        {
    Warn("Unusual SDL_Event type: %d\n", event->type);
}

void Wt::SDLInput::handleVideoResizeEvent

(

const SDL_Event *

event

)

[static, protected]

Definition at line 293 of file sdlinput.cpp.

References Wt::RootWindow::instance(), and Wt::RootWindow::resize().

Referenced by SDLInput().

                                                            {
    RootWindow::instance()->resize(event->resize.w, event->resize.h);
}

Here is the call graph for this function:

template<class DERIVED>

static void Wt::Singleton< DERIVED >::init

(

)

[inline, static, inherited]

Note:

cannot fail

Reimplemented in Wt::Application.

Definition at line 49 of file singleton.h.

Referenced by Wt::Application::Application().

                       {
        if (!instance()) {
            assert(0);
        }
    }

template<class DERIVED>

template<class GRANDCHILD>

static DERIVED* Wt::Singleton< DERIVED >::instance

(

)

[inline, static, inherited]

instantiates the pointer compatible child of DERIVED aka grandchild

it is handy in driver like situations

Definition at line 43 of file singleton.h.

                               {
        return (instance_) ? instance_ : GRANDCHILD::load();
    }

template<class DERIVED>

static DERIVED* Wt::Singleton< DERIVED >::instance

(

)

[inline, static, inherited]

Definition at line 32 of file singleton.h.

Referenced by Wt::Audio::Audio(), Wt::Sound::available(), Wt::SDLMixer::Chunk::channel(), Wt::NullAudio::Chunk::channel(), Wt::SDLSurface::defaultDepth(), Wt::SDLInput::EventInfo::EventInfo(), Wt::Dialog::exec(), Wt::Widget::grabKeyboard(), Wt::Widget::grabMouse(), Wt::Audio::handleAudioEvent(), handleKeyEvent(), Wt::Singleton< Wt::Audio >::init(), Wt::SDLTimer::init(), Wt::Sound::isAvailable(), Wt::Widget::keyboardGrabber(), Wt::Audio::load(), Wt::Widget::mouseGrabber(), Wt::SDLMixer::onChannelFinish(), Wt::Audio::onChannelFinish(), Wt::Sound::play(), Wt::Singleton< Wt::Audio >::quit(), Wt::Widget::releaseKeyboard(), Wt::Widget::releaseMouse(), SDLInput(), Wt::SDLMixer::setMusicVolume(), Wt::SDLMixer::Channel::setVolume(), and Wt::SDLMixer::Chunk::setVolume().

                               {
        return (instance_) ? instance_ : DERIVED::load();
    }

Widget * Wt::SDLInput::keyboardGrabber

(

)

const

Definition at line 148 of file sdlinput.cpp.

References keyboard_grabber.

                                        {
    return keyboard_grabber;
}

template<class DERIVED>

static DERIVED* Wt::Singleton< DERIVED >::load

(

)

[inline, static, protected, inherited]

try to load the instance

if it fails return NULL if it succeeds must return the newly created object

Reimplemented in Wt::Audio, Wt::NullAudio, and Wt::SDLMixer.

Definition at line 86 of file singleton.h.

                           {
        instance_ = new DERIVED;
        return  instance_;
    }

Widget * Wt::SDLInput::mouseGrabber

(

)

const

Definition at line 160 of file sdlinput.cpp.

References mouse_grabber.

                                     {
    return mouse_grabber;
}

template<class DERIVED>

static void Wt::Singleton< DERIVED >::quit

(

)

[inline, static, inherited]

Reimplemented in Wt::Application.

Definition at line 55 of file singleton.h.

Referenced by Wt::Application::~Application().

                       {
        delete instance();
    }

void Wt::SDLInput::releaseKeyboardGrab

(

)

Definition at line 156 of file sdlinput.cpp.

References setKeyboardGrabber().

                                   {
    setKeyboardGrabber(0);
}

Here is the call graph for this function:

void Wt::SDLInput::releaseMouseGrab

(

)

Definition at line 168 of file sdlinput.cpp.

References setMouseGrabber().

                                {
    setMouseGrabber(0);
}

Here is the call graph for this function:

void Wt::SDLInput::setKeyboardGrabber

(

Widget *

w

)

Definition at line 152 of file sdlinput.cpp.

References keyboard_grabber.

Referenced by releaseKeyboardGrab().

                                           {
    keyboard_grabber = w;
}

void Wt::SDLInput::setMouseGrabber

(

Widget *

w

)

Definition at line 164 of file sdlinput.cpp.

References mouse_grabber.

Referenced by releaseMouseGrab().

                                        {
    mouse_grabber = w;
}

---

Friends And Related Function Documentation

friend class Singleton< SDLInput > [friend]

Definition at line 38 of file sdlinput.h.

---

Member Data Documentation

const FlagMap Wt::SDLInput::buttonMap [static, private]

Initial value:

 boost::assign::map_list_of
                                    (SDL_BUTTON_LEFT, LeftButton)
                                    (SDL_BUTTON_MIDDLE, MidButton)
                                    (SDL_BUTTON_RIGHT, RightButton)

static members

Definition at line 85 of file sdlinput.h.

Referenced by Wt::SDLInput::EventInfo::EventInfo().

template<class DERIVED>

DERIVED * Wt::Singleton< DERIVED >::instance_ = 0 [static, protected, inherited]

Definition at line 91 of file singleton.h.

Referenced by Wt::Singleton< Wt::Audio >::existingInstance(), Wt::Singleton< Wt::Audio >::instance(), Wt::Singleton< Wt::Audio >::load(), Wt::SDLDisplay::load(), Wt::Audio::load(), Wt::Singleton< Wt::Audio >::Singleton(), and Wt::Singleton< Wt::Audio >::~Singleton().

Widget* Wt::SDLInput::keyboard_grabber [private]

Definition at line 59 of file sdlinput.h.

Referenced by keyboardGrabber(), and setKeyboardGrabber().

const FlagMap Wt::SDLInput::keyMap [static, private]

Initial value:

 boost::assign::map_list_of
                                 (KMOD_LSHIFT, ShiftButton)
                                 (KMOD_RSHIFT, ShiftButton)
                                 (KMOD_LCTRL, ControlButton)
                                 (KMOD_RCTRL, ControlButton)
                                 (KMOD_LALT, AltButton)
                                 (KMOD_RALT, AltButton)
                                 (KMOD_LMETA, MetaButton)
                                 (KMOD_RMETA, MetaButton)
                                 (KMOD_NUM, Keypad)
                                 (KMOD_CAPS, Keypad)
                                 (KMOD_MODE, Keypad)

Definition at line 87 of file sdlinput.h.

Referenced by Wt::SDLInput::EventInfo::EventInfo(), and handleKeyEvent().

Widget* Wt::SDLInput::mouse_grabber [private]

Definition at line 60 of file sdlinput.h.

Referenced by mouseGrabber(), and setMouseGrabber().

SDLInput::EventInfo Wt::SDLInput::previous_button_ [static, private]

Definition at line 82 of file sdlinput.h.

Referenced by handleMouseEvent().

SDLInput::EventInfo Wt::SDLInput::previous_position_ [static, private]

Definition at line 81 of file sdlinput.h.

Referenced by handleActiveEvent(), and handleMouseEvent().

const FlagMap Wt::SDLInput::wheelMap [static, private]

Initial value:

 boost::assign::map_list_of
                                   (SDL_BUTTON_WHEELUP, 120)
                                   (SDL_BUTTON_WHEELDOWN, -120)

Definition at line 86 of file sdlinput.h.

Referenced by Wt::SDLInput::EventInfo::EventInfo().

---

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

• sdlinput.h
• sdlinput.cpp

---

Generated Fri Jul 28 19:32:31 2006.
Copyright © 1998-2003 by the respective authors.

This document is licensed under the terms of the GNU Free Documentation License and may be freely distributed under the conditions given by this license.