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

Tab bar button. More...

#include <TabBarButton.h>

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

List of all members.

Public Member Functions

PLGUI_API TabBarButton (Widget *pParent=nullptr)
 Constructor.
virtual PLGUI_API ~TabBarButton ()
 Destructor.
PLGUI_API TabBarGetTabBar () const
 Get TabBar.
PLGUI_API TabBarEntryGetTabBarEntry () const
 Get TabBarEntry.
PLGUI_API ETabBarFunction GetFunction () const
 Get tab-bar function.

Protected Member Functions

PLGUI_API void SetTabBar (TabBar *pTabBar)
 Set TabBar.
PLGUI_API void SetTabBarEntry (TabBarEntry *pEntry)
 Set TabBarEntry.
PLGUI_API void SetFunction (ETabBarFunction nFunction)
 Set tab-bar function.
virtual void OnMouseEnter ()
 Called when the mouse has entered the widget.
virtual void OnMouseLeave ()
 Called when the mouse has left the widget.

Protected Attributes

TabBarm_pTabBar
TabBarEntrym_pTabBarEntry
ETabBarFunction m_nFunction

Detailed Description

Tab bar button.


Constructor & Destructor Documentation

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

Constructor.

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

Destructor.


Member Function Documentation

PLGUI_API TabBar* PLGui::TabBarButton::GetTabBar ( ) const

Get TabBar.

Returns:
TabBar

Get TabBarEntry.

Returns:
TabBarEntry

Get tab-bar function.

Returns:
Function
PLGUI_API void PLGui::TabBarButton::SetTabBar ( TabBar pTabBar) [protected]

Set TabBar.

Parameters:
[in]pTabBarTabBar
PLGUI_API void PLGui::TabBarButton::SetTabBarEntry ( TabBarEntry pEntry) [protected]

Set TabBarEntry.

Parameters:
[in]pEntryTabBarEntry
PLGUI_API void PLGui::TabBarButton::SetFunction ( ETabBarFunction  nFunction) [protected]

Set tab-bar function.

Parameters:
[in]nFunctionFunction
virtual void PLGui::TabBarButton::OnMouseEnter ( ) [protected, virtual]

Called when the mouse has entered the widget.

Reimplemented from PLGui::AbstractButton.

virtual void PLGui::TabBarButton::OnMouseLeave ( ) [protected, virtual]

Called when the mouse has left the widget.

Reimplemented from PLGui::AbstractButton.


Member Data Documentation

TabBar to which the entry belongs

TabBarEntry to which the entry belongs

TabBar function


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:32
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported