OChess v0.0.2
Programmer's Manual
GameTab Class Reference

Main tab for opened games. Contains GameTabLeftPanel and GameTabRightPanel. More...

#include <GameTab.hpp>

Inheritance diagram for GameTab:
TabInfos

Public Member Functions

 GameTab (wxFrame *parent, std::shared_ptr< Game > game)
 
void ApplyPreferences ()
 Can be called to load preferences that have been modify in the application settings. More...
 
std::shared_ptr< GameGetGame ()
 
std::shared_ptr< GameBaseGetBase ()
 
void OnLink ()
 Callback that is called when the current tab is linked to another one. More...
 
- Public Member Functions inherited from TabInfos
 TabInfos (Type type_)
 
void Link (TabInfos *tab)
 
virtual void Refresh ()
 
virtual void OnLink ()
 Callback that is called when the current tab is linked to another one. More...
 
virtual void ApplyPreferences ()
 Can be called to load preferences that have been modify in the application settings. More...
 
virtual std::shared_ptr< GameGetGame ()=0
 
virtual std::shared_ptr< GameBaseGetBase ()=0
 
virtual std::uint32_t GetEngineId ()
 

Private Member Functions

void RefreshLabel ()
 
void RefreshTabTitle ()
 
void OnGameChange (wxCommandEvent &event)
 
void OnToolClick (wxCommandEvent &event)
 

Private Attributes

GameTabRightPaneleditor_panel
 
GameTabLeftPanelboard_panel
 
std::shared_ptr< Gamegame
 
std::string related_file
 

Additional Inherited Members

- Public Types inherited from TabInfos
enum  Type { GAME , BASE , ENGINE , NONE }
 Which type of tab is it?
 
typedef enum TabInfos::Type Type
 Which type of tab is it?
 
- Public Attributes inherited from TabInfos
Type type
 
long id
 Each tab has an associated unique id.
 
long linked_id
 Specify to which tab id this tab is linked (e.g: database to linked to on of its opened game tab)
 
bool is_linked
 Set to true if this tab is attach to another one (c.f linked_id)
 
bool is_dirty
 True if current tab is dirty.
 

Detailed Description

Main tab for opened games. Contains GameTabLeftPanel and GameTabRightPanel.

Member Function Documentation

◆ ApplyPreferences()

void GameTab::ApplyPreferences ( )
virtual

Can be called to load preferences that have been modify in the application settings.

Reimplemented from TabInfos.

◆ GetBase()

std::shared_ptr< GameBase > GameTab::GetBase ( )
inlinevirtual

Implements TabInfos.

◆ GetGame()

std::shared_ptr< Game > GameTab::GetGame ( )
inlinevirtual

Implements TabInfos.

◆ OnLink()

void GameTab::OnLink ( )
inlinevirtual

Callback that is called when the current tab is linked to another one.

Reimplemented from TabInfos.


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