AxLibrarySettingsPage Class Reference
[AxTk resource classes]

A predefined panel for editing resource library settings using a conventional UI. More...

#include <ax_resource/ax_settings_librarypage.h>

List of all members.

Public Types
enum	{   ID_AXLIBRARYSETTINGSPAGE = 11000, ID_LIBRARY_PREFERENCES_MAIN_PATH = 11001, ID_LIBRARY_PREFERENCES_MAIN_PATH_BROWSE = 11002, ID_LIBRARY_PREFERENCES_ADDITIONAL_PATH = 11003,   ID_LIBRARY_PREFERENCES_ADD = 11004, ID_LIBRARY_PREFERENCES_REMOVE = 11005, ID_LIBRARY_PREFERENCES_FILE_TYPES = 11006, ID_LIBRARY_PREFERENCES_ADD_FILE_TYPE = 11007,   ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE = 11008, ID_LIBRARY_PREFERENCES_RESET = 11009, ID_LIBRARY_DEFAULT_DESIGN = 11010, ID_LIBRARY_CONSOLIDATE = 11011 }
	Control identifiers. More...
Public Member Functions
	AxLibrarySettingsPage ()
	Constructors.
	AxLibrarySettingsPage (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxNO_BORDER|wxTAB_TRAVERSAL)
bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxNO_BORDER|wxTAB_TRAVERSAL)
	Creation.
	~AxLibrarySettingsPage ()
	Destructor.
void	Init ()
	Initialises member variables.
void	CreateControls ()
	Creates the controls and sizers.
void	Initialize (AxResourceLibrary *library, AxResourceLibrarySettings *settings)
	Initialize with settings object.
void	PopulateAdditionalPaths ()
	Lists files in additional paths.
virtual bool	TransferDataToWindow ()
	Data transfer.
virtual bool	TransferDataFromWindow ()
void	CheckConsolidate ()
	Check can consolidate library file.
void	SetSettings (AxResourceLibrarySettings *settings)
	Set/get settings.
AxResourceLibrarySettings *	GetSettings () const
void	SetLibrary (AxResourceLibrary *library)
	Set/get resource library.
AxResourceLibrary *	GetLibrary () const
void	OnLibraryPreferencesMainPathBrowseClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_MAIN_PATH_BROWSE
void	OnLibraryPreferencesAddClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_ADD
void	OnLibraryPreferencesRemoveClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_REMOVE
void	OnLibraryPreferencesRemoveUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_LIBRARY_PREFERENCES_REMOVE
void	OnLibraryPreferencesAddFileTypeClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_ADD_FILE_TYPE
void	OnLibraryPreferencesRemoveFileTypeClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE
void	OnLibraryPreferencesRemoveFileTypeUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE
void	OnLibraryPreferencesResetClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_RESET
void	OnLibraryDefaultDesignClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_DEFAULT_DESIGN
void	OnLibraryConsolidateClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_CONSOLIDATE
void	OnLibraryConsolidateUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_LIBRARY_CONSOLIDATE
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?
Public Attributes
wxTextCtrl *	m_pathCtrl
wxListBox *	m_additionalPathsCtrl
wxCheckListBox *	m_fileTypesCtrl
bool	m_canConsolidate
AxResourceLibrarySettings *	m_settings
AxResourceLibrary *	m_library

---

Detailed Description

A predefined panel for editing resource library settings using a conventional UI.

---

Member Enumeration Documentation

anonymous enum

Control identifiers.

Enumerator:

ID_AXLIBRARYSETTINGSPAGE
ID_LIBRARY_PREFERENCES_MAIN_PATH
ID_LIBRARY_PREFERENCES_MAIN_PATH_BROWSE
ID_LIBRARY_PREFERENCES_ADDITIONAL_PATH
ID_LIBRARY_PREFERENCES_ADD
ID_LIBRARY_PREFERENCES_REMOVE
ID_LIBRARY_PREFERENCES_FILE_TYPES
ID_LIBRARY_PREFERENCES_ADD_FILE_TYPE
ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE
ID_LIBRARY_PREFERENCES_RESET
ID_LIBRARY_DEFAULT_DESIGN
ID_LIBRARY_CONSOLIDATE

