Crazy Eddies GUI System  0.7.8
CEGUIWindow.h
1 /***********************************************************************
2  filename: CEGUIWindow.h
3  created: 21/2/2004
4  author: Paul D Turner
5 
6  purpose: Defines abstract base class for Window objects
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIWindow_h_
31 #define _CEGUIWindow_h_
32 
33 #include "CEGUIBase.h"
34 #include "CEGUIString.h"
35 #include "CEGUIVector.h"
36 #include "CEGUIRect.h"
37 #include "CEGUISize.h"
38 #include "CEGUIEventSet.h"
39 #include "CEGUIPropertySet.h"
40 #include "CEGUISystem.h"
41 #include "CEGUIInputEvent.h"
42 #include "CEGUIWindowProperties.h"
43 #include "CEGUIUDim.h"
44 #include "CEGUIWindowRenderer.h"
45 #include "CEGUITextUtils.h"
46 #include "CEGUIBasicRenderedStringParser.h"
47 #include "CEGUIDefaultRenderedStringParser.h"
48 #include <vector>
49 #include <set>
50 
51 
52 #if defined(_MSC_VER)
53 # pragma warning(push)
54 # pragma warning(disable : 4251)
55 #endif
56 
57 
58 // Start of CEGUI namespace section
59 namespace CEGUI
60 {
65 enum VerticalAlignment
66 {
71  VA_TOP,
76  VA_CENTRE,
81  VA_BOTTOM
82 };
83 
88 enum HorizontalAlignment
89 {
94  HA_LEFT,
99  HA_CENTRE,
104  HA_RIGHT
105 };
106 
115 enum WindowUpdateMode
116 {
118  WUM_ALWAYS,
120  WUM_NEVER,
122  WUM_VISIBLE
123 };
124 
138 class CEGUIEXPORT Window : public PropertySet, public EventSet
139 {
140 public:
141  /*************************************************************************
142  Event name constants
143  *************************************************************************/
145  static const String EventNamespace;
146 
147  // generated internally by Window
151  static const String EventWindowUpdated;
157  static const String EventParentSized;
162  static const String EventSized;
167  static const String EventMoved;
172  static const String EventTextChanged;
177  static const String EventFontChanged;
182  static const String EventAlphaChanged;
187  static const String EventIDChanged;
194  static const String EventActivated;
201  static const String EventDeactivated;
206  static const String EventShown;
211  static const String EventHidden;
216  static const String EventEnabled;
222  static const String EventDisabled;
228  static const String EventClippedByParentChanged;
234  static const String EventDestroyedByParentChanged;
240  static const String EventInheritsAlphaChanged;
246  static const String EventAlwaysOnTopChanged;
251  static const String EventInputCaptureGained;
260  static const String EventInputCaptureLost;
268  static const String EventRenderingStarted;
276  static const String EventRenderingEnded;
281  static const String EventChildAdded;
286  static const String EventChildRemoved;
291  static const String EventDestructionStarted;
297  static const String EventZOrderChanged;
305  static const String EventDragDropItemEnters;
313  static const String EventDragDropItemLeaves;
320  static const String EventDragDropItemDropped;
326  static const String EventVerticalAlignmentChanged;
332  static const String EventHorizontalAlignmentChanged;
338  static const String EventWindowRendererAttached;
344  static const String EventWindowRendererDetached;
349  static const String EventRotated;
355  static const String EventNonClientChanged;
362  static const String EventTextParsingChanged;
368  static const String EventMarginChanged;
369 
370  // generated externally (inputs)
375  static const String EventMouseEntersArea;
380  static const String EventMouseLeavesArea;
391  static const String EventMouseEnters;
402  static const String EventMouseLeaves;
407  static const String EventMouseMove;
413  static const String EventMouseWheel;
418  static const String EventMouseButtonDown;
423  static const String EventMouseButtonUp;
430  static const String EventMouseClick;
436  static const String EventMouseDoubleClick;
442  static const String EventMouseTripleClick;
451  static const String EventKeyDown;
460  static const String EventKeyUp;
468  static const String EventCharacterKey;
469 
470  /*************************************************************************
471  Child Widget name suffix constants
472  *************************************************************************/
474  static const String TooltipNameSuffix;
476  static const String AutoWidgetNameSuffix;
477 
478 
489  Window(const String& type, const String& name);
490 
495  virtual ~Window(void);
496 
504  const String& getType(void) const;
505 
513  const String& getName(void) const {return d_name;}
514 
524  bool isDestroyedByParent(void) const {return d_destroyedByParent;}
525 
535  bool isAlwaysOnTop(void) const {return d_alwaysOnTop;}
536 
549  bool isDisabled(bool localOnly = false) const;
550 
567  bool isVisible(bool localOnly = false) const;
568 
583  bool isActive(void) const;
584 
594  bool isClippedByParent(void) const {return d_clippedByParent;}
595 
603  uint getID(void) const {return d_ID;}
604 
614  size_t getChildCount(void) const {return d_children.size();}
615 
628  bool isChild(const String& name) const;
629 
646  bool isChild(uint ID) const;
647 
668  bool isChildRecursive(uint ID) const;
669 
681  bool isChild(const Window* window) const;
682 
704  Window* getChild(const String& name) const;
705 
727  Window* getChild(uint ID) const;
728 
752  Window* getChildRecursive(const String& name) const;
753 
775  Window* getChildRecursive(uint ID) const;
776 
790  Window* getChildAtIdx(size_t idx) const {return d_children[idx];}
791 
804  Window* getActiveChild(void);
805  const Window* getActiveChild(void) const;
806 
820  bool isAncestor(const String& name) const;
821 
835  bool isAncestor(uint ID) const;
836 
849  bool isAncestor(const Window* window) const;
850 
864  Font* getFont(bool useDefault = true) const;
865 
873  const String& getText(void) const {return d_textLogical;}
874 
876  const String& getTextVisual() const;
877 
886  bool inheritsAlpha(void) const {return d_inheritsAlpha;}
887 
905  float getAlpha(void) const {return d_alpha;}
906 
916  float getEffectiveAlpha(void) const;
917 
923  Rect getUnclippedOuterRect() const;
924 
930  Rect getUnclippedInnerRect() const;
931 
943  Rect getUnclippedRect(const bool inner) const;
944 
957  Rect getOuterRectClipper() const;
958 
971  Rect getInnerRectClipper() const;
972 
991  Rect getClipRect(const bool non_client = false) const;
992 
1003  Rect getHitTestRect() const;
1004 
1024  Rect getChildWindowContentArea(const bool non_client = false) const;
1025 
1042  virtual Rect getUnclippedInnerRect_impl(void) const;
1043 
1052  static Window* getCaptureWindow(void) {return d_captureWindow;}
1053 
1062  bool isCapturedByThis(void) const {return getCaptureWindow() == this;}
1063 
1073  bool isCapturedByAncestor(void) const
1074  {return isAncestor(getCaptureWindow());}
1075 
1084  bool isCapturedByChild(void) const {return isChild(getCaptureWindow());}
1085 
1102  virtual bool isHit(const Vector2& position,
1103  const bool allow_disabled = false) const;
1104 
1117  Window* getChildAtPosition(const Vector2& position) const;
1118 
1136  Window* getTargetChildAtPosition(const Vector2& position,
1137  const bool allow_disabled = false) const;
1138 
1147  Window* getParent(void) const {return d_parent;}
1148 
1163  const Image* getMouseCursor(bool useDefault = true) const;
1164 
1172  Size getPixelSize(void) const { return d_pixelSize; }
1173 
1185  void* getUserData(void) const {return d_userData;}
1186 
1201  bool restoresOldCapture(void) const {return d_restoreOldCapture;}
1202 
1222  bool isZOrderingEnabled(void) const;
1223 
1234  bool wantsMultiClickEvents(void) const;
1235 
1247  bool isMouseAutoRepeatEnabled(void) const;
1248 
1257  float getAutoRepeatDelay(void) const;
1258 
1268  float getAutoRepeatRate(void) const;
1269 
1279  bool distributesCapturedInputs(void) const;
1280 
1290  bool isUsingDefaultTooltip(void) const;
1291 
1301  Tooltip* getTooltip(void) const;
1302 
1311  String getTooltipType(void) const;
1312 
1320  const String& getTooltipText(void) const;
1321 
1333  bool inheritsTooltipText(void) const;
1334 
1355  bool isRiseOnClickEnabled(void) const { return d_riseOnClick; }
1356 
1368  bool testClassName(const String& class_name) const
1369  {return testClassName_impl(class_name);}
1370 
1381  VerticalAlignment getVerticalAlignment() const {return d_vertAlign;}
1382 
1393  HorizontalAlignment getHorizontalAlignment() const {return d_horzAlign;}
1394 
1402  GeometryBuffer& getGeometryBuffer();
1403 
1412  const String& getLookNFeel() const;
1413 
1421  bool getModalState(void) const
1422  {return(System::getSingleton().getModalTarget() == this);}
1423 
1437  const String& getUserString(const String& name) const;
1438 
1450  bool isUserStringDefined(const String& name) const;
1451 
1467  Window* getActiveSibling();
1468 
1478  Size getParentPixelSize(void) const;
1479 
1489  float getParentPixelWidth(void) const;
1490 
1500  float getParentPixelHeight(void) const;
1501 
1512  bool isMousePassThroughEnabled(void) const {return d_mousePassThroughEnabled;}
1513 
1519  bool isAutoWindow(void) const {return d_autoWindow;}
1520 
1525  bool isWritingXMLAllowed(void) const {return d_allowWriteXML;}
1526 
1551  EventSet::Iterator getEventIterator() const;
1552 
1573  PropertySet::Iterator getPropertyIterator() const;
1574 
1584  bool isDragDropTarget() const;
1585 
1591  void getRenderingContext(RenderingContext& ctx) const;
1592 
1594  virtual void getRenderingContext_impl(RenderingContext& ctx) const;
1595 
1601  RenderingSurface* getRenderingSurface() const;
1602 
1608  RenderingSurface& getTargetRenderingSurface() const;
1609 
1621  bool isUsingAutoRenderingSurface() const;
1622 
1633  const Window* getRootWindow() const;
1634  Window* getRootWindow();
1635 
1637  const Vector3& getRotation() const;
1638 
1653  bool isNonClientWindow() const;
1654 
1665  void rename(const String& new_name);
1666 
1678  virtual void initialiseComponents(void) {}
1679 
1693  void setDestroyedByParent(bool setting);
1694 
1707  void setAlwaysOnTop(bool setting);
1708 
1721  void setEnabled(bool setting);
1722 
1730  void enable(void) {setEnabled(true);}
1731 
1739  void disable(void) {setEnabled(false);}
1740 
1758  void setVisible(bool setting);
1759 
1772  void show(void) {setVisible(true);}
1773 
1784  void hide(void) {setVisible(false);}
1785 
1794  void activate(void);
1795 
1805  void deactivate(void);
1806 
1819  void setClippedByParent(bool setting);
1820 
1832  void setID(uint ID);
1833 
1844  void setText(const String& text);
1845 
1859  void insertText(const String& text, const String::size_type position);
1860 
1870  void appendText(const String& text);
1871 
1883  void setFont(Font* font);
1884 
1899  void setFont(const String& name);
1900 
1919  void addChildWindow(const String& name);
1920 
1937  void addChildWindow(Window* window);
1938 
1950  void removeChildWindow(const String& name);
1951 
1963  void removeChildWindow(Window* window);
1964 
1978  void removeChildWindow(uint ID);
1979 
1993  void moveToFront();
1994 
2009  void moveToBack();
2010 
2024  void moveInFront(const Window* const window);
2025 
2040  void moveBehind(const Window* const window);
2041 
2051  bool captureInput(void);
2052 
2061  void releaseInput(void);
2062 
2081  void setRestoreCapture(bool setting);
2082 
2103  void setAlpha(float alpha);
2104 
2116  void setInheritsAlpha(bool setting);
2117 
2129  void invalidate(void);
2130 
2146  void invalidate(const bool recursive);
2147 
2159  void setMouseCursor(const Image* image);
2160 
2171  void setMouseCursor(MouseCursorImage image);
2172 
2192  void setMouseCursor(const String& imageset, const String& image_name);
2193 
2208  void setUserData(void* user_data) {d_userData = user_data;}
2209 
2232  void setZOrderingEnabled(bool setting);
2233 
2247  void setWantsMultiClickEvents(bool setting);
2248 
2261  void setMouseAutoRepeatEnabled(bool setting);
2262 
2274  void setAutoRepeatDelay(float delay);
2275 
2288  void setAutoRepeatRate(float rate);
2289 
2299  void setDistributesCapturedInputs(bool setting);
2300 
2306  void notifyDragDropItemEnters(DragContainer* item);
2307 
2313  void notifyDragDropItemLeaves(DragContainer* item);
2314 
2320  void notifyDragDropItemDropped(DragContainer* item);
2321 
2335  virtual void destroy(void);
2336 
2352  void setTooltip(Tooltip* tooltip);
2353 
2372  void setTooltipType(const String& tooltipType);
2373 
2385  void setTooltipText(const String& tip);
2386 
2401  void setInheritsTooltipText(bool setting);
2402 
2426  void setRiseOnClickEnabled(bool setting) { d_riseOnClick = setting; }
2427 
2441  void setVerticalAlignment(const VerticalAlignment alignment);
2442 
2456  void setHorizontalAlignment(const HorizontalAlignment alignment);
2457 
2474  virtual void setLookNFeel(const String& look);
2475 
2489  void setModalState(bool state);
2490 
2501  virtual void performChildWindowLayout();
2502 
2516  void setUserString(const String& name, const String& value);
2517 
2544  void setArea(const UDim& xpos, const UDim& ypos, const UDim& width, const UDim& height);
2545 
2567  void setArea(const UVector2& pos, const UVector2& size);
2568 
2586  void setArea(const URect& area);
2587 
2606  void setPosition(const UVector2& pos);
2607 
2625  void setXPosition(const UDim& x);
2626 
2644  void setYPosition(const UDim& y);
2645 
2660  void setSize(const UVector2& size);
2661 
2676  void setWidth(const UDim& width);
2677 
2692  void setHeight(const UDim& height);
2693 
2710  void setMaxSize(const UVector2& size);
2711 
2728  void setMinSize(const UVector2& size);
2729 
2747  const URect& getArea() const;
2748 
2766  const UVector2& getPosition() const;
2767 
2785  const UDim& getXPosition() const;
2786 
2804  const UDim& getYPosition() const;
2805 
2820  UVector2 getSize() const;
2821 
2836  UDim getWidth() const;
2837 
2852  UDim getHeight() const;
2853 
2870  const UVector2& getMaxSize() const;
2871 
2888  const UVector2& getMinSize() const;
2889 
2898  void render();
2899 
2918  virtual void update(float elapsed);
2919 
2930  virtual void writeXMLToStream(XMLSerializer& xml_stream) const;
2931 
2940  virtual void beginInitialisation(void) {d_initialising = true;}
2941 
2949  virtual void endInitialisation(void) {d_initialising = false;}
2950 
2961  void setMousePassThroughEnabled(bool setting) {d_mousePassThroughEnabled = setting;}
2962 
2974  void setWindowRenderer(const String& name);
2975 
2984  WindowRenderer* getWindowRenderer(void) const;
2985 
2995  String getWindowRendererName(void) const;
2996 
3001  void setWritingXMLAllowed(bool allow) {d_allowWriteXML = allow;}
3002 
3013  void notifyScreenAreaChanged(bool recursive = true);
3014 
3026  void setFalagardType(const String& type, const String& rendererType = "");
3027 
3037  void setDragDropTarget(bool setting);
3038 
3059  void setRenderingSurface(RenderingSurface* surface);
3060 
3067  void invalidateRenderingSurface();
3068 
3110  void setUsingAutoRenderingSurface(bool setting);
3111 
3113  void setRotation(const Vector3& rotation);
3114 
3129  void setNonClientWindow(const bool setting);
3130 
3132  const RenderedString& getRenderedString() const;
3134  RenderedStringParser* getCustomRenderedStringParser() const;
3136  void setCustomRenderedStringParser(RenderedStringParser* parser);
3138  virtual RenderedStringParser& getRenderedStringParser() const;
3140  bool isTextParsingEnabled() const;
3142  void setTextParsingEnabled(const bool setting);
3143 
3145  virtual void setMargin(const UBox& margin);
3147  const UBox& getMargin() const;
3148 
3150  Vector2 getUnprojectedPosition(const Vector2& pos) const;
3151 
3153  const BiDiVisualMapping* getBiDiVisualMapping() const
3154  {return d_bidiVisualMapping;}
3155 
3157  void banPropertyFromXML(const String& property_name);
3158 
3160  void unbanPropertyFromXML(const String& property_name);
3161 
3163  bool isPropertyBannedFromXML(const String& property_name) const;
3164 
3166  void banPropertyFromXML(const Property* property);
3167 
3169  void unbanPropertyFromXML(const Property* property);
3170 
3172  bool isPropertyBannedFromXML(const Property* property) const;
3173 
3191  void setUpdateMode(const WindowUpdateMode mode);
3192 
3210  WindowUpdateMode getUpdateMode() const;
3211 
3222  void setMouseInputPropagationEnabled(const bool enabled);
3223 
3234  bool isMouseInputPropagationEnabled() const;
3235 
3250  Window* clone(const String& newName, const bool deepCopy = true) const;
3251 
3253  virtual void clonePropertiesTo(Window& target) const;
3255  virtual void cloneChildWidgetsTo(Window& target) const;
3256 
3269  size_t getZIndex() const;
3270 
3280  bool isInFront(const Window& wnd) const;
3281 
3291  bool isBehind(const Window& wnd) const;
3292 
3293 protected:
3294  // friend classes for construction / initialisation purposes (for now)
3295  friend class System;
3296  friend class WindowManager;
3297 
3298  /*************************************************************************
3299  Event trigger methods
3300  *************************************************************************/
3310  virtual void onSized(WindowEventArgs& e);
3311 
3321  virtual void onMoved(WindowEventArgs& e);
3322 
3332  virtual void onTextChanged(WindowEventArgs& e);
3333 
3343  virtual void onFontChanged(WindowEventArgs& e);
3344 
3354  virtual void onAlphaChanged(WindowEventArgs& e);
3355 
3365  virtual void onIDChanged(WindowEventArgs& e);
3366 
3376  virtual void onShown(WindowEventArgs& e);
3377 
3387  virtual void onHidden(WindowEventArgs& e);
3388 
3398  virtual void onEnabled(WindowEventArgs& e);
3399 
3409  virtual void onDisabled(WindowEventArgs& e);
3410 
3421  virtual void onClippingChanged(WindowEventArgs& e);
3422 
3433  virtual void onParentDestroyChanged(WindowEventArgs& e);
3434 
3445  virtual void onInheritsAlphaChanged(WindowEventArgs& e);
3446 
3456  virtual void onAlwaysOnTopChanged(WindowEventArgs& e);
3457 
3467  virtual void onCaptureGained(WindowEventArgs& e);
3468 
3478  virtual void onCaptureLost(WindowEventArgs& e);
3479 
3489  virtual void onRenderingStarted(WindowEventArgs& e);
3490 
3500  virtual void onRenderingEnded(WindowEventArgs& e);
3501 
3511  virtual void onZChanged(WindowEventArgs& e);
3512 
3522  virtual void onDestructionStarted(WindowEventArgs& e);
3523 
3532  virtual void onActivated(ActivationEventArgs& e);
3533 
3543  virtual void onDeactivated(ActivationEventArgs& e);
3544 
3556  virtual void onParentSized(WindowEventArgs& e);
3557 
3566  virtual void onChildAdded(WindowEventArgs& e);
3567 
3576  virtual void onChildRemoved(WindowEventArgs& e);
3577 
3585  virtual void onMouseEntersArea(MouseEventArgs& e);
3586 
3594  virtual void onMouseLeavesArea(MouseEventArgs& e);
3595 
3610  virtual void onMouseEnters(MouseEventArgs& e);
3611 
3626  virtual void onMouseLeaves(MouseEventArgs& e);
3627 
3636  virtual void onMouseMove(MouseEventArgs& e);
3637 
3646  virtual void onMouseWheel(MouseEventArgs& e);
3647 
3656  virtual void onMouseButtonDown(MouseEventArgs& e);
3657 
3666  virtual void onMouseButtonUp(MouseEventArgs& e);
3667 
3676  virtual void onMouseClicked(MouseEventArgs& e);
3677 
3686  virtual void onMouseDoubleClicked(MouseEventArgs& e);
3687 
3696  virtual void onMouseTripleClicked(MouseEventArgs& e);
3697 
3709  virtual void onKeyDown(KeyEventArgs& e);
3710 
3722  virtual void onKeyUp(KeyEventArgs& e);
3723 
3735  virtual void onCharacter(KeyEventArgs& e);
3736 
3747  virtual void onDragDropItemEnters(DragDropEventArgs& e);
3748 
3759  virtual void onDragDropItemLeaves(DragDropEventArgs& e);
3760 
3771  virtual void onDragDropItemDropped(DragDropEventArgs& e);
3772 
3783  virtual void onVerticalAlignmentChanged(WindowEventArgs& e);
3784 
3795  virtual void onHorizontalAlignmentChanged(WindowEventArgs& e);
3796 
3806  virtual void onWindowRendererAttached(WindowEventArgs& e);
3807 
3817  virtual void onWindowRendererDetached(WindowEventArgs& e);
3818 
3828  virtual void onRotated(WindowEventArgs& e);
3829 
3840  virtual void onNonClientChanged(WindowEventArgs& e);
3841 
3852  virtual void onTextParsingChanged(WindowEventArgs& e);
3853 
3854  virtual void onMarginChanged(WindowEventArgs& e);
3855 
3856  /*************************************************************************
3857  Implementation Functions
3858  *************************************************************************/
3870  virtual void updateSelf(float elapsed);
3871 
3883  virtual void drawSelf(const RenderingContext& ctx);
3884 
3895  void bufferGeometry(const RenderingContext& ctx);
3896 
3907  void queueGeometry(const RenderingContext& ctx);
3908 
3915  virtual void populateGeometryBuffer() {}
3916 
3928  virtual bool testClassName_impl(const String& class_name) const
3929  {
3930  if (class_name == "Window") return true;
3931  return false;
3932  }
3933 
3945  void setParent(Window* parent);
3946 
3947  Size getSize_impl(const Window* window) const;
3948 
3953  void generateAutoRepeatEvent(MouseButton button);
3954 
3963  virtual bool validateWindowRenderer(const String& name) const;
3964 
3971  bool isPropertyAtDefault(const Property* property) const;
3972 
3978  void notifyClippingChanged(void);
3979 
3981  void allocateRenderingWindow();
3982 
3984  void releaseRenderingWindow();
3985 
3987  void initialiseClippers(const RenderingContext& ctx);
3988 
3993  virtual void cleanupChildren(void);
3994 
3999  virtual void addChild_impl(Window* wnd);
4000 
4005  virtual void removeChild_impl(Window* wnd);
4006 
4011  virtual void onZChange_impl(void);
4012 
4017  void addStandardProperties(void);
4018 
4027  virtual bool moveToFront_impl(bool wasClicked);
4028 
4059  void setArea_impl(const UVector2& pos, const UVector2& size,
4060  bool topLeftSizing = false, bool fireEvents = true);
4061 
4081  void addWindowToDrawList(Window& wnd, bool at_back = false);
4082 
4094  void removeWindowFromDrawList(const Window& wnd);
4095 
4107  bool isTopOfZOrder() const;
4108 
4114  void updateGeometryRenderSettings();
4115 
4117  void transferChildSurfaces();
4118 
4120  Rect getParentElementClipIntersection(const Rect& unclipped_area) const;
4121 
4123  void invalidate_impl(const bool recursive);
4124 
4126  bool isInnerRectSizeChanged() const;
4127 
4134  const Window* getWindowAttachedToCommonAncestor(const Window& wnd) const;
4135 
4137  virtual Rect getUnclippedOuterRect_impl() const;
4139  virtual Rect getOuterRectClipper_impl() const;
4141  virtual Rect getInnerRectClipper_impl() const;
4143  virtual Rect getHitTestRect_impl() const;
4145  virtual Rect getNonClientChildWindowContentArea_impl() const;
4147  virtual Rect getClientChildWindowContentArea_impl() const;
4148 
4149  virtual int writePropertiesXML(XMLSerializer& xml_stream) const;
4150  virtual int writeChildWindowsXML(XMLSerializer& xml_stream) const;
4151  virtual bool writeAutoChildWindowXML(XMLSerializer& xml_stream) const;
4152 
4153  // constrain given UVector2 to window's min size, return if size changed.
4154  bool constrainUVector2ToMinSize(const Size& base_sz, UVector2& sz);
4155  // constrain given UVector2 to window's max size, return if size changed.
4156  bool constrainUVector2ToMaxSize(const Size& base_sz, UVector2& sz);
4157 
4158  void markAllCachedRectsInvalid();
4160  void calculatePixelSize();
4162  void fireAreaChangeEvents(const bool moved, const bool sized);
4163 
4164  /*************************************************************************
4165  Properties for Window base class
4166  *************************************************************************/
4167  static WindowProperties::Alpha d_alphaProperty;
4168  static WindowProperties::AlwaysOnTop d_alwaysOnTopProperty;
4169  static WindowProperties::ClippedByParent d_clippedByParentProperty;
4170  static WindowProperties::DestroyedByParent d_destroyedByParentProperty;
4171  static WindowProperties::Disabled d_disabledProperty;
4172  static WindowProperties::Font d_fontProperty;
4173  static WindowProperties::ID d_IDProperty;
4174  static WindowProperties::InheritsAlpha d_inheritsAlphaProperty;
4175  static WindowProperties::MouseCursorImage d_mouseCursorProperty;
4176  static WindowProperties::RestoreOldCapture d_restoreOldCaptureProperty;
4177  static WindowProperties::Text d_textProperty;
4178  static WindowProperties::Visible d_visibleProperty;
4179  static WindowProperties::ZOrderChangeEnabled d_zOrderChangeProperty;
4180  static WindowProperties::WantsMultiClickEvents d_wantsMultiClicksProperty;
4181  static WindowProperties::MouseButtonDownAutoRepeat d_autoRepeatProperty;
4182  static WindowProperties::AutoRepeatDelay d_autoRepeatDelayProperty;
4183  static WindowProperties::AutoRepeatRate d_autoRepeatRateProperty;
4184  static WindowProperties::DistributeCapturedInputs d_distInputsProperty;
4185  static WindowProperties::CustomTooltipType d_tooltipTypeProperty;
4186  static WindowProperties::Tooltip d_tooltipProperty;
4187  static WindowProperties::InheritsTooltipText d_inheritsTooltipProperty;
4188  static WindowProperties::RiseOnClick d_riseOnClickProperty;
4189  static WindowProperties::VerticalAlignment d_vertAlignProperty;
4190  static WindowProperties::HorizontalAlignment d_horzAlignProperty;
4191  static WindowProperties::UnifiedAreaRect d_unifiedAreaRectProperty;
4192  static WindowProperties::UnifiedPosition d_unifiedPositionProperty;
4193  static WindowProperties::UnifiedXPosition d_unifiedXPositionProperty;
4194  static WindowProperties::UnifiedYPosition d_unifiedYPositionProperty;
4195  static WindowProperties::UnifiedSize d_unifiedSizeProperty;
4196  static WindowProperties::UnifiedWidth d_unifiedWidthProperty;
4197  static WindowProperties::UnifiedHeight d_unifiedHeightProperty;
4198  static WindowProperties::UnifiedMinSize d_unifiedMinSizeProperty;
4199  static WindowProperties::UnifiedMaxSize d_unifiedMaxSizeProperty;
4200  static WindowProperties::MousePassThroughEnabled d_mousePassThroughEnabledProperty;
4201  static WindowProperties::WindowRenderer d_windowRendererProperty;
4202  static WindowProperties::LookNFeel d_lookNFeelProperty;
4203  static WindowProperties::DragDropTarget d_dragDropTargetProperty;
4204  static WindowProperties::AutoRenderingSurface d_autoRenderingSurfaceProperty;
4205  static WindowProperties::Rotation d_rotationProperty;
4206  static WindowProperties::XRotation d_xRotationProperty;
4207  static WindowProperties::YRotation d_yRotationProperty;
4208  static WindowProperties::ZRotation d_zRotationProperty;
4209  static WindowProperties::NonClient d_nonClientProperty;
4210  static WindowProperties::TextParsingEnabled d_textParsingEnabledProperty;
4211  static WindowProperties::Margin d_marginProperty;
4212  static WindowProperties::UpdateMode d_updateModeProperty;
4213  static WindowProperties::MouseInputPropagationEnabled d_mouseInputPropagationProperty;
4214 
4215  /*************************************************************************
4216  Implementation Data
4217  *************************************************************************/
4219  typedef std::vector<Window*> ChildList;
4221  typedef std::map<String, String, String::FastLessCompare> UserStringMap;
4223  typedef std::set<String, String::FastLessCompare> BannedXMLPropertySet;
4224 
4226  const String d_type;
4228  String d_name;
4230  String d_falagardType;
4232  bool d_autoWindow;
4233 
4235  bool d_initialising;
4237  bool d_destructionStarted;
4239  bool d_enabled;
4241  bool d_visible;
4243  bool d_active;
4244 
4246  ChildList d_children;
4248  ChildList d_drawList;
4250  Window* d_parent;
4252  bool d_destroyedByParent;
4253 
4255  bool d_clippedByParent;
4257  bool d_nonClientContent;
4258 
4260  String d_lookName;
4262  WindowRenderer* d_windowRenderer;
4264  GeometryBuffer* d_geometry;
4266  RenderingSurface* d_surface;
4268  mutable bool d_needsRedraw;
4270  bool d_autoRenderingWindow;
4271 
4273  const Image* d_mouseCursor;
4274 
4276  float d_alpha;
4278  bool d_inheritsAlpha;
4279 
4281  static Window* d_captureWindow;
4283  Window* d_oldCapture;
4285  bool d_restoreOldCapture;
4287  bool d_distCapturedInputs;
4288 
4290  Font* d_font;
4292  String d_textLogical;
4294  BiDiVisualMapping* d_bidiVisualMapping;
4296  mutable bool d_bidiDataValid;
4298  mutable RenderedString d_renderedString;
4300  mutable bool d_renderedStringValid;
4302  static BasicRenderedStringParser d_basicStringParser;
4304  static DefaultRenderedStringParser d_defaultStringParser;
4306  RenderedStringParser* d_customStringParser;
4308  bool d_textParsingEnabled;
4309 
4311  UBox d_margin;
4312 
4314  uint d_ID;
4316  void* d_userData;
4318  UserStringMap d_userStrings;
4319 
4321  bool d_alwaysOnTop;
4323  bool d_riseOnClick;
4325  bool d_zOrderingEnabled;
4326 
4328  bool d_wantsMultiClicks;
4330  bool d_mousePassThroughEnabled;
4332  bool d_autoRepeat;
4334  float d_repeatDelay;
4336  float d_repeatRate;
4338  MouseButton d_repeatButton;
4340  bool d_repeating;
4342  float d_repeatElapsed;
4343 
4345  bool d_dragDropTarget;
4346 
4348  String d_tooltipText;
4350  Tooltip* d_customTip;
4352  bool d_weOwnTip;
4354  bool d_inheritsTipText;
4355 
4357  bool d_allowWriteXML;
4359  BannedXMLPropertySet d_bannedXMLProperties;
4360 
4362  URect d_area;
4364  Size d_pixelSize;
4366  UVector2 d_minSize;
4368  UVector2 d_maxSize;
4370  HorizontalAlignment d_horzAlign;
4372  VerticalAlignment d_vertAlign;
4374  Vector3 d_rotation;
4375 
4377  mutable Rect d_outerUnclippedRect;
4379  mutable Rect d_innerUnclippedRect;
4381  mutable Rect d_outerRectClipper;
4383  mutable Rect d_innerRectClipper;
4385  mutable Rect d_hitTestRect;
4386 
4387  mutable bool d_outerUnclippedRectValid;
4388  mutable bool d_innerUnclippedRectValid;
4389  mutable bool d_outerRectClipperValid;
4390  mutable bool d_innerRectClipperValid;
4391  mutable bool d_hitTestRectValid;
4392 
4394  WindowUpdateMode d_updateMode;
4396  bool d_propagateMouseInputs;
4397 
4398 
4399 private:
4400  /*************************************************************************
4401  May not copy or assign Window objects
4402  *************************************************************************/
4403  Window(const Window&) : PropertySet(), EventSet() {}
4404  Window& operator=(const Window&) {return *this;}
4405 };
4406 
4407 } // End of CEGUI namespace section
4408 
4409 
4410 #if defined(_MSC_VER)
4411 # pragma warning(pop)
4412 #endif
4413 
4414 #endif // end of guard _CEGUIWindow_h_
4415 
Generated by   doxygen 1.8.3.1