CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Identifying Multiple Event Sources From A Single Callback

2007-04-09T18:39:16Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* pushButton =
static_cast<CEGUI::PushButton*>
(CEGUI::WindowManager::getSingleton().createWindow("WindowsLook/Button", "TheButton"));

pushButton->subscribeEvent(CEGUI::PushButton::EventClicked,
CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The CEGUI::WindowEventArgs object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we =
static_cast<const CEGUI::WindowEventArgs&>(e);

CEGUI::String senderID = we.window->getName();

if (senderID == "TheButton")
{
// code for dealing with a "TheButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T18:35:04Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* pushButton =
static_cast<CEGUI::PushButton*>(CEGUI::WindowManager::getSingleton().createWindow("WindowsLook/Button", "TheButton"));

pushButton->subscribeEvent(CEGUI::PushButton::EventClicked,
CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The CEGUI::WindowEventArgs object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
CEGUI::String senderID = we.window->getName();

if (senderID == "TheButton")
{
// code for dealing with a "TheButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T18:33:19Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* pushButton = static_cast<CEGUI::PushButton*>(CEGUI::WindowManager::getSingleton().createWindow("WindowsLook/Button", "TheButton"));

pushButton->subscribeEvent(CEGUI::PushButton::EventClicked,
CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The CEGUI::WindowEventArgs object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
CEGUI::String senderID = we.window->getName();

if (senderID == "TheButton")
{
// code for dealing with a "TheButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T17:35:07Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked,
CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The CEGUI::WindowEventArgs object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
CEGUI::String senderID = we.window->getName();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T17:28:02Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked,
CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs] object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
CEGUI::String senderID = we.window->getName();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T17:26:52Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example [http://www.cegui.org.uk/api_reference/classCEGUI_1_1PushButton.html CEGUI::PushButton] we would like to wire up:

<code><cpp/>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked, CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</code>

To do this, simply cast the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1EventArgs.html CEGUI::EventArgs] in your callback to a [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs]. The [http://www.cegui.org.uk/api_reference/classCEGUI_1_1WindowEventArgs.html CEGUI::WindowEventArgs] object contains a pointer to the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Window.html CEGUI::Window] that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<code><cpp/>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
CEGUI::String senderID = we.window->getName();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}

return true;
}
</code>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T17:01:58Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example CEGUI::PushButton we would like to wire up:

<pre>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked, CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</pre>

To do this, simply cast the CEGUI::EventArgs in your callback to a CEGUI::WindowEventArgs. The CEGUI::WindowEventArgs object contains a pointer to the window that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<pre>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
std::string senderID = we.window->getName().c_str();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}

return true;
}
</pre>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T16:58:18Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example CEGUI::PushButton we would like to wire up:

<pre>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked, CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</pre>

To do this, simply cast the CEGUI::EventArgs in your callback to a CEGUI::WindowEventArgs. The CEGUI::WindowEventArgs object contains a pointer to the window that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<pre>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
std::string senderID = we.window->getName().c_str();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}
}
</pre>

Identifying Multiple Event Sources From A Single Callback

2007-04-09T16:56:24Z

Ldb:

Sometimes you would like to identify the sender of an event from within your callback function. For example, you would like to execute some common code for your buttons, like triggering a sound to be played on CEGUI::PushButton::EventClicked. Here is an example CEGUI::PushButton we would like to wire up:

<pre>
CEGUI::PushButton* button;
button->subscribeEvent(CEGUI::PushButton::EventClicked, CEGUI::Event::Subscriber(&MainMenu::OnButtonClick, this));
</pre>

To do this, simply cast the CEGUI::EventArgs in your callback to a CEGUI::WindowEventArgs. The CEGUI::WindowEventArgs object contains a pointer to the window that sent the event. Now its as easy as calling CEGUI::Window::getName(). Obviously, you can do much more now that you have a pointer to the window who fired the event, but this is just an example:

<pre>
bool MainMenu::OnButtonClick(const CEGUI::EventArgs& e)
{
using namespace CEGUI;

const CEGUI::WindowEventArgs& we = (const CEGUI::WindowEventArgs&)e;
std::string senderID = we.window->getName().c_str();

if (senderID == "QuitButton")
{
// code for dealing with a "QuitButton"
}
}
</pre>

Tutorials

2007-04-09T16:33:05Z

Ldb: /* Miscellaneous HOW-TOs */

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.

=== Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModule to Sample_FirstWindow]] - Experience adding scripting to an existing sample.
* [http://www.gpwiki.org/index.php/Crazy_Eddies_GUI_System:Tutorials:Creating_a_scriptable_interface_using_CEGUI Creating a scriptable interface using CEGUI]

=== Window System Examples ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.
* [[Using CEGUI with Producer and OpenGL]] - Guidelines on how to render and inject input to CEGUI from the Producer API.
* [http://artis.imag.fr/Membres/Xavier.Decoret/resources/CEGUI/ Using CEGUI with Qt/QGLViewer]
* [[Using CEGUI with GLUT]] - Some tips on using OpenGL's GLUT with CEGUI.

=== Extending CEGUI ===

* [[Using Expat XML parser within CEGUI]] - How to add support for another XML parser.

=== Skins - Tutorial For Artists ===
* [[Creating Skins]] - Extra notes for artists on how to create skins.
* [[The Beginners Guide to Falagard skinning - Part I]] - Learn by doing a Button.
* [[The Beginners Guide to Falagard skinning - Part II]] - More Falagard fun, this time with the Editbox.

=== Overviews ===
* [[Overview of GUI files]] - A quick introduction to all the XML files used by CEGUI.
* [[Overview of resource system enhancements in 0.5.0]] - Introduction to enhancements made for the 0.5.0 release.

=== Miscellaneous HOW-TOs ===
* [[Create ImageButtons]] - A few different ways to create image buttons.
* [[Create a CheckListboxItem]] - Create a CheckListBoxItem that you can use with ItemListbox.
* [[Identifying Multiple Event Sources From A Single Callback]]