---

Constructor & Destructor Documentation

AxLibrarySettingsPage::AxLibrarySettingsPage

(

)

Constructors.

AxLibrarySettingsPage::AxLibrarySettingsPage	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxNO_BORDER|wxTAB_TRAVERSAL
	)

AxLibrarySettingsPage::~AxLibrarySettingsPage

(

)

Destructor.

---

Member Function Documentation

void AxLibrarySettingsPage::CheckConsolidate

(

)

Check can consolidate library file.

bool AxLibrarySettingsPage::Create	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxNO_BORDER|wxTAB_TRAVERSAL
	)

Creation.

void AxLibrarySettingsPage::CreateControls

(

)

Creates the controls and sizers.

wxBitmap AxLibrarySettingsPage::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

wxIcon AxLibrarySettingsPage::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

AxResourceLibrary* AxLibrarySettingsPage::GetLibrary

(

)

const [inline]

AxResourceLibrarySettings* AxLibrarySettingsPage::GetSettings

(

)

const [inline]

void AxLibrarySettingsPage::Init

(

)

Initialises member variables.

void AxLibrarySettingsPage::Initialize	(	AxResourceLibrary *	library,
		AxResourceLibrarySettings *	settings
	)

Initialize with settings object.

Must be called after panel is created.

Must be called after panel is created.

void AxLibrarySettingsPage::OnLibraryConsolidateClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_CONSOLIDATE

void AxLibrarySettingsPage::OnLibraryConsolidateUpdate

(

wxUpdateUIEvent &

event

)

wxEVT_UPDATE_UI event handler for ID_LIBRARY_CONSOLIDATE

void AxLibrarySettingsPage::OnLibraryDefaultDesignClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_DEFAULT_DESIGN

void AxLibrarySettingsPage::OnLibraryPreferencesAddClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_ADD

void AxLibrarySettingsPage::OnLibraryPreferencesAddFileTypeClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_ADD_FILE_TYPE

void AxLibrarySettingsPage::OnLibraryPreferencesMainPathBrowseClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_MAIN_PATH_BROWSE

void AxLibrarySettingsPage::OnLibraryPreferencesRemoveClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_REMOVE

void AxLibrarySettingsPage::OnLibraryPreferencesRemoveFileTypeClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE

void AxLibrarySettingsPage::OnLibraryPreferencesRemoveFileTypeUpdate

(

wxUpdateUIEvent &

event

)

wxEVT_UPDATE_UI event handler for ID_LIBRARY_PREFERENCES_REMOVE_FILE_TYPE

void AxLibrarySettingsPage::OnLibraryPreferencesRemoveUpdate

(

wxUpdateUIEvent &

event

)

wxEVT_UPDATE_UI event handler for ID_LIBRARY_PREFERENCES_REMOVE

void AxLibrarySettingsPage::OnLibraryPreferencesResetClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_LIBRARY_PREFERENCES_RESET

void AxLibrarySettingsPage::PopulateAdditionalPaths

(

)

Lists files in additional paths.

void AxLibrarySettingsPage::SetLibrary

(

AxResourceLibrary *

library

)

[inline]

Set/get resource library.

void AxLibrarySettingsPage::SetSettings

(

AxResourceLibrarySettings *

settings

)

[inline]

Set/get settings.

bool AxLibrarySettingsPage::ShowToolTips

(

)

[static]

Should we show tooltips?

bool AxLibrarySettingsPage::TransferDataFromWindow

(

)

[virtual]

bool AxLibrarySettingsPage::TransferDataToWindow

(

)

[virtual]

Data transfer.

---

Member Data Documentation

wxListBox* AxLibrarySettingsPage::m_additionalPathsCtrl

bool AxLibrarySettingsPage::m_canConsolidate

wxCheckListBox* AxLibrarySettingsPage::m_fileTypesCtrl

AxResourceLibrary* AxLibrarySettingsPage::m_library

wxTextCtrl* AxLibrarySettingsPage::m_pathCtrl

AxResourceLibrarySettings* AxLibrarySettingsPage::m_settings

---

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

• include/ax_resource/ax_settings_librarypage.h
• src/ax_resource/ax_settings_librarypage.cpp