ManaPlus
Public Member Functions | Protected Attributes
BasicContainer2 Class Reference

#include <basiccontainer2.h>

Inheritance diagram for BasicContainer2:
BasicContainer Widget WidgetDeathListener Widget2 Container Window AttrDisplay CharacterDisplay CharacterViewBase DebugTab Desktop FlowContainer HorizontContainer Popup SetupTab SliderList StatsPage StatsPageBasic VertContainer WidgetGroup WindowContainer WindowMenu BankWindow BuyDialog BuySellDialog ChangeEmailDialog ChangePasswordDialog CharCreateDialog CharSelectDialog ChatWindow ConfirmDialog ConnectionDialog CutInWindow DebugWindow DidYouKnowWindow EditDialog EditServerDialog EmoteWindow EquipmentWindow HelpWindow InventoryWindow ItemAmountWindow KillStats LoginDialog MailEditWindow MailViewWindow MailWindow Minimap MiniStatusWindow NpcDialog OkDialog OutfitWindow QuestsWindow QuitDialog RegisterDialog SellDialog ServerDialog ServerInfoWindow SetupWindow ShopWindow ShortcutWindow SkillDialog SocialWindow StatusWindow TextCommandEditor TextDialog TextSelectDialog TradeWindow UpdaterWindow WhoIsOnline WorldSelectDialog

Public Member Functions

 BasicContainer2 (const Widget2 *const widget)
 
virtual ~BasicContainer2 ()
 
void setOpaque (Opaque opaque)
 
bool isOpaque () const
 
virtual void add (Widget *const widget)
 
void addXY (Widget *const widget, const int x, const int y)
 
void draw (Graphics *const graphics)
 
void safeDraw (Graphics *const graphics)
 
- Public Member Functions inherited from BasicContainer
 BasicContainer (const Widget2 *const widget)
 
virtual ~BasicContainer ()
 
void showWidgetPart (Widget *const widget, const Rect &area)
 
void moveToTop (Widget *const widget)
 
void moveToBottom (Widget *const widget)
 
Rect getChildrenArea ()
 
void focusNext ()
 
void focusPrevious ()
 
void logic ()
 
void setFocusHandler (FocusHandler *const focusHandler)
 
void setInternalFocusHandler (FocusHandler *const focusHandler)
 
WidgetgetWidgetAt (int x, int y)
 
void death (const Event &event)
 
WidgetfindFirstWidget (const std::set< Widget *> &list)
 
void add (Widget *const widget)
 
virtual void remove (Widget *const widget)
 
virtual void clear ()
 
- Public Member Functions inherited from Widget
 Widget (const Widget2 *const widget)
 
virtual ~Widget ()
 
virtual void drawFrame (Graphics *graphics)
 
virtual void safeDrawFrame (Graphics *graphics)
 
void setFrameSize (const unsigned int frameSize)
 
unsigned int getFrameSize () const
 
WidgetgetParent () const
 
void setWidth (const int width)
 
int getWidth () const
 
void setHeight (const int height)
 
int getHeight () const
 
void setSize (const int width, const int height)
 
void setX (const int x)
 
int getX () const
 
void setY (const int y)
 
int getY () const
 
void setPosition (const int x, const int y)
 
void setDimension (const Rect &dimension)
 
const RectgetDimension () const
 
void setFocusable (const bool focusable)
 
bool isFocusable () const
 
virtual bool isFocused () const
 
void setEnabled (const bool enabled)
 
bool isEnabled () const
 
void setVisible (Visible visible)
 
bool isVisible () const
 
void setBaseColor (const Color &color)
 
const ColorgetBaseColor () const
 
void setForegroundColor (const Color &color)
 
const ColorgetForegroundColor () const
 
void setBackgroundColor (const Color &color)
 
const ColorgetBackgroundColor () const
 
virtual void requestFocus ()
 
virtual void requestMoveToTop ()
 
virtual void requestMoveToBottom ()
 
FocusHandlergetFocusHandler ()
 
void addActionListener (ActionListener *const actionListener)
 
void removeActionListener (ActionListener *const actionListener)
 
void addDeathListener (WidgetDeathListener *const deathListener)
 
void removeDeathListener (WidgetDeathListener *const deathListener)
 
void addMouseListener (MouseListener *const mouseListener)
 
void removeMouseListener (MouseListener *const mouseListener)
 
void addKeyListener (KeyListener *const keyListener)
 
void removeKeyListener (KeyListener *const keyListener)
 
void addFocusListener (FocusListener *const focusListener)
 
void removeFocusListener (FocusListener *const focusListener)
 
void addWidgetListener (WidgetListener *const widgetListener)
 
void removeWidgetListener (WidgetListener *const widgetListener)
 
void setActionEventId (const std::string &actionEventId)
 
