MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
window.h
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uiwindow_h
41 #define _uiwindow_h
42 
43 #include "UI/widget.h"
44 
45 namespace Mezzanine
46 {
47  namespace UI
48  {
49  /*
50  ///////////////////////////////////////////////////////////////////////////////
51  /// @class Window
52  /// @headerfile uiwindow.h
53  /// @brief This is a container widget capable of holding any other widget.
54  /// @details
55  ///////////////////////////////////////
56  class MEZZ_LIB Window : public Widget
57  {
58  protected:
59  friend class ExtendedRenderableFactory;
60  /// @internal
61  /// @enum ResizeMode
62  /// @brief Internal enum for handling a resizing via mouse.
63  enum ResizeMode
64  {
65  RM_None,
66  RM_TopLeft,
67  RM_TopRight,
68  RM_BottomLeft,
69  RM_BottomRight,
70  RM_Left,
71  RM_Right,
72  RM_Top,
73  RM_Bottom,
74  };
75  Rectangle* WindowBack;
76  // ©aption* WindowTitle;
77  Whole BorderWidth;
78  ResizeMode CurrentRM;
79  /// @brief Checks to see if a point is within the border of this window.
80  void BorderAreaCheck(const Vector2& ScreenLoc);
81  /// @brief Child specific update method.
82  virtual void UpdateImpl(bool Force = false);
83  /// @brief Child specific visibility method.
84  virtual void SetVisibleImpl(bool visible);
85  /// @brief Child specific mouse hover method.
86  virtual bool CheckMouseHoverImpl();
87  //public:
88  /// @brief Standard initialization constructor.
89  /// @param name The name of the window.
90  /// @param RendRect The Rect representing the position and size of the window.
91  /// @param PScreen The parent screen this window belongs to.
92  Window(ConstString& name, const Rect& RendRect, Screen* PScreen);
93  /// @brief Standard destructor.
94  virtual ~Window();
95  public:
96  /// @brief Sets the relative position of this window.
97  /// @details The position is relative to the screen size. Values range from 0.0 to 1.0.
98  /// @param Position A vector2 representing the relative position of this window.
99  virtual void SetPosition(const Vector2& Position);
100  /// @brief Sets the pixel position of this window.
101  /// @param Position A vector2 representing the pixel position of this window.
102  virtual void SetActualPosition(const Vector2& Position);
103  /// @brief Sets the relative size of this window.
104  /// @details The size is relative to the screen size. Values range from 0.0 to 1.0.
105  /// @param Size A vector2 representing the relative size of this window.
106  virtual void SetSize(const Vector2& Size);
107  /// @brief Sets the pixel size of this window.
108  /// @param Size A vector2 representing the pixel size of this window.
109  virtual void SetActualSize(const Vector2& Size);
110  /// @brief Updates the dimensions of this widget to match those of the new screen size.
111  /// @details This function is called automatically when a viewport changes in size, and shouldn't need to be called manually.
112  virtual void UpdateDimensions();
113  /// @brief Gets the background object of this window.
114  /// @return Returns a pointer to the rectangle that is the background for this window.
115  virtual Rectangle* GetWindowBack();
116  };//Window//*/
117  }//UI
118 }//Mezzanine
119 
120 #endif