Mana
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SetupTab Class Referenceabstract

A container for the contents of a tab in the setup window. More...

#include <setuptab.h>

Inheritance diagram for SetupTab:
Container Setup_Audio Setup_Colors Setup_Interface Setup_Joystick Setup_Keyboard Setup_Players Setup_Video

Public Member Functions

 SetupTab ()
 
const std::string & getName () const
 
virtual void apply ()=0
 Called when the Apply button is pressed in the setup window.
 
virtual void cancel ()=0
 Called when the Cancel button is pressed in the setup window.
 
- Public Member Functions inherited from Container
 Container ()
 
 ~Container () override
 
void drawFrame (gcn::Graphics *graphics) override
 

Protected Member Functions

void setName (const std::string &name)
 Sets the name displayed on the tab.
 
- Protected Member Functions inherited from Container
LayoutgetLayout ()
 Gets the layout handler for this container.
 
LayoutCellplace (int x, int y, gcn::Widget *wg, int w=1, int h=1)
 Adds a widget to the container and sets it at given cell.
 
ContainerPlacer getPlacer (int x, int y)
 Returns a proxy for adding widgets in an inner table of the layout.
 

Private Attributes

std::string mName
 

Detailed Description

A container for the contents of a tab in the setup window.

Definition at line 31 of file setuptab.h.

Constructor & Destructor Documentation

◆ SetupTab()

SetupTab::SetupTab ( )

Definition at line 24 of file setuptab.cpp.

Member Function Documentation

◆ apply()

virtual void SetupTab::apply ( )
pure virtual

Called when the Apply button is pressed in the setup window.

Implemented in Setup_Audio, Setup_Colors, Setup_Interface, Setup_Joystick, Setup_Keyboard, Setup_Players, and Setup_Video.

◆ cancel()

virtual void SetupTab::cancel ( )
pure virtual

Called when the Cancel button is pressed in the setup window.

Implemented in Setup_Audio, Setup_Colors, Setup_Interface, Setup_Joystick, Setup_Keyboard, Setup_Players, and Setup_Video.

◆ getName()

const std::string & SetupTab::getName ( ) const
inline

Definition at line 36 of file setuptab.h.

◆ setName()

void SetupTab::setName ( const std::string &  name)
inlineprotected

Sets the name displayed on the tab.

Should be set in the constructor of a subclass.

Definition at line 54 of file setuptab.h.

Member Data Documentation

◆ mName

std::string SetupTab::mName
private

Definition at line 58 of file setuptab.h.


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