guiBubbleTextCtrl.h

Engine/source/gui/utility/guiBubbleTextCtrl.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUIBUBBLETEXTCTRL_H_
25#define _GUIBUBBLETEXTCTRL_H_
26
27#ifndef _GUITEXTCTRL_H_
28#include "gui/controls/guiTextCtrl.h"
29#endif
30#ifndef _GUIMLTEXTCTRL_H_
31#include "gui/controls/guiMLTextCtrl.h"
32#endif
33
34/// A single-line text control that displays its text in a multi-line popup when
35/// clicked.
36class GuiBubbleTextCtrl : public GuiTextCtrl
37{
38   private:
39   
40      typedef GuiTextCtrl Parent;
41
42  protected:
43      bool mInAction;
44      GuiControl *mDlg;
45      GuiControl *mPopup;
46      GuiMLTextCtrl *mMLText;
47
48      void popBubble();
49
50  public:
51  
52      DECLARE_CONOBJECT(GuiBubbleTextCtrl);
53      DECLARE_DESCRIPTION( "A single-line text control that displays its text in a multi-line\n"
54         "popup when clicked." );
55
56      GuiBubbleTextCtrl() :mInAction(false), mDlg(NULL), mPopup(NULL), mMLText(NULL) {}
57
58      virtual void onMouseDown(const GuiEvent &event);
59};
60
61#endif /* _GUI_BUBBLE_TEXT_CONTROL_H_ */
62