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

Base class for dialog windows. More...

#include <Dialog.h>

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

List of all members.

Public Member Functions

PLGUI_API Dialog (Widget *pParent=nullptr)
 Constructor.
virtual PLGUI_API ~Dialog ()
 Destructor.
PLGUI_API void ShowDialog ()
 Show dialog.
PLGUI_API void CloseDialog (int nResult=0)
 Close dialog.
PLGUI_API int GetResult () const
 Get result value.
virtual PLGUI_API void OnCloseDialog (int nResult)
 Called when dialog has been closed.

Public Attributes

PLCore::Event EventShowDialog
PLCore::Event< int > EventCloseDialog

Protected Member Functions

virtual PLGUI_API void OnClose ()
 Called when the widget shall be closed.

Detailed Description

Base class for dialog windows.


Constructor & Destructor Documentation

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

Constructor.

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

Destructor.


Member Function Documentation

PLGUI_API void PLGui::Dialog::ShowDialog ( )

Show dialog.

PLGUI_API void PLGui::Dialog::CloseDialog ( int  nResult = 0)

Close dialog.

Parameters:
[in]nResultResult value
PLGUI_API int PLGui::Dialog::GetResult ( ) const

Get result value.

Returns:
Result value
virtual PLGUI_API void PLGui::Dialog::OnClose ( ) [protected, virtual]

Called when the widget shall be closed.

Reimplemented from PLGui::WidgetFunctions.

virtual PLGUI_API void PLGui::Dialog::OnCloseDialog ( int  nResult) [virtual]

Called when dialog has been closed.

Parameters:
[in]nResultResult value

Member Data Documentation

Dialog is shown

Dialog is closed


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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:18
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported