PixelLightAPI  .
Public Member Functions | Protected Member Functions | Protected Attributes
PLGui::PopupMenu Class Reference

Popup menu widget. More...

#include <PopupMenu.h>

Inheritance diagram for PLGui::PopupMenu:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PLGUI_API PopupMenu (Widget *pParent=nullptr)
 Constructor.
virtual PLGUI_API ~PopupMenu ()
 Destructor.
PLGUI_API PLMath::Vector2i GetPopupSize ()
 Get popup size.
PLGUI_API void ShowPopupMenu (const PLMath::Vector2i &vPos)
 Open popup menu at specific position.
PLGUI_API void ClosePopupMenu ()
 Close popup menu.

Protected Member Functions

virtual PLGUI_API void OnDraw (Graphics &cGraphics) override
 Called to draw the widget.

Protected Attributes

bool m_bPopupSizeCalculated

Detailed Description

Popup menu widget.


Constructor & Destructor Documentation

PLGUI_API PLGui::PopupMenu::PopupMenu ( Widget pParent = nullptr)

Constructor.

Parameters:
[in]pParentPointer to parent widget
virtual PLGUI_API PLGui::PopupMenu::~PopupMenu ( ) [virtual]

Destructor.


Member Function Documentation

Get popup size.

Returns:
Size of popup menu
PLGUI_API void PLGui::PopupMenu::ShowPopupMenu ( const PLMath::Vector2i vPos)

Open popup menu at specific position.

Parameters:
[in]vPosScreen position

Close popup menu.

virtual PLGUI_API void PLGui::PopupMenu::OnDraw ( Graphics cGraphics) [override, protected, virtual]

Called to draw the widget.

Parameters:
[in]cGraphicsGraphics object used for painting

Reimplemented from PLGui::WidgetFunctions.


Member Data Documentation

'true' if size has already been calculated, else 'false'


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:33
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported