TGUI  v0.5.2
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Form.hpp
1 //
3 // TGUI - Texus's Graphical User Interface
4 // Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 
26 #ifndef _TGUI_FORM_INCLUDED_
27 #define _TGUI_FORM_INCLUDED_
28 
30 
31 namespace tgui
32 {
34 
35  struct TGUI_API Form : public Group, sf::NonCopyable
36  {
41  Form(sf::RenderWindow& window);
42 
43 
48  virtual ~Form();
49 
50 
59  virtual void handleEvent(sf::Event event);
60 
61 
66  virtual void draw();
67 
68 
87  virtual bool getCallback(Callback& callback);
88 
89 
91  // This function is used internally to handle object callbacks.
92  // When you allow an object to pass callbacks then this function is called to tell the window about the callback.
93  // You can use this function to fake an object callback.
95  virtual void addCallback(const Callback& callback);
96 
97 
99  protected:
100 
101  // The pointer to the render window
102  sf::RenderWindow* m_Window;
103 
104  // This will store all object callbacks until you pop them with getCallback
105  std::queue<Callback> m_Callback;
106 
107  // The internal clock which is used for animation of objects
108  sf::Clock m_Clock;
109 
111  };
112 
114 
115 }
116 
118 
119 #endif //_TGUI_FORM_INCLUDED_
When you receive an action callback from an object then this struct will be passed as parameter...
Definition: Objects.hpp:362
Parent struct for objects that store multiple objects.
Definition: Group.hpp:38
Definition: Form.hpp:35