const std::string & getActionEventId () const
 
virtual void getAbsolutePosition (int &x, int &y) const
 
virtual void setParent (Widget *parent)
 
FontgetFont () const
 
void setFont (Font *const font)
 
virtual void fontChanged ()
 
bool isTabInEnabled () const
 
void setTabInEnabled (const bool enabled)
 
bool isTabOutEnabled () const
 
void setTabOutEnabled (const bool enabled)
 
void requestModalFocus ()
 
virtual void requestModalMouseInputFocus ()
 
virtual void releaseModalFocus ()
 
virtual void releaseModalMouseInputFocus ()
 
virtual bool isModalFocused () const
 
virtual bool isModalMouseInputFocused () const
 
const std::list< MouseListener * > & getMouseListeners () const A_CONST
 
const std::list< KeyListener * > & getKeyListeners () const A_CONST
 
const std::list< FocusListener * > & getFocusListeners () const A_CONST
 
virtual FocusHandlergetInternalFocusHandler ()
 
void setInternalFocusHandler (FocusHandler *const internalFocusHandler)
 
void setId (const std::string &id)
 
const std::string & getId () const
 
virtual void showPart (const Rect &rectangle)
 
bool isAllowLogic () const
 
void setMouseConsume (const bool b)
 
bool isMouseConsume () const
 
void setRedraw (const bool b)
 
virtual bool isSelectable () const
 
void setSelectable (const bool selectable)
 
void windowResized ()
 
virtual void postInit ()
 
- Public Member Functions inherited from Widget2
virtual ~Widget2 ()
 
const ColorgetThemeColor (const ThemeColorIdT type, const unsigned int alpha=255U) const A_INLINE
 
const ColorgetThemeCharColor (const signed char c, bool &valid) const A_INLINE
 
virtual void setWidget2 (const Widget2 *const widget)
 
void setPalette (int palette)
 
void checkPalette ()
 
void setForegroundColor2 (const Color &color)
 
WidgetgetWindow () const
 
virtual void setWindow (Widget *const window)
 
- Public Member Functions inherited from WidgetDeathListener
virtual ~WidgetDeathListener ()
 

Protected Attributes

Opaque mOpaque
 
- Protected Attributes inherited from BasicContainer
WidgetList mWidgets
 
WidgetList mLogicWidgets
 
- Protected Attributes inherited from Widget
MouseListenerList mMouseListeners
 
KeyListenerList mKeyListeners
 
ActionListenerList mActionListeners
 
WidgetDeathListenerList mDeathListeners
 
FocusListenerList mFocusListeners
 
WidgetListenerList mWidgetListeners
 
Color mForegroundColor
 
Color mBackgroundColor
 
Color mBaseColor
 
Rect mDimension
 
std::string mActionEventId
 
std::string mId
 
FocusHandlermFocusHandler
 
FocusHandlermInternalFocusHandler
 
WidgetmParent
 
FontmCurrentFont
 
unsigned int mFrameSize
 
bool mFocusable
 
bool mTabIn
 
bool mTabOut
 
bool mEnabled
 
bool mAllowLogic
 
bool mMouseConsume
 
bool mRedraw
 
bool mSelectable
 
- Protected Attributes inherited from Widget2
int mPaletteOffset
 
WidgetmWindow
 
Color mForegroundColor2
 

Additional Inherited Members

- Static Public Member Functions inherited from Widget
static void setGlobalFont (Font *const font)
 
static FontgetGloablFont ()
 
static void cleanGlobalFont ()
 
static bool widgetExists (const Widget *const widget)
 
static void distributeWindowResizeEvent ()
 
static WidgetcallPostInit (Widget *const widget)
 
- Data Fields inherited from Widget
Visible mVisible
 
- Protected Types inherited from BasicContainer
typedef std::vector< Widget * > WidgetList
 
typedef WidgetList::iterator WidgetListIterator
 
typedef WidgetList::const_iterator WidgetListConstIterator
 
typedef WidgetList::reverse_iterator WidgetListReverseIterator
 
typedef WidgetList::const_reverse_iterator WidgetListCReverseIterator
 
- Protected Types inherited from Widget
typedef std::list< MouseListener * > MouseListenerList
 
typedef MouseListenerList::iterator MouseListenerIterator
 
typedef std::list< KeyListener * > KeyListenerList
 
typedef KeyListenerList::iterator KeyListenerIterator
 
typedef std::list< ActionListener * > ActionListenerList
 
typedef ActionListenerList::iterator ActionListenerIterator
 
typedef std::list< WidgetDeathListener * > WidgetDeathListenerList
 
typedef WidgetDeathListenerList::iterator WidgetDeathListenerIterator
 
typedef std::list< FocusListener * > FocusListenerList
 
typedef FocusListenerList::iterator FocusListenerIterator
 
typedef std::list< WidgetListener * > WidgetListenerList
 
typedef WidgetListenerList::iterator WidgetListenerIterator
 
- Protected Member Functions inherited from BasicContainer
virtual void drawChildren (Graphics *const graphics)
 
virtual void safeDrawChildren (Graphics *const graphics)
 
virtual void logicChildren ()
 
- Protected Member Functions inherited from Widget
void distributeActionEvent ()
 
void distributeResizedEvent ()
 
void distributeMovedEvent ()
 
void distributeHiddenEvent ()
 
void distributeShownEvent ()
 
- Protected Member Functions inherited from Widget2
 Widget2 (const Widget2 *const widget)
 
- Protected Member Functions inherited from WidgetDeathListener
 WidgetDeathListener ()
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

An implementation of a container able to contain other widgets. A widget's position in the container is relative to the container itself and not the screen. A container is the most common widget to use as the Gui's top widget as makes the Gui able to contain more than one widget.

See also
Gui::setTop

Definition at line 79 of file basiccontainer2.h.

Constructor & Destructor Documentation

◆ BasicContainer2()

BasicContainer2::BasicContainer2 ( const Widget2 *const  widget)
explicit

Constructor. A container is opauqe as default, if you want a none opaque container call setQpaque(false).

See also
setOpaque, isOpaque

Definition at line 74 of file basiccontainer2.cpp.

74  :
75  BasicContainer(widget),
77 {
78 }
const bool Opaque_true
Definition: opaque.h:29
BasicContainer(const Widget2 *const widget)

◆ ~BasicContainer2()

BasicContainer2::~BasicContainer2 ( )
virtual

Destructor.

Definition at line 80 of file basiccontainer2.cpp.

81 {
82 }

Member Function Documentation

◆ add()

void BasicContainer2::add ( Widget *const  widget)
virtual

Adds a widget to the container.

Parameters
widgetThe widget to add.
See also
remove, clear

Reimplemented in FlowContainer, and HorizontContainer.

Definition at line 112 of file basiccontainer2.cpp.

References BasicContainer::add().

Referenced by HorizontContainer::add(), FlowContainer::add(), VertContainer::add2(), WindowMenu::addButton(), TabbedArea::addTab(), WidgetGroup::addWidget(), ChangeEmailDialog::ChangeEmailDialog(), CharacterViewNormal::CharacterViewNormal(), CharacterViewSmall::CharacterViewSmall(), CharCreateDialog::CharCreateDialog(), NpcDialog::createSkinControls(), Game::Game(), BuySellDialog::init(), isOpaque(), OkDialog::OkDialog(), ContainerPlacer::operator()(), LayoutHelper::place(), Window::place(), Popup::Popup(), SpeechBubble::postInit(), EmoteWindow::postInit(), TextBoxPopup::postInit(), DebugWindow::postInit(), PopupList::postInit(), SpellPopup::postInit(), SetupWindow::postInit(), TextPopup::postInit(), BeingPopup::postInit(), SkillPopup::postInit(), EditDialog::postInit(), WhoIsOnline::postInit(), ItemPopup::postInit(), ConfirmDialog::postInit(), EquipmentWindow::postInit(), PopupMenu::postInit(), ChatWindow::postInit(), SliderList::postInit2(), CharCreateDialog::setAttributes(), TabbedArea::setSelectedTab(), Client::stateGame(), Client::stateGame1(), StatsPage::StatsPage(), StatsPageBasic::StatsPageBasic(), MiniStatusWindow::updateBars(), WindowMenu::updateButtons(), and Window::Window().

113 {
114  // +++ need move all add() calls from constructors
115  // and after this method can be deleted
116  // and virtual moved to basiccontainer
117  BasicContainer::add(widget);
118 }
void add(Widget *const widget)

◆ addXY()

void BasicContainer2::addXY ( Widget *const  widget,
const int  x,
const int  y 
)

Adds a widget to the container and also specifies the widget's position in the container. The position is relative to the container and not relative to the screen.

Parameters
widgetThe widget to add.
xThe x coordinate for the widget.
yThe y coordinate for the widget.
See also
remove, clear

Definition at line 120 of file basiccontainer2.cpp.

References BasicContainer::add(), and Widget::setPosition().

Referenced by isOpaque(), and Desktop::postInit().

123 {
124  if (widget == nullptr)
125  return;
126  widget->setPosition(x, y);
127  BasicContainer::add(widget);
128 }
void add(Widget *const widget)
void setPosition(const int x, const int y)
Definition: widget.cpp:160

◆ draw()

void BasicContainer2::draw ( Graphics *const  graphics)
virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters
graphicsaA graphics object to draw with.

Implements Widget.

