Introduction

In this tutorial we will create a Button Widget and assign an event handler to it. Tutorial 1 is a prerequisite for this tutorial, unless you know how to setup QuickGUI and inject input correctly.

Step 1 : Creating the Button

The GUIManager creates a default Sheet for use, which can be retrieved by calling

QuickGUI::Sheet* defaultSheet = mGUIManager->getActiveSheet();

Using the Sheet we can create the majority of Widgets supported in QuickGUI. Widgets are created using Desc objects, similar to the way the GUIManager was created. To create a Button, we will need a ButtonDesc object. Desc objects can be created via the DescManager.

QuickGUI::DescManager::getSingleton();

By default, the DescManager has a Desc for each Widget, used for general purposes, and also internally. Additionally, the DescManager supports creation and destruction of Descs, and gives Access to these descs.

QuickGUI::ButtonDesc* bd = QuickGUI::DescManager::getSingleton().getDefaultButtonDesc();

Using the desc object has many benefits. You can set button properties before creating the button, and also re-use the desc to create other buttons. All properties of the desc object have corresponding API calls, meaning the Button's properties can be changed after creation. Also note that all desc objects have a "resetToDefaults" function. At any time you can enforce all desc properties to be reverted to their default values. Lets give a few properties and create the button:

bd->widget_name = "MyButton";
  bd->widget_dimensions.size = QuickGUI::Size(100,25);
  bd->widget_dimensions.position = QuickGUI::Point(50,50);
  QuickGUI::Button* myButton = defaultSheet->createButton(bd);

Compile and run, and a button should be 50 pixels from the right and 50 pixels from the top! By default the skinType is set to "default", which is provided with QuickGUI. Feel free to change this if you have another skin you would like to use. Its also important to note the "resetToDefault" function, as it will reset a Descs properties to a default state.

Step 2 : Adding Text to a Button

There are two ways to add Text to a button: before creation, and after creation.

Adding Text to a button before its created must be done through the desc object. The ButtonDesc object comes with a TextDesc object, which is used to describe the text of the button. Text is made up of TextSegments, which are strings of text that are the same color and font. You can append several segments together to create a variety of effects. Here is a basic sample:

bd->textDesc.segments.push_back(QuickGUI::TextSegment("micross.12",QuickGUI::ColourValue::Red,"Click Me!"));

What the above line of code does is add a segment of text with string "Click Me!", using the font "micross.12", in red color. The micross.12 font must exist in an *.fontdef file, recognized by Ogre.

If you are re-using the desc object to create multiple objects, you may want to clear the text segments before adding text:

bd->textDesc.segments.clear();

Changing the Text of a Button after it is created is done through the Button's API. (setText(...))

Step 3 : Skinning the button

The skin is another property that can be set before or after creation of a Widget.

The desc property 'widget_skinTypeName' stores the name of the Skin of the widget, which references a Skin Type, which are defined in .skinTypes files.

By default a widget's skin is set to 'default', which is provided in qgui.core.zip. For example if we wanted to change our button's skin to look like a Vertical ScrollBar's down arrow, we could set the property prior to creation:

bd->widget_skinTypeName = "default.vscrolldown";

or if we wanted to change the skin after creation:

myButton->setSkinType("default.vscrolldown");

Step 4 : Register an Event Handler



In QuickGUI, Widgets of the GUI will fire events when certain actions are performed. In order to get notified when an event happens, an Event Handler needs to be registered. All event handlers follow this signature:

void myClass::myFunction(const EventArgs& args) { ... }

The following is an example of registering an Event Handler when the mouse buttons goes up while over a button:

myButton->addWidgetEventHandler(QuickGUI::WIDGET_EVENT_MOUSE_BUTTON_UP,&myClass::myFunction,this);

"this" refers to the object instance that will call the function. In the case above, the myClass instance is registering the event handler inside one of its functions. Whenever the Mouse button goes up over myButton, myFunction will be called.

Note that myClass must be polymorphic, or you may receive a compiler error like:

QuickGUIEventHandlerPointer.h:55: error: cannot dynamic_cast
 '((QuickGUI::EventHandlerPointer<myClass>*)this)->QuickGUI::EventHandlerPointer<myClass>::d_object' 
  (of type 'class myClass*') to type 'void*' (source type is not polymorphic)

The class can be made polymorphic by making the constructor virtual:

virtual ~myClass();

Step 5 : EventArgs



EventArgs are the most general form of Args in QuickGUI. Many Args are derived from this base class, such as WidgetEventArgs and MouseEventArgs. There is a type member that stores what type the Event really is, but in most cases you will know. For example, clicking on a button generally involves a mouse, so you can be comfortable in casting the EventArgs to MouseEventArgs and using data from it.

In the following example, we convert the EventArgs into MouseEventArgs, and check to see if the Left Mouse Button went up:

void MainForm::test1(const QuickGUI::EventArgs& args)
  {
      const QuickGUI::MouseEventArgs& mea = dynamic_cast<const QuickGUI::MouseEventArgs&>(args);
  
      if(mea.button == QuickGUI::MB_Left)
      {
          ; // do something
      }
  }

Using this approach, we can also get the Widget involved in the event. In this case MouseEventArgs is derived from WidgetEventArgs, so we can access the widget like this:

mea.widget

An alternative would be to cast the EventArgs into WidgetEventArgs and get access to the widget that way.

There are a lot of Events for the Widget class, and many widget have unique Events. For widgets with unique Events, for example a List, you will use the following function to register handlers:

List::addListEventHandler(...)

Step 6 : Convenient creation of Widgets



In previous versions of QuickGUI, all Widgets required the user to supply a Desc in order for them to be created. Since v9.03, I have created several overloaded functions, allowing Widgets to be created without needing a Desc. In the example above, a ButtonDesc was needed to create the Button. In the latest code base, its also possible to create a button using the following code:

defaultSheet->createButton();
  defaultSheet->createButton(QuickGUI::Point(50,50));
  defaultSheet->createButton("Click Me!",QuickGUI::Rect(50,50,100,25));
  ...

This also applies to the majority of other widgets in QuickGUI.


Alias: QuickGUI_Beginner_Tutorial_2

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.