guiIconButtonCtrl.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. //-----------------------------------------------------------------------------
  2. // Copyright (c) 2012 GarageGames, LLC
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to
  6. // deal in the Software without restriction, including without limitation the
  7. // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  8. // sell copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20. // IN THE SOFTWARE.
  21. //-----------------------------------------------------------------------------
  22. #ifndef _GUIICONBUTTON_H_
  23. #define _GUIICONBUTTON_H_
  24. #ifndef _GUIBUTTONCTRL_H_
  25. #include "gui/buttons/guiButtonCtrl.h"
  26. #endif
  27. #ifndef GFX_Texture_Manager_H_
  28. #include "gfx/gfxTextureManager.h"
  29. #endif
  30. /// The GuiIconButtonCtrl draws an icon and text caption within a normal
  31. /// button control with several layout options.
  32. ///
  33. class GuiIconButtonCtrl : public GuiButtonCtrl
  34. {
  35. private:
  36. typedef GuiButtonCtrl Parent;
  37. protected:
  38. StringTableEntry mBitmapName;
  39. GFXTexHandle mTextureNormal;
  40. S32 mIconLocation;
  41. S32 mTextLocation;
  42. S32 mTextMargin;
  43. Point2I mButtonMargin;
  44. /// Make the bitmap fill the button extent.
  45. bool mFitBitmapToButton;
  46. /// Keep a square aspect ration on the icon.
  47. bool mMakeIconSquare;
  48. /// Calculate extent based on icon size, text width, and layout options.
  49. bool mAutoSize;
  50. // Optional bitmap to be displayed when the proper bitmap cannot be found
  51. StringTableEntry mErrorBitmapName;
  52. GFXTexHandle mErrorTextureHandle;
  53. void renderButton( Point2I &offset, const RectI& updateRect);
  54. enum
  55. {
  56. stateNormal,
  57. stateMouseOver,
  58. statePressed,
  59. stateDisabled,
  60. };
  61. void renderBitmapArray(RectI &bounds, S32 state);
  62. public:
  63. enum TextLocation
  64. {
  65. TextLocNone,
  66. TextLocBottom,
  67. TextLocRight,
  68. TextLocTop,
  69. TextLocLeft,
  70. TextLocCenter,
  71. };
  72. enum IconLocation
  73. {
  74. IconLocNone,
  75. IconLocLeft,
  76. IconLocRight,
  77. IconLocCenter
  78. };
  79. DECLARE_CONOBJECT(GuiIconButtonCtrl);
  80. DECLARE_DESCRIPTION( "A button control that displays an icon on the button in addition\n"
  81. "to the optional text label." );
  82. GuiIconButtonCtrl();
  83. static void initPersistFields();
  84. //Parent methods
  85. bool onWake();
  86. void onSleep();
  87. void inspectPostApply();
  88. void onStaticModified(const char* slotName, const char* newValue = NULL);
  89. bool resize(const Point2I &newPosition, const Point2I &newExtent);
  90. void setBitmap(const char *name);
  91. // Used to set the optional error bitmap
  92. void setErrorBitmap(const char *name);
  93. void onRender(Point2I offset, const RectI &updateRect);
  94. };
  95. typedef GuiIconButtonCtrl::TextLocation GuiIconButtonTextLocation;
  96. typedef GuiIconButtonCtrl::IconLocation GuiIconButtonIconLocation;
  97. DefineEnumType( GuiIconButtonTextLocation );
  98. DefineEnumType( GuiIconButtonIconLocation );
  99. #endif //_GUIICONBUTTON_H_