Reimplemented in ChatWindow, Window, Popup, EquipmentWindow, MiniStatusWindow, Viewport, Desktop, Viewport, Minimap, ConnectionDialog, SliderList, DebugWindow, OutfitWindow, and CutInWindow.

Definition at line 84 of file basiccontainer2.cpp.

References BLOCK_END, BLOCK_START, BasicContainer::drawChildren(), Graphics::fillRectangle(), Rect::height, Widget::mBaseColor, Widget::mDimension, mOpaque, Opaque_true, Graphics::setColor(), and Rect::width.

Referenced by SliderList::draw(), Viewport::draw(), Desktop::draw(), isOpaque(), WindowContainer::moveWidgetAfter(), and SliderList::safeDraw().

85 {
86  BLOCK_START("BasicContainer2::draw")
88  {
89  graphics->setColor(mBaseColor);
90  graphics->fillRectangle(Rect(0, 0,
92  }
93 
94  drawChildren(graphics);
95  BLOCK_END("BasicContainer2::draw")
96 }
int width
Definition: rect.h:218
Definition: rect.h:72
#define BLOCK_START(name)
Definition: perfomance.h:78
if(!vert) return
#define BLOCK_END(name)
Definition: perfomance.h:79
Color mBaseColor
Definition: widget.h:1095
virtual void setColor(const Color &color)
Definition: graphics.h:319
int height
Definition: rect.h:223
virtual void fillRectangle(const Rect &rectangle)=0
virtual void drawChildren(Graphics *const graphics)
const bool Opaque_true
Definition: opaque.h:29
Rect mDimension
Definition: widget.h:1100

◆ isOpaque()

bool BasicContainer2::isOpaque ( ) const
inline

Checks if the container is opaque or not.

Returns
True if the container is opaque, false otherwise.
See also
setOpaque

Definition at line 116 of file basiccontainer2.h.

References A_NONNULL, add(), addXY(), draw(), mOpaque, Opaque_true, safeDraw(), x, and y.

117  { return mOpaque == Opaque_true; }
const bool Opaque_true
Definition: opaque.h:29

◆ safeDraw()

void BasicContainer2::safeDraw ( Graphics *const  graphics)
virtual

Implements Widget.

Reimplemented in ChatWindow, Window, Popup, EquipmentWindow, MiniStatusWindow, Viewport, Desktop, Viewport, Minimap, ConnectionDialog, SliderList, DebugWindow, OutfitWindow, and CutInWindow.

Definition at line 98 of file basiccontainer2.cpp.

References BLOCK_END, BLOCK_START, Graphics::fillRectangle(), Rect::height, Widget::mBaseColor, Widget::mDimension, mOpaque, Opaque_true, BasicContainer::safeDrawChildren(), Graphics::setColor(), and Rect::width.

Referenced by isOpaque().

99 {
100  BLOCK_START("BasicContainer2::draw")
101  if (mOpaque == Opaque_true)
102  {
103  graphics->setColor(mBaseColor);
104  graphics->fillRectangle(Rect(0, 0,
106  }
107 
108  safeDrawChildren(graphics);
109  BLOCK_END("BasicContainer2::draw")
110 }
int width
Definition: rect.h:218
Definition: rect.h:72
#define BLOCK_START(name)
Definition: perfomance.h:78
if(!vert) return
#define BLOCK_END(name)
Definition: perfomance.h:79
Color mBaseColor
Definition: widget.h:1095
virtual void setColor(const Color &color)
Definition: graphics.h:319
int height
Definition: rect.h:223
virtual void fillRectangle(const Rect &rectangle)=0
const bool Opaque_true
Definition: opaque.h:29
Rect mDimension
Definition: widget.h:1100
virtual void safeDrawChildren(Graphics *const graphics)

◆ setOpaque()

void BasicContainer2::setOpaque ( Opaque  opaque)
inline

Sets the container to be opaque or not. If the container is opaque its background will be drawn, if it's not opaque its background will not be drawn, and thus making the container completely transparent.

NOTE: This is not the same as to set visibility. A non visible container will not itself nor will it draw its content.

Parameters
opaqueTrue if the container should be opaque, false otherwise.
See also
isOpaque

Definition at line 107 of file basiccontainer2.h.

References mOpaque.

Referenced by Container::Container(), TabbedArea::postInit(), Gui::postInit(), Setup_Colors::Setup_Colors(), SetupTab::SetupTab(), and Viewport::Viewport().

108  { mOpaque = opaque; }

Field Documentation

◆ mOpaque

Opaque BasicContainer2::mOpaque
protected

True if the container is opaque, false otherwise.

Definition at line 150 of file basiccontainer2.h.

Referenced by draw(), isOpaque(), safeDraw(), and setOpaque().


The documentation for this class was generated from the following files: