centrafuse.Plugins.CFSetup Class Reference

The main plugin setup class. All plugin setups need to inherit from this class. More...

Inherits centrafuse::Plugins::CFPlugin.

Collaboration diagram for centrafuse.Plugins.CFSetup:

[legend]

List of all members.

Classes
class	SetupButton
	Settings button enumeration. More...
Public Types
enum	SetupButtons {   ROW1 = 1,   ROW2 = 2,   ROW3 = 3,   ROW4 = 4,   BUTTONGROUP1 = 5,   BUTTONGROUP2 = 6,   BUTTONGROUP3 = 7,   BUTTONGROUP4 = 8 }
	Setup buttons enumeration. More...
Public Member Functions
delegate void	SettingsClickHandler (ref object value)
	Click Handler delegate for settings implementations.
	CFSetup ()
	The main plugin setup class constructor.
void	buildSetup ()
	Sets up all setup controls. This must be called after the Owner property has been set.
virtual void	readConfig ()
	readConfig() gets overridden to load settings
virtual void	loadSetupPage ()
	Loads and displays current setup page.
void	updateSettingsPage ()
	Update settings texts and values.
void	updateskin ()
	Updates the skin.
void	CF_setupButtons (SetupButtons button, bool enable)
Protected Attributes
SettingsClickHandler[]	m_ButtonHandler = new SettingsClickHandler[8]
	Array of SettingsClickHandler.
string[]	m_ButtonText = new string[8]
	Array of m_ButtonText.
string[]	m_ButtonValue = new string[8]
	Array of m_ButtonValue.
int	m_totalPages = 1
	Number of settings pages.
int	m_currentPage = 1
	Current settings pages.
Properties
int	totalpages [get, set]
	Number of settings pages.
int	currentpage [get, set]
	Current settings pages.
SettingsClickHandler[]	ButtonHandler [get, set]
	Array of SettingsClickHandler.
string[]	ButtonText [get, set]
	Array of m_ButtonText.
string[]	ButtonValue [get, set]
	Array of m_ButtonValue.
Events
EventHandler	CFSetup_back
	Back event.
EventHandler	CFSetup_forward
	Forward event.
EventHandler	CFSetup_ok
	OK event.
EventHandler	CFSetup_cancel
	Cancel event.
EventHandler	CFSetup_button1
EventHandler	CFSetup_button2
EventHandler	CFSetup_button3
EventHandler	CFSetup_button4
EventHandler	CFSetup_button5on
EventHandler	CFSetup_button5off
EventHandler	CFSetup_button6on
EventHandler	CFSetup_button6off
EventHandler	CFSetup_button7on
	Button7 on event.
EventHandler	CFSetup_button7off
EventHandler	CFSetup_button8on
	Button8 on event.
EventHandler	CFSetup_button8off

---

Detailed Description

The main plugin setup class. All plugin setups need to inherit from this class.

---

Member Enumeration Documentation

enum centrafuse::Plugins::CFSetup::SetupButtons

Setup buttons enumeration.

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings

---

Constructor & Destructor Documentation

centrafuse.Plugins.CFSetup.CFSetup

(

)

The main plugin setup class constructor.

---

Member Function Documentation

void centrafuse.Plugins.CFSetup.buildSetup

(

)

Sets up all setup controls. This must be called after the Owner property has been set.

void centrafuse.Plugins.CFSetup.CF_setupButtons	(	SetupButtons	button,
		bool	enable
	)

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Setup buttons.

virtual void centrafuse.Plugins.CFSetup.loadSetupPage

(

)

[virtual]

Loads and displays current setup page.

virtual void centrafuse.Plugins.CFSetup.readConfig

(

)

[virtual]

readConfig() gets overridden to load settings

delegate void centrafuse.Plugins.CFSetup.SettingsClickHandler

(

ref object

value

)

Click Handler delegate for settings implementations.

void centrafuse.Plugins.CFSetup.updateSettingsPage

(

)

Update settings texts and values.

void centrafuse.Plugins.CFSetup.updateskin

(

)

Updates the skin.

---

Member Data Documentation

SettingsClickHandler [] centrafuse.Plugins.CFSetup.m_ButtonHandler = new SettingsClickHandler[8] [protected]

Array of SettingsClickHandler.

string [] centrafuse.Plugins.CFSetup.m_ButtonText = new string[8] [protected]

Array of m_ButtonText.

string [] centrafuse.Plugins.CFSetup.m_ButtonValue = new string[8] [protected]

Array of m_ButtonValue.

int centrafuse.Plugins.CFSetup.m_currentPage = 1 [protected]

Current settings pages.

int centrafuse.Plugins.CFSetup.m_totalPages = 1 [protected]

Number of settings pages.

---

Property Documentation

SettingsClickHandler [] centrafuse.Plugins.CFSetup.ButtonHandler [get, set]

Array of SettingsClickHandler.

string [] centrafuse.Plugins.CFSetup.ButtonText [get, set]

Array of m_ButtonText.

string [] centrafuse.Plugins.CFSetup.ButtonValue [get, set]

Array of m_ButtonValue.

int centrafuse.Plugins.CFSetup.currentpage [get, set]

Current settings pages.

int centrafuse.Plugins.CFSetup.totalpages [get, set]

Number of settings pages.

---

Event Documentation

EventHandler centrafuse.Plugins.CFSetup.CFSetup_back [protected]

Back event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button1 [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button1 event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button2 [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button2 event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button3 [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button3 event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button4 [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button4 event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button5off [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button5 off event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button5on [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button5 on event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button6off [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button6 off event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button6on [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button6 on event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button7off [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button7 off event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button7on [protected]

Button7 on event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button8off [protected]

Deprecated:

New Setup/Settings API/Coding style should now be used for setup screens

See also:

Setup / Settings Button8 off event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_button8on [protected]

Button8 on event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_cancel [protected]

Cancel event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_forward [protected]

Forward event.

EventHandler centrafuse.Plugins.CFSetup.CFSetup_ok [protected]

OK event.

---

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

• CFSetup.cs