CFSetup Class Reference

The main plugin setup/settings class. More...

Collaboration diagram for CFSetup:

[legend]

Public Types
enum	CFPowerModes { Resume, StatusChange, Suspend }
	PowerModes. More...
enum	FormWindowState { Maximized, Normal, Minimized }
	FormWindowState. More...
Public Member Functions
virtual void	CF_setupReadSettings (int page, bool advanced)
	Called by CFSetup base class to load settings values.
void	CF_loadSetupPage ()
	Loads current settings page.
void	CF_reloadSetupPages (int numbasicpages, int numadvancedpages)
	Loads current settings page.
void	CF_reloadSetupPages (int numbasicpages, int numadvancedpages, bool custom)
	Loads current settings page.
void	CF_initSetup (int numbasicpages, int numadvancedpages)
	Builds setup screens for main Centrafuse application.
void	CF_initSetup (CFPlugin mainplugin, int numbasicpages, int numadvancedpages)
	Builds setup screens for Plugins.
void	CF_setListFocus ()
FormWindowState	CF_getWindowState ()
void	CF_setWindowState (FormWindowState state)
	Set Centrafuse window state.
void	CF_resetAutoHideTimer ()
	Reset auto hide timer used for dialogs.
bool	CF_getGraffitiStylusDown ()
	Get graffiti stylus flag.
bool	CF_getGraffitiStatus ()
	Get graffiti status.
CF_Actions	CF_systemGetCurrentLocation (out string param1)
	Get current location.
Font	CF_getFont (string fontname, float fontsize, System.Drawing.FontStyle fontstyle)
	Get font.
void	CF_systemCommand (CF_Actions command, string param1, string param2, string param3, string param4)
	Performs system command.
CFComPort[]	CF_getSerialPorts ()
	Gets available serial ports.
bool	CF_getGPSVisible ()
	Gets GPS visible status.
bool	CF_getMuteStatus ()
	Gets mute status.
bool	CF_getConnectionStatus ()
	Returns internet connection status.
Rectangle	CF_createRect (int x, int y, int width, int height)
	Creates a properly sized rectangle based on current resolution.
Rectangle	CF_createRect (Rectangle rect)
	Creates a properly sized rectangle based on current resolution.
Rectangle	CF_createRect (Rectangle rect, bool applydisplaynumber)
	Creates a properly sized rectangle based on current resolution.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext)
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, out string resultvalue, out string resulttext)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, out string resultvalue, out string resulttext)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, out string resultvalue, out string resulttext, bool showfiles, bool browseable, bool showextension, bool enablesubactions)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, string param2, out string resultvalue, out string resulttext)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, string param2, out string resultvalue, out string resulttext, bool showfiles, bool browseable, bool showextension, bool enablesubactions)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, string param2, out string resultvalue, out string resulttext, CFControls.CFListViewItem[] listitems)
	Displays system dialog.
DialogResult	CF_systemDisplayDialog (CF_Dialogs dialog, string displaytext, string param, string param2, out string resultvalue, out string resulttext, out object resultobject, CFControls.CFListViewItem[] listitems, bool showfiles, bool browseable, bool showextension, bool enablesubactions, bool fireforwardback, bool fireplusminus, int display)
DialogResult	CF_displayMessage (string message)
	Display a message with the OkBox.
DialogResult	CF_displayMessage (string message, int display)
	Display a message with the OkBox.
void	CF_textToSpeech (string text)
	Converts text to speech.
void	CF_textToSpeech (string text, bool synchronous)
	Converts text to speech.
void	CF_textToSpeechStop ()
	Stops text to speech.
bool	CF_getConfigFlag (CF_ConfigFlags configflag)
	Gets system configuration flag.
bool	CF_getCallStatus ()
	Get phone call status.
void	CF_setConfigFlag (CF_ConfigFlags configflag, bool flag)
	Sets system configuration flag.
string	CF_getConfigSetting (CF_ConfigSettings configsetting)
	Gets system configuration setting.
void	CF_setConfigSetting (CF_ConfigSettings configsetting, string value)
	Sets system configuration setting.
bool	CF_getCDRipState ()
	Sets system general setting.
string	CF_getPluginData (string plugin, string command, string param)
	Gets system configuration setting.
int	CF_getAudioLevel (CF_AudioLevels audiolevel)
	Gets audio level, value between -15 and 15.
void	CF_setAudioLevel (CF_AudioLevels audiolevel, int level)
	Sets audio level, value between -15 and 15.
float	CF_getMixerLevel (int mixerdevice, int mixerinput, bool recordingdevice)
	Gets mixer level,.
void	CF_setMixerLevel (int mixerdevice, int mixerinput, int mixerlevel, bool recordingdevice)
	Sets mixer level, value between 0 and 65535.
void	CF_setMixerLevel (int mixerdevice, int mixerinput, int mixerlevel, bool showdialog, bool recordingdevice)
	Sets mixer level, value between 0 and 65535.
void	CF_setMixerMute (int mixerdevice, int mixerinput, bool mixermute)
	Mutes mixer device.
void	CF_setMixerMute (int mixerdevice, int mixerinput, bool mixermute, bool recordingdevice)
	Mutes mixer device.
void	CF_setMixerRecordSelection (int mixerdevice, int mixerinput)
	Sets record selection.
void	CF_startRecordVoice (int mixerdevice, int mixerinput, string savetofile)
string	CF_stopRecordVoice ()
	Stop Record voice clip.
void	CF_changeSkin (string skin, bool nightskin)
	Changes skin.
void	CF_sectionFocus (bool tabbing)
void	CF_playAudioFile (string filename)
	Play audio file.
int	CF_playAudioFile (string filename, AudioCmpltHandler handler)
	Play audio file.
void	CF_controlAudioFile (int channelhandle, CF_AudioAction audioaction)
	Pause current user audio file.
int	CF_playAudioStream (string audiourl, AudioCmpltHandler handler)
	Play audio stream.
int	CF_playAudioStream (string audiourl, AudioCmpltHandler handler, string useragent)
	Play audio stream.
void	CF_controlAudioStream (int channelhandle, CF_AudioAction audioaction)
	Pause current user audio stream.
CF_AudioStatus	CF_getAudioStatus (int channelhandle)
	Get audio stream status.
virtual string	CF_navGetInfo (CFNavInfo gpsinfo)
	Get GPS information.
virtual void	CF_navSetDestination (CFNavLocation navLocation)
	Sets GPS route.
void	CF_closeApplication ()
	Exits the application.
void	CF_loadExternalApplication (string appdisplayname, string apppath, string appparams, string appwindowname, bool appstartfullscreen)
	Load external application.
void	CF_loadExternalApplication (string appdisplayname, bool apppausemusic, bool guiapplication, int mixerdevice, int mixerinput, int display, string apppath, string appparams, string appwindowname, bool appstartfullscreen)
	Load external application.
void	CF_initRecord (int inputdevice, int inputline)
	Init buffer recording.
void	CF_bassSetVis (int stream, bool pause, bool rear)
	Set visualization to a bass stream.
MixerDeviceInput[]	CF_getPlaybackDevices ()
	Get playback devices.
MixerDeviceInput[]	CF_getRecordDevices ()
	Get record devices.
void	CF_clearRecordBuffer (bool play)
	Clear recording buffer.
CFPlugin.CFTagInformation	CF_getTagInformation (string filename)
	Get tag information.
CFPlugin.CFTagInformation	CF_getTagInformationStream (int channelhandle)
	Get tag information.
void	CF_updateBufferStatus (string plugin, bool buffermode)
	Update buffer status.
bool	CF_checkFormat (string file, CFTools.ExtensionType extType)
	Check file extension.
bool	CF_checkFormat (string[] files, CFTools.ExtensionType extType)
	Check file extension.
void	CF_setGraffitiStatus (bool enabled)
	Set graffiti status.
void	CF_setGraffitiRecognition (bool enabled)
	Set graffiti recognition.
void	CF_loadMediaPlaylist (CFControls.CFListViewItem[] playitems, int startindex, bool piclist)
	Load a new media playlist.
bool	CF_getVisibleModal ()
void	CF_setVisibleModal (bool visible)
	Sets whether a modal is visible.
void	CF_dial (string number)
	Dials a phone number.
void	CF_setPlayPauseButton (bool pause, bool rear)
virtual void	CF_pluginShow ()
	Shows the plugin. Called when the plugin is launched.
virtual void	CF_pluginClose ()
	Closes the plugin. Called when the system exits or plugin closes.
virtual void	CF_pluginSetClickMode (bool singleclick)
	Used to update list views click mode.
virtual bool	CF_pluginCMLCommand (string command, string[] strparams, CF_ButtonState state, bool rear)
	The cml action callback.
virtual string	CF_pluginCMLData (CF_CMLTextItems textitem)
	The cml text callback.
virtual void	CF_pluginCommand (string command, string param1, string param2)
	Used for plugin to plugin communication. Parameters can be passed into CF_Main_systemCommands with CF_Actions.PLUGIN, plugin name, plugin command, and a command parameter.
virtual void	CF_sectionToggleFullScreen ()
	Toggles fullscreen option, when available.
virtual string	CF_pluginData (string command, string param)
	Used for retrieving information from plugins. You can run CF_getPluginData with a plugin name, command, and parameter to retrieve information from other plugins running on the system.
virtual Rectangle	CF_pluginGetVisBounds ()
	Visualizations bounds.
virtual DialogResult	CF_pluginShowSetup ()
	Shows the plugin setup. Called when the plugins setup is launched.
virtual void	CF_pluginPause ()
	Pauses the plugin. Called when the system sends the pause command: Loading DVD's, Videos, Music, Radio, and external applications setup to control a line device.
virtual void	CF_pluginResume ()
	Resumes the plugin from pause. Called when the system sends the resume command.
virtual IntPtr	CF_pluginVisPicHandle ()
	Used for visualizations to render to a PictureBox.
virtual void	CF_pluginResetVis ()
	Reset visualization.
virtual void	CF_pluginSetVisImage (Image visimage)
	Used for visualizations to set image.
virtual string	CF_pluginDefaultConfig ()
	Used for creating a default config.xml file when one does not already exist.
virtual string	CF_pluginGetPassword (string username, bool login)
	Used for overriding centrafuse security passwords.
string	CF_getMainButtonAction (int number, bool rear)
	Get button action text for main screen button based on index.
void	CF_loadButtonIcons (string buttonName, string _offimage, string _downimage)
	Loads skin images.
void	CF_setPictureImage (string pictureboxname, Image newimage)
	Sets picture box image.
void	CF_setMainPictureImage (string pictureboxname, Image newimage)
	Sets picture box image.
void	CF_setButtonOff (string wbutton)
	Sets button to off state.
void	CF_setButtonSecondaryImageFlag (string wbutton, bool enable)
	Sets button secondary image flag.
void	CF_setButtonEnableFlag (string wbutton, bool enable)
	Sets button enable flag.
void	CF_setLabelEnableFlag (string wlabel, bool enable)
	Sets button enable flag.
void	CF_setPictureBoxEnableFlag (string wpb, bool enable)
	Sets picture box enable flag.
void	CF_setButtonOn (string wbutton)
	Sets button to down state.
void	CF_removeButton (string wbutton)
	Removes button from control array.
int	CF_getPictureBoxID (string name)
	Gets picture box array position.
int	CF_getPositionIndicatorID (string name)
	Gets position indicator array position.
int	CF_getButtonID (string name)
	Gets button array position.
int	CF_getLabelID (string name)
	Gets label array position.
int	CF_getListViewID (string name)
	Gets listview array position.
int	CF_getAdvancedListID (string name)
	Gets listview array position.
int	CF_getPanelID (string name)
	Gets panel array position.
int	CF_getVisID (string name)
	Gets listview array position.
string	CF_getText (string labelName)
	Gets label text.
string	CF_getButtonText (string buttonName)
	Gets button text.
void	CF_updateText (string labelName, string text)
	Sets label text.
void	CF_updateText (string labelName, string text, bool docaseconversion)
	Sets label text.
void	CF_updateButtonText (string buttonName, string text)
	Sets button text.
void	CF_updateButtonText (string buttonName, string text, bool docaseconversion)
	Sets button text.
void	CF_setPositionIndicator (string which, int positioncount, int currentposition)
	Sets position indicator value.
void	CF_setSlider (string which, int svalue)
	Sets slider value.
new DialogResult	ShowDialog ()
	ShowDialog override used to set modal flag.
DialogResult	ShowDialog (Form owner)
	ShowDialog override used to set modal flag.
Public Attributes
CFParams	CF_params = null
	Plugin instance parameters.
CFDisplayHooks	CF_displayHooks
	Plugin instance display hooks.
int	buttonLocation = 1
	Current button location.
bool	buttonSelected = false
	Currently selected button flag.
SkinReader	pluginSkinReader = null
	Skin reader.
CFControls.CFPositionIndicator[]	positionindicatorArray = null
	Position indicator collection.
CFControls.CFButton[]	buttonArray = null
CFControls.CFLabel[]	labelArray = null
	Label collection.
CFControls.CFPictureBox[]	pictureboxArray = null
	Picture box collection.
CFControls.CFListView[]	listviewArray = null
	Listview collection.
CFControls.CFAdvancedList[]	advancedlistArray = null
	Scroll Listview collection.
CFControls.CFPanel[]	panelArray = null
	Panel collection.
CFControls.CFPictureBox2[]	picturebox2Array = null
	PictureBox2 collection.
CFControls.CFVis[]	visArray = null
	Visualization collection.
Static Public Attributes
static bool	advancedSettingsOn = false
	Flag indicating whether or not Advanced Settings are enabled.
static CFGlobalParams	CF_globalParams = null
	Centrafuse static global parameters.
Protected Member Functions
delegate void	CFPowerModeChangedEventHandler (object sender, CFPowerModeChangedEventArgs e)
	Drive Event Handler.
delegate void	CFPlaylistHandler (CFControls.CFListViewItem[] playlist, bool push)
	Playlist loaded Event Handler.
delegate void	CFDriveEventHandler (object sender, CFDriveEventArgs e)
	Drive Event Handler.
delegate void	CFBufferStatusEventHandler (object sender, CFBufferStatusArgs e)
	Buffer Status Event Handler.
delegate void	CFAudioStreamDataChangeEventHandler (object sender, CFTagInformation e)
	Audio Stream Data Change Event Handler.
delegate void	CFAudioStreamMessageChangeEventHandler (object sender, string e)
	Audio Stream Message Change Event Handler.
void	CF_writePluginLog (string msg)
	Writes plugin specific log.
void	CF_writePluginLog (string msg, bool writemain)
	Writes plugin specific log.
Image	CF_getIconImage (string icon)
Image	CF_getIconImage (string icon, SkinReader pluginSkinReader)
void	CF_loadImages (string _offimage, string _downimage)
void	CF_loadImages (string _offimage, string _downimage, string sectionID)
void	CF_loadConfig (string configpath)
	Loads configuration.
void	CF_loadLang (string langpath)
	Loads language.
void	CF_clearControls ()
	Clears all control collections, labels, buttons, picture boxes, listviews, and visualizations.
void	CF_createPictureBoxClick (string pictureboxName, MouseEventHandler clickEvent)
	Creates click event for specified picture box.
void	CF_createPictureBoxDown (string pictureboxName, MouseEventHandler downEvent)
	Creates down event for specified picture box.
void	CF_createPictureBoxEvents (string pictureboxName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates up and down events for specified picturebox.
void	CF_createButtonClick (string buttonName, MouseEventHandler clickEvent)
	Creates click event for specified button.
void	CF_createButtonDown (string buttonName, MouseEventHandler downEvent)
	Creates down event for specified button.
void	CF_createButtonEvents (string buttonName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates down event for specified button.
void	CF_createSliderTick (string sliderName, MouseEventHandler tickEvent)
	Creates click event for specified slider.
void	CF_createSliderClick (string sliderName, MouseEventHandler clickEvent)
	Creates click event for specified slider.
void	CF_createSliderDown (string sliderName, MouseEventHandler downEvent)
	Creates down event for specified slider.
void	CF_createSliderEvents (string sliderName, MouseEventHandler tickEvent, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates up and down event for specified slider.
void	CF_createLabelClick (string labelName, MouseEventHandler clickEvent)
	Creates click event for specified label.
void	CF_createLabelDown (string labelName, MouseEventHandler downEvent)
	Creates down event for specified label.
void	CF_createLabelEvents (string labelName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates up and down events for specified label.
void	CF3_initPlugin (string mainPluginName, bool isGUI)
	Initializes a plugin - This function MUST be called for all plugins before calling any other CF methods. pluginConfig, pluginLang, and pluginSkinReader are all initialized by this function call.
void	CF3_writePluginLog (string msg)
	Writes a custom plugin log in the respective AppData/Plugins folder.
void	CF3_initSection (string sectionID)
	Initializes section/screen - skin.
void	CF3_createLabel (string labelName)
	Creates label.
void	CF3_createLabel (string labelName, MouseEventHandler clickEvent)
	Creates label.
void	CF3_createLabel (string labelName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates label.
void	CF3_createButton (string buttonName)
	Creates button.
void	CF3_createButton (string buttonName, string buttonText)
	Creates button.
void	CF3_createButton (string buttonName, MouseEventHandler clickEvent)
	Creates button.
void	CF3_createButton (string buttonName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates button.
void	CF3_createButton (string buttonName, string buttonText, MouseEventHandler clickEvent)
	Creates button.
void	CF3_createButton (string buttonName, string buttonText, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates button.
void	CF3_createSlider (string sliderName)
	Creates slider.
void	CF3_createSlider (string sliderName, int sliderMin, int sliderMax)
	Creates slider.
void	CF3_createSlider (string sliderName, int sliderMin, int sliderMax, MouseEventHandler tickEvent)
	Creates slider.
void	CF3_createSlider (string sliderName, int sliderMin, int sliderMax, MouseEventHandler tickEvent, MouseEventHandler clickEvent)
	Creates slider.
void	CF3_createSlider (string sliderName, int sliderMin, int sliderMax, MouseEventHandler tickEvent, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates slider.
void	CF3_createPanel (string panelName)
	Creates button.
void	CF3_createListView (string listviewName)
	Creates CF2 style list view.
void	CF3_createPictureBox (string pbName)
	Creates regular picture box.
void	CF3_createPictureBox (string pbName, MouseEventHandler clickEvent)
	Creates regular picture box.
void	CF3_createPictureBox (string pbName, MouseEventHandler clickEvent, MouseEventHandler downEvent)
	Creates regular picture box.
Protected Attributes
internal ConfigReader	pluginConfig = null
	Configuration reader.
internal LanguageReader	pluginLang = null
	Language reader.
CFButtonIndexes[]	buttonIndexes = null
	Button index array.
CFControls.CFButton	currButton = null
	Currently selected button.
CFEvents	CF_events = null
	Plugin instance centrafuse event handlers.
Properties
CFSetupHandler[]	ButtonHandler `[get, set]`
	CFSetupHandler array containing the handlers that will be called when a settings button is clicked.
string[]	ButtonText `[get, set]`
	String array containing the text that will be displayed for each text button, the "setting name" per say.
string[]	ButtonValue `[get, set]`
	String array containing the text value that will be displayed for each text button, the "setting value" per say.
ICFMain	MainForm `[get, set]`
	Gets or sets main form.
new FormWindowState	WindowState `[get, set]`
	Gets or sets form WindowState.
int	currentButtonIndex `[get]`
	Gets current button index.
Events
EventHandler	CFSetup_ok
EventHandler	CFSetup_cancel
	Called when the Cancel button is clicked.

Detailed Description

The main plugin setup/settings class.

Overview

This page provides a description of the new 2.0 Settings API (CFSetup Class Usage).

Refer to the SDK examples HelloWorld and SimpleList projects for basic working examples (Setup.cs, Setup.vb, Seup.cpp).

Centrafuse Settings have 2 states, basic mode, and advanced mode. A plugin may have all settings basic, all advanced, or some settings advanced only. Common settings to make advanced are ones that usually are set once, and then never touched again. The CF_showAdvancedSettings flag can be checked when needed to see whether the user is in Advanced or Basic mode. Examples of new settings API usage can be found in the example source codes included in this SDK, in the Setup.cs, Setup.vb, and Setup.cpp files.

The Setup constructor

Your plugin dll will contain a setup class that inherits from CFSetup, and it will contain a constructor where a variey of Setup flags can, or must, be set. The constructor should also set pluginConfig and pluginLang before calling CF_initSetup().

 public Setup(ICFMain mForm, ConfigReader config, LanguageReader lang)
 {
     this.MainForm = mForm;
 
     this.pluginConfig = config;
     this.pluginLang = lang;
 
     // When CF_initSetup() is called, the CFPlugin layer will call back into CF_setupReadSettings() to read the page
     // Note that this.pluginConfig and this.pluginLang must be set before making this call
     CF_initSetup(1, 1);
 
     this.CF_updateText("TITLE", this.pluginLang.ReadField("/APPLANG/SETUP/TITLE"));
 }

The CF_setupReadSettings() Override

The CF_setupReadSettings() override is the central processing function for a plugin's settings fields and values. The CF_setupReadSettings() functions shall be aware of the current page number, and whether or not Advanced settings are enabled, and with this info the correct data should be displayed for the respective settings page.
It utilizes 3 arrays, one for the button labels/text (ButtonText[]), one for the button value (ButtonValue[]) and one for the button handler (ButtonHandler[]). Each array holds 8 objects of it's respective type corresponding to the 8 settings fields on a setup page, where the ButtonText[] and ButtonValue[] arrays each contain strings, the ButtonHandler[] array contains function delegates that handle the settings button click events. The arrays are applied in sequence to the settings buttons, with array indexes 0-3 represent the left hand side text fields, and indexes 4-7 represent the right side boolean buttons/fields. The CFSetupButton enumeration can be used to index the array. In addition, it should check the CFSetup.advancedSettingsOn flag if additional settings are to be shown when in advanced settings mode.

 public override void CF_setupReadSettings(int currentpage, bool advanced)
 {
     try
     {
         int i = SetupButton.One;
 
         if (advanced)
         {
             //*******************************************************************************************
             //*****  ADVANCED SETTINGS - PAGE 1  ********************************************************
             //*******************************************************************************************
             if (currentpage == 1)
             {
                 // TEXT BUTTONS (1-4)
 
                 ButtonHandler[i] = new SettingsClickHandler(SetDisplayName);
                 ButtonText[i] = this.pluginLang.ReadField("/APPLANG/SETUP/DISPLAYNAME");
                 ButtonValue[i++] = this.pluginLang.ReadField("/APPLANG/HELLOWORLD/DISPLAYNAME");
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";

                 // BOOL BUTTONS (5-8)
 
                 ButtonHandler[i] = new SettingsClickHandler(SetLogEvents);
                 ButtonText[i] = this.pluginLang.ReadField("/APPLANG/SETUP/LOGEVENTS");
                 ButtonValue[i++] = this.pluginConfig.ReadField("/APPCONFIG/LOGEVENTS");
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
            }
         }
         else
         {
             //*******************************************************************************************
             //*****  BASIC SETTINGS - PAGE 1  ***********************************************************
             //*******************************************************************************************
             if (currentpage == 1)
             {
 
                 // TEXT BUTTONS (1-4)
 
                 ButtonHandler[i] = new SettingsClickHandler(SetDisplayName);
                 ButtonText[i] = this.pluginLang.ReadField("APPLANG/SETUP/DISPLAYNAME");
                 ButtonValue[i++] = this.pluginLang.ReadField("APPLANG/HELLOWORLD/DISPLAYNAME");
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 // BOOL BUTTONS (5-8)
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
 
                 ButtonHandler[i] = null;
                 ButtonText[i] = "";
                 ButtonValue[i++] = "";
             }
         }
     }
     catch (Exception errmsg) { CFTools.writeError(errmsg.Message, errmsg.StackTrace); }
 }

Settings Fields Button Handlers

As shown in the CF_setupReadSettings() function above, button handlers must be set for all settings buttons in which users may change and/or enter data.
For boolean buttons, the handlers are almost always as simple aS setting the config value to the ToString() representation of the value parameter, the True/False value is represented by the value parameter (ref object value). This can be seen in the below example SetLogEvents().
For text field buttons, the value parameter is the index of the button array, thereby making it easy to move settings fields around in the readConfig() override. This can be seen in the below example SetDisplayName() in the line ButtonValue[(int)value] = resultvalue;.

 private void SetDisplayName(ref object value)
 {
     try
     {
         object tempobject;
         string resultvalue, resulttext;
         if (this.CF_systemDisplayDialog(CF_Dialogs.OSK, this.pluginLang.ReadField("/APPLANG/SETUP/DISPLAYNAME"), ButtonValue[(int)value], null, out resultvalue, out resulttext, out tempobject, null, true, true, true, true, false, false, 1) == DialogResult.OK)
         {
             this.pluginLang.WriteField("/APPLANG/HELLOWORLD/DISPLAYNAME", resultvalue);
             ButtonValue[(int)value] = resultvalue;
         }
     }
     catch (Exception errmsg) { CFTools.writeError(errmsg.Message, errmsg.StackTrace); }
 }

 private void SetLogEvents(ref object value)
 {
     this.pluginConfig.WriteField("/APPCONFIG/LOGEVENTS", value.ToString());
 }

OK and Cancel Button Handlers

Each setup dialog for a plugin can implement it's own Save() and Cancel() routines to handle when a user clicks the Save button or Cancel button. If not implemented, the base CFSetup class will handle setting DialogResults, and proposing Yes/No dialog to user to overwrite settings. If a user continues to overwrite settings after clicking the save button, the base class will also save pluginConfig and pluginLang to file, if appropriately set in that CFSetup instance.

The following examples show event hadlers that do exactly what the base class will already do without handling the events.

 private void section1_CFSetup_ok(object sender, EventArgs e)
 {
     // Launches system YesNo dialog to verify the user wants to overwrite their current settings.  If yes then the
     // local XML document is saved.
     object tempobject;
     string temp, temp2;
     try
     {
         if (this.CF_systemDisplayDialog(CF_Dialogs.YesNo, LanguageReader.GetText("APPLANG/SETUP/OVERWRITETEXT"), null, null, out temp, out temp2, out tempobject, null, true, true, true, true, false, false, 1) == DialogResult.OK)
         {
             configxml.Save(CFTools.AppDataPath + "\\" + PluginPath + ConfigurationFile);
             languagexml.Save(PluginPathLanguages + configxml.SelectSingleNode("/APPCONFIG/APPLANG").InnerText + ".xml");
             this.DialogResult = DialogResult.OK;
         }
     }
     catch (Exception errmsg) { CFTools.writeError(errmsg.Message, errmsg.StackTrace); }
 }

 private void section1_CFSetup_cancel(object sender, EventArgs e)
 {
     this.DialogResult = DialogResult.Cancel;
 }

All plugin setups need to inherit from this class.

Member Enumeration Documentation

enum CFPowerModes [inherited]

PowerModes.

Enumerator:

Resume	The operating system is about to resume from a suspended state.
StatusChange	A power mode status notification event has been raised by the operating system. This might indicate a weak or charging battery, a transition between AC power and battery, or another change in the status of the system power supply.
Suspend	The operating system is about to be suspended.

enum FormWindowState [inherited]

FormWindowState.

Enumerator:

Maximized	Maximized.
Normal	Normal.
Minimized	Minimized.

Member Function Documentation

void CF3_createButton	(	string	buttonName,
		string	buttonText,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates button.

Parameters:

	buttonName	Button name, must match button name specified in skin file.
	buttonText	Button text.
	clickEvent	Click event.
	downEvent	Down event.

void CF3_createButton	(	string	buttonName,
		string	buttonText,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates button.

Parameters:

	buttonName	Button name, must match button name specified in skin file.
	buttonText	Button text.
	clickEvent	Click event.

void CF3_createButton	(	string	buttonName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates button.

Parameters:

	buttonName	Button name, must match button name specified in skin file.
	clickEvent	Click event.
	downEvent	Down event.

void CF3_createButton	(	string	buttonName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates button.

Parameters:

	buttonName	Button name, must match button name specified in skin file.
	clickEvent	Click event.

void CF3_createButton	(	string	buttonName,
		string	buttonText
	)			`[protected, inherited]`

Creates button.

Parameters:

	buttonName	Button name, must match button name specified in skin file.
	buttonText	Button text.

void CF3_createButton ( string buttonName ) [protected, inherited]

Creates button.

Parameters:

buttonName

Button name, must match button name specified in skin file.

void CF3_createLabel	(	string	labelName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates label.

Parameters:

	labelName	Label name, must match label name specified in skin file.
	clickEvent	Click event.
	downEvent	Down event.

void CF3_createLabel	(	string	labelName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates label.

Parameters:

	labelName	Label name, must match label name specified in skin file.
	clickEvent	Click event.

void CF3_createLabel ( string labelName ) [protected, inherited]

Creates label.

Parameters:

labelName

Label name, must match label name specified in skin file.

void CF3_createListView ( string listviewName ) [protected, inherited]

Creates CF2 style list view.

Parameters:

listviewName

List view name, must match list view name in specified in skin file.

void CF3_createPanel ( string panelName ) [protected, inherited]

Creates button.

Parameters:

panelName

Panel name, must match panel name specified in skin file.

void CF3_createPictureBox	(	string	pbName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates regular picture box.

Parameters:

	pbName	Picture Box name, must match picture box name specified in skin file.
	clickEvent	Click event.
	downEvent	Down event.

void CF3_createPictureBox	(	string	pbName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates regular picture box.

Parameters:

	pbName	Picture Box name, must match picture box name specified in skin file.
	clickEvent	Click event.

void CF3_createPictureBox ( string pbName ) [protected, inherited]

Creates regular picture box.

Parameters:

pbName

Picture Box name, must match picture box name specified in skin file.

void CF3_createSlider	(	string	sliderName,
		int	sliderMin,
		int	sliderMax,
		MouseEventHandler	tickEvent,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates slider.

Parameters:

	sliderName	Slider name, must match slider name specified in skin file.
	sliderMin	Minimum slider value.
	sliderMax	Maximum slider value.
	tickEvent	Tick event.
	clickEvent	Click event.
	downEvent	Down event.

void CF3_createSlider	(	string	sliderName,
		int	sliderMin,
		int	sliderMax,
		MouseEventHandler	tickEvent,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates slider.

Parameters:

	sliderName	Slider name, must match slider name specified in skin file.
	sliderMin	Minimum slider value.
	sliderMax	Maximum slider value.
	tickEvent	Tick event.
	clickEvent	Click event.

void CF3_createSlider	(	string	sliderName,
		int	sliderMin,
		int	sliderMax,
		MouseEventHandler	tickEvent
	)			`[protected, inherited]`

Creates slider.

Parameters:

	sliderName	Slider name, must match slider name specified in skin file.
	sliderMin	Minimum slider value.
	sliderMax	Maximum slider value.
	tickEvent	Tick event.

void CF3_createSlider	(	string	sliderName,
		int	sliderMin,
		int	sliderMax
	)			`[protected, inherited]`

Creates slider.

Parameters:

	sliderName	Slider name, must match slider name in loaded skin file.
	sliderMin	Minimum slider value.
	sliderMax	Maximum slider value.

void CF3_createSlider ( string sliderName ) [protected, inherited]

Creates slider.

Parameters:

sliderName

Slider name, must match slider name in loaded skin file.

void CF3_initPlugin	(	string	mainPluginName,
		bool	isGUI
	)			`[protected, inherited]`

Initializes a plugin - This function MUST be called for all plugins before calling any other CF methods. pluginConfig, pluginLang, and pluginSkinReader are all initialized by this function call.

Parameters:

	mainPluginName	Name of the main plugin that this CFPlugin instance belongs to. Note this MUST be the same name as the folder that contains the plugin dll. Note that the plugin dll MUST also have the same name. For example, if the plugin name is "Cam", then the plugin dll must be Plugins/Cam/Cam.dll If the plugin name is "Email", then the plugin dll must be Plugins/Email/Email.dll
	isGUI	Indicates plugin is graphical, or not graphical.

void CF3_initSection ( string sectionID ) [protected, inherited]

Initializes section/screen - skin.

For plugins, be sure to call CF3_initPlugin() before calling this function.

Parameters:

sectionID

ID of skin file section.

void CF3_writePluginLog ( string msg ) [protected, inherited]

Writes a custom plugin log in the respective AppData/Plugins folder.

Parameters:

msg

Text to write to the log

void CF_bassSetVis	(	int	stream,
		bool	pause,
		bool	rear
	)			`[inherited]`

Set visualization to a bass stream.

void CF_changeSkin	(	string	skin,
		bool	nightskin
	)			`[inherited]`

Changes skin.

bool CF_checkFormat	(	string[]	files,
		CFTools.ExtensionType	extType
	)			`[inherited]`

Check file extension.

bool CF_checkFormat	(	string	file,
		CFTools.ExtensionType	extType
	)			`[inherited]`

Check file extension.

void CF_clearControls ( ) [protected, inherited]

Clears all control collections, labels, buttons, picture boxes, listviews, and visualizations.

Labels, buttons, picture boxes, listviews, and visualizations.

void CF_clearRecordBuffer ( bool play ) [inherited]

Clear recording buffer.

void CF_closeApplication ( ) [inherited]

Exits the application.

void CF_controlAudioFile	(	int	channelhandle,
		CF_AudioAction	audioaction
	)			`[inherited]`

Pause current user audio file.

void CF_controlAudioStream	(	int	channelhandle,
		CF_AudioAction	audioaction
	)			`[inherited]`

Pause current user audio stream.

void CF_createButtonClick	(	string	buttonName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates click event for specified button.

Parameters:

	buttonName	Button name, must match button name in loaded skin file.
	clickEvent	Click event.

void CF_createButtonDown	(	string	buttonName,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates down event for specified button.

Parameters:

	buttonName	Button name, must match button name in loaded skin file.
	downEvent	Down event.

void CF_createButtonEvents	(	string	buttonName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates down event for specified button.

Parameters:

	buttonName	Button name, must match button name in loaded skin file.
	clickEvent	Click event.
	downEvent	Down event.

void CF_createLabelClick	(	string	labelName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates click event for specified label.

Parameters:

	labelName	Label name, must match label name in loaded skin file.
	clickEvent	Click event.

void CF_createLabelDown	(	string	labelName,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates down event for specified label.

Parameters:

	labelName	Label name, must match label name in loaded skin file.
	downEvent	Down event.

void CF_createLabelEvents	(	string	labelName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates up and down events for specified label.

Parameters:

	labelName	Label name, must match button name in loaded skin file.
	clickEvent	Click event.
	downEvent	Down event.

void CF_createPictureBoxClick	(	string	pictureboxName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates click event for specified picture box.

Parameters:

	pictureboxName	Picture box name, must match picture box name in loaded skin file.
	clickEvent	Click event.

void CF_createPictureBoxDown	(	string	pictureboxName,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates down event for specified picture box.

Parameters:

	pictureboxName	Picture box name, must match picture box name in loaded skin file.
	downEvent	Down event.

void CF_createPictureBoxEvents	(	string	pictureboxName,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates up and down events for specified picturebox.

Parameters:

	pictureboxName	Picturebox name, must match button name in loaded skin file.
	clickEvent	Click event.
	downEvent	Down event.

Rectangle CF_createRect	(	Rectangle	rect,
		bool	applydisplaynumber
	)			`[inherited]`

Creates a properly sized rectangle based on current resolution.

Parameters:

	rect	Rectangle coordinates to apply aspect ratio to.
	applydisplaynumber	Apply raw coordinates of display number to rectangle creation.

Returns:: Returns new rectangle with skin aspect ratio changes appplied.

Rectangle CF_createRect ( Rectangle rect ) [inherited]

Creates a properly sized rectangle based on current resolution.

Parameters:

rect

Rectangle coordinates to apply aspect ratio to.

Returns:: Returns new rectangle with skin aspect ratio changes appplied.

Rectangle CF_createRect	(	int	x,
		int	y,
		int	width,
		int	height
	)			`[inherited]`

Creates a properly sized rectangle based on current resolution.

Parameters:

	x	X coordinate.
	y	Y coordinate.
	width	Width.
	height	Height.

Returns:: Returns new rectangle with skin aspect ratio changes appplied.

void CF_createSliderClick	(	string	sliderName,
		MouseEventHandler	clickEvent
	)			`[protected, inherited]`

Creates click event for specified slider.

Parameters:

	sliderName	Slider name, must match slider name in loaded skin file.
	clickEvent	Click event.

void CF_createSliderDown	(	string	sliderName,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates down event for specified slider.

Parameters:

	sliderName	Slider name, must match slider name in loaded skin file.
	downEvent	Down event.

void CF_createSliderEvents	(	string	sliderName,
		MouseEventHandler	tickEvent,
		MouseEventHandler	clickEvent,
		MouseEventHandler	downEvent
	)			`[protected, inherited]`

Creates up and down event for specified slider.

Parameters:

	sliderName	Button name, must match button name in loaded skin file.
	tickEvent	Tick event.
	clickEvent	Click event.
	downEvent	Down event.

void CF_createSliderTick	(	string	sliderName,
		MouseEventHandler	tickEvent
	)			`[protected, inherited]`

Creates click event for specified slider.

Parameters:

	sliderName	Slider name, must match slider name in loaded skin file.
	tickEvent	Tick event.

void CF_dial ( string number ) [inherited]

Dials a phone number.

Parameters:

number

The number to dial. Use "MANUALDIAL" to pull up numberpad to dial manually.

DialogResult CF_displayMessage	(	string	message,
		int	display
	)			`[inherited]`

Display a message with the OkBox.

Parameters:

	message	Dialog message.
	display	Display.

DialogResult CF_displayMessage ( string message ) [inherited]

Display a message with the OkBox.

Parameters:

message

Dialog message.

int CF_getAdvancedListID ( string name ) [inherited]

Gets listview array position.

Parameters:

name

Scroll Listview name.

Returns:: Returns scroll listview array position.

int CF_getAudioLevel ( CF_AudioLevels audiolevel ) [inherited]

Gets audio level, value between -15 and 15.

Parameters:

audiolevel

Audio level.

Returns:: Returns audio level.

CF_AudioStatus CF_getAudioStatus ( int channelhandle ) [inherited]

Get audio stream status.

int CF_getButtonID ( string name ) [inherited]

Gets button array position.

Parameters:

name

Button name.

Returns:: Returns button array position.

string CF_getButtonText ( string buttonName ) [inherited]

Gets button text.

Parameters:

buttonName

Button name.

Returns:: Returns button text.

bool CF_getCallStatus ( ) [inherited]

Get phone call status.

Returns:: Returns phone call status.

bool CF_getCDRipState ( ) [inherited]

Sets system general setting.

bool CF_getConfigFlag ( CF_ConfigFlags configflag ) [inherited]

Gets system configuration flag.

Returns:: Returns flag.

string CF_getConfigSetting ( CF_ConfigSettings configsetting ) [inherited]

Gets system configuration setting.

Returns:: Returns setting.

bool CF_getConnectionStatus ( ) [inherited]

Returns internet connection status.

Font CF_getFont	(	string	fontname,
		float	fontsize,
		System.Drawing.FontStyle	fontstyle
	)			`[inherited]`

Get font.

Parameters:

	fontname	Font name.
	fontsize	Font size.
	fontstyle	Font style.

bool CF_getGPSVisible ( ) [inherited]

Gets GPS visible status.

bool CF_getGraffitiStatus ( ) [inherited]

Get graffiti status.

bool CF_getGraffitiStylusDown ( ) [inherited]

Get graffiti stylus flag.

Image CF_getIconImage	(	string	icon,
		SkinReader	pluginSkinReader
	)			`[protected, inherited]`

Gets icon image.

Parameters:

	icon	Icon name or path.
	pluginSkinReader	skinreader instance to read from, use "null" or "this" to read from the local skinreader instance.

Image CF_getIconImage ( string icon ) [protected, inherited]

Gets icon image.

Parameters:

icon

Icon name or path.

int CF_getLabelID ( string name ) [inherited]

Gets label array position.

Parameters:

name

Label name.

Returns:: Returns label array position.

int CF_getListViewID ( string name ) [inherited]

Gets listview array position.

Parameters:

name

Listview name.

Returns:: Returns listview array position.

string CF_getMainButtonAction	(	int	number,
		bool	rear
	)			`[inherited]`

Get button action text for main screen button based on index.

Parameters:

	number	Main button index.
	rear	Rear screen flag.

float CF_getMixerLevel	(	int	mixerdevice,
		int	mixerinput,
		bool	recordingdevice
	)			`[inherited]`

Gets mixer level,.

Value must be 0 - 65535

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.
	recordingdevice	Flag to use recording devices instead of playback.

Returns:: Returns mixer level for given mixer device.

bool CF_getMuteStatus ( ) [inherited]

Gets mute status.

int CF_getPanelID ( string name ) [inherited]

Gets panel array position.

Parameters:

name

Panel name.

Returns:: Returns panel array position.

int CF_getPictureBoxID ( string name ) [inherited]

Gets picture box array position.

Parameters:

name

Picture box name.

Returns:: Returns picture box array position.

MixerDeviceInput [] CF_getPlaybackDevices ( ) [inherited]

Get playback devices.

string CF_getPluginData	(	string	plugin,
		string	command,
		string	param
	)			`[inherited]`

Gets system configuration setting.

Returns:: Returns setting.

int CF_getPositionIndicatorID ( string name ) [inherited]

Gets position indicator array position.

Parameters:

name

Position indicator name.

Returns:: Returns position indicator array position.

MixerDeviceInput [] CF_getRecordDevices ( ) [inherited]

Get record devices.

CFComPort [] CF_getSerialPorts ( ) [inherited]

Gets available serial ports.

CFPlugin.CFTagInformation CF_getTagInformation ( string filename ) [inherited]

Get tag information.

CFPlugin.CFTagInformation CF_getTagInformationStream ( int channelhandle ) [inherited]

Get tag information.

string CF_getText ( string labelName ) [inherited]

Gets label text.

Parameters:

labelName

Label name.

Returns:: Returns label text.

bool CF_getVisibleModal ( ) [inherited]

Gets whether a modal is visible.

int CF_getVisID ( string name ) [inherited]

Gets listview array position.

Parameters:

name

Listview name.

Returns:: Returns listview array position.

FormWindowState CF_getWindowState ( ) [inherited]

Get Centrafuse window state.

void CF_initRecord	(	int	inputdevice,
		int	inputline
	)			`[inherited]`

Init buffer recording.

void CF_initSetup	(	CFPlugin	mainplugin,
		int	numbasicpages,
		int	numadvancedpages
	)

Builds setup screens for Plugins.

Sets up skin, buttons, labels, sliders, picture boxes, visualizations. Note that calling this function will call back into your CF_setupReadSettings() implementation before it returns. It will also record pointers to the owner plugin's pluginConfig and pluginLang instances, and will modify/save them accordingly depending on user actions.

Parameters:

	mainplugin	The CFPlugin instance that is handling the CF_pluginShowSetup() call.
	numbasicpages	Number of pages in Basic Settings section.
	numadvancedpages	Number of pages in Advanced Settings section.

void CF_initSetup	(	int	numbasicpages,
		int	numadvancedpages
	)

Builds setup screens for main Centrafuse application.

Sets up skin, buttons, labels, sliders, picture boxes, visualizations. Note that calling this function will call back into your CF_setupReadSettings() implementation before it returns. To be used internally by Centrafuse main application. For plugins, use CF_initSetup(CFPlugin ownerplugin, int numbasicpages, int numadvancedpages).

Parameters:

	numbasicpages	Number of pages in Basic Settings section.
	numadvancedpages	Number of pages in Advanced Settings section.

void CF_loadButtonIcons	(	string	buttonName,
		string	_offimage,
		string	_downimage
	)			`[inherited]`

Loads skin images.

Parameters:

	buttonName	Name of button to load icons for.
	_offimage	Off icon path.
	_downimage	Down icon path.

void CF_loadConfig ( string configpath ) [protected, inherited]

Loads configuration.

Note that this function is also implicitly called when you call CF3_setupSkin().

Parameters:

configpath

Path to config file.

void CF_loadExternalApplication	(	string	appdisplayname,
		bool	apppausemusic,
		bool	guiapplication,
		int	mixerdevice,
		int	mixerinput,
		int	display,
		string	apppath,
		string	appparams,
		string	appwindowname,
		bool	appstartfullscreen
	)			`[inherited]`

Load external application.

void CF_loadExternalApplication	(	string	appdisplayname,
		string	apppath,
		string	appparams,
		string	appwindowname,
		bool	appstartfullscreen
	)			`[inherited]`

Load external application.

void CF_loadImages	(	string	_offimage,
		string	_downimage,
		string	sectionID
	)			`[protected, inherited]`

Loads skin images.

Note that this function is also implicitly called when you call CF3_setupSkin().

Parameters:

	_offimage	Off image path.
	_downimage	Down image path.
	sectionID	Section ID.

void CF_loadImages	(	string	_offimage,
		string	_downimage
	)			`[protected, inherited]`

Loads skin images.

Note that this function is also implicitly called when you call CF3_setupSkin().

Parameters:

	_offimage	Off image path.
	_downimage	Down image path.

void CF_loadLang ( string langpath ) [protected, inherited]

Loads language.

Note that this function is also implicitly called when you call CF3_setupSkin().

Parameters:

langpath

Path to language file.

void CF_loadMediaPlaylist	(	CFControls.CFListViewItem[]	playitems,
		int	startindex,
		bool	piclist
	)			`[inherited]`

Load a new media playlist.

void CF_loadSetupPage ( )

Loads current settings page.

Called by CF_localskinsetup(), calls into plugin using CF_setupReadSettings() to read in page settings. Can be used by plugin to reload page after manually modifying the ButtonText[], ButtonValue[], and ButtonHandler[] control arrays.

virtual string CF_navGetInfo ( CFNavInfo gpsinfo ) [virtual, inherited]

Get GPS information.

virtual void CF_navSetDestination ( CFNavLocation navLocation ) [virtual, inherited]

Sets GPS route.

int CF_playAudioFile	(	string	filename,
		AudioCmpltHandler	handler
	)			`[inherited]`

Play audio file.

void CF_playAudioFile ( string filename ) [inherited]

Play audio file.

int CF_playAudioStream	(	string	audiourl,
		AudioCmpltHandler	handler,
		string	useragent
	)			`[inherited]`

Play audio stream.

int CF_playAudioStream	(	string	audiourl,
		AudioCmpltHandler	handler
	)			`[inherited]`

Play audio stream.

virtual void CF_pluginClose ( ) [virtual, inherited]

Closes the plugin. Called when the system exits or plugin closes.

virtual bool CF_pluginCMLCommand	(	string	command,
		string[]	strparams,
		CF_ButtonState	state,
		bool	rear
	)			`[virtual, inherited]`

The cml action callback.

Called when a centrafuse control is clicked.

Parameters:

	command	The CML command.
	strparams	Paramaters of the CML command.
	state	State of the click, down state, click/up state, holdclick, etc...
	rear	Flag indicating which zone (front/rear) the command came from.

virtual string CF_pluginCMLData ( CF_CMLTextItems textitem ) [virtual, inherited]

The cml text callback.

Called when a plugin is the current audio source to update main Centrafuse labels and other controls.

Parameters:

textitem

The text/cml items that Centrafuse is requesting the value for.

virtual void CF_pluginCommand	(	string	command,
		string	param1,
		string	param2
	)			`[virtual, inherited]`

Used for plugin to plugin communication. Parameters can be passed into CF_Main_systemCommands with CF_Actions.PLUGIN, plugin name, plugin command, and a command parameter.

Parameters:

	command	The command to execute.
	param1	The first parameter.
	param2	The second parameter.

virtual string CF_pluginData	(	string	command,
		string	param
	)			`[virtual, inherited]`

Used for retrieving information from plugins. You can run CF_getPluginData with a plugin name, command, and parameter to retrieve information from other plugins running on the system.

Parameters:

	command	The command to execute.
	param	The parameter.

Returns:: Returns whatever is appropriate.

virtual string CF_pluginDefaultConfig ( ) [virtual, inherited]

Used for creating a default config.xml file when one does not already exist.

virtual string CF_pluginGetPassword	(	string	username,
		bool	login
	)			`[virtual, inherited]`

Used for overriding centrafuse security passwords.

virtual Rectangle CF_pluginGetVisBounds ( ) [virtual, inherited]

Visualizations bounds.

virtual void CF_pluginPause ( ) [virtual, inherited]

Pauses the plugin. Called when the system sends the pause command: Loading DVD's, Videos, Music, Radio, and external applications setup to control a line device.

virtual void CF_pluginResetVis ( ) [virtual, inherited]

Reset visualization.

virtual void CF_pluginResume ( ) [virtual, inherited]

Resumes the plugin from pause. Called when the system sends the resume command.

virtual void CF_pluginSetClickMode ( bool singleclick ) [virtual, inherited]

Used to update list views click mode.

virtual void CF_pluginSetVisImage ( Image visimage ) [virtual, inherited]

Used for visualizations to set image.

virtual void CF_pluginShow ( ) [virtual, inherited]

Shows the plugin. Called when the plugin is launched.

virtual DialogResult CF_pluginShowSetup ( ) [virtual, inherited]

Shows the plugin setup. Called when the plugins setup is launched.

virtual IntPtr CF_pluginVisPicHandle ( ) [virtual, inherited]

Used for visualizations to render to a PictureBox.

void CF_reloadSetupPages	(	int	numbasicpages,
		int	numadvancedpages,
		bool	custom
	)

Loads current settings page.

Called by CF_localskinsetup(), calls into plugin using CF_setupReadSettings() to read in page settings. Can be used by plugin to reload page after manually modifying the ButtonText[], ButtonValue[], and ButtonHandler[] control arrays.

void CF_reloadSetupPages	(	int	numbasicpages,
		int	numadvancedpages
	)

Loads current settings page.

Called by CF_localskinsetup(), calls into plugin using CF_setupReadSettings() to read in page settings. Can be used by plugin to reload page after manually modifying the ButtonText[], ButtonValue[], and ButtonHandler[] control arrays.

void CF_removeButton ( string wbutton ) [inherited]

Removes button from control array.

Parameters:

wbutton

Button name or action.

void CF_resetAutoHideTimer ( ) [inherited]

Reset auto hide timer used for dialogs.

void CF_sectionFocus ( bool tabbing ) [inherited]

Hides system drop down menu.

virtual void CF_sectionToggleFullScreen ( ) [virtual, inherited]

Toggles fullscreen option, when available.

void CF_setAudioLevel	(	CF_AudioLevels	audiolevel,
		int	level
	)			`[inherited]`

Sets audio level, value between -15 and 15.

Parameters:

	audiolevel	Audio level.
	level	New level.

void CF_setButtonEnableFlag	(	string	wbutton,
		bool	enable
	)			`[inherited]`

Sets button enable flag.

Parameters:

	wbutton	Button name/action.
	enable	Button enable flag.

void CF_setButtonOff ( string wbutton ) [inherited]

Sets button to off state.

Parameters:

wbutton

Button name.

void CF_setButtonOn ( string wbutton ) [inherited]

Sets button to down state.

Parameters:

wbutton

Button name.

void CF_setButtonSecondaryImageFlag	(	string	wbutton,
		bool	enable
	)			`[inherited]`

Sets button secondary image flag.

Parameters:

	wbutton	Button name.
	enable	Secondary image flag.

void CF_setConfigFlag	(	CF_ConfigFlags	configflag,
		bool	flag
	)			`[inherited]`

Sets system configuration flag.

void CF_setConfigSetting	(	CF_ConfigSettings	configsetting,
		string	value
	)			`[inherited]`

Sets system configuration setting.

void CF_setGraffitiRecognition ( bool enabled ) [inherited]

Set graffiti recognition.

void CF_setGraffitiStatus ( bool enabled ) [inherited]

Set graffiti status.

void CF_setLabelEnableFlag	(	string	wlabel,
		bool	enable
	)			`[inherited]`

Sets button enable flag.

Parameters:

	wlabel	Label name/action.
	enable	Button enable flag.

void CF_setListFocus ( ) [inherited]

Set focus to list box if exists.

void CF_setMainPictureImage	(	string	pictureboxname,
		Image	newimage
	)			`[inherited]`

Sets picture box image.

An image to use here can easily be obtained by using the CFTools.ImageFromFile() function.

Parameters:

	pictureboxname	Picture box name.
	newimage	New picture box image.

void CF_setMixerLevel	(	int	mixerdevice,
		int	mixerinput,
		int	mixerlevel,
		bool	showdialog,
		bool	recordingdevice
	)			`[inherited]`

Sets mixer level, value between 0 and 65535.

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.
	mixerlevel	New level.
	showdialog	Show volume dialog.
	recordingdevice	Flag to use recording devices instead of playback.

void CF_setMixerLevel	(	int	mixerdevice,
		int	mixerinput,
		int	mixerlevel,
		bool	recordingdevice
	)			`[inherited]`

Sets mixer level, value between 0 and 65535.

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.
	mixerlevel	New level.
	recordingdevice	Flag to use recording devices instead of playback.

void CF_setMixerMute	(	int	mixerdevice,
		int	mixerinput,
		bool	mixermute,
		bool	recordingdevice
	)			`[inherited]`

Mutes mixer device.

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.
	mixermute	Mute flag.
	recordingdevice	Flag to use recording devices instead of playback.

void CF_setMixerMute	(	int	mixerdevice,
		int	mixerinput,
		bool	mixermute
	)			`[inherited]`

Mutes mixer device.

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.
	mixermute	Mute flag.

void CF_setMixerRecordSelection	(	int	mixerdevice,
		int	mixerinput
	)			`[inherited]`

Sets record selection.

Parameters:

	mixerdevice	Mixer device.
	mixerinput	Mixer device input, not used in Vista.

void CF_setPictureBoxEnableFlag	(	string	wpb,
		bool	enable
	)			`[inherited]`

Sets picture box enable flag.

Parameters:

	wpb	Picture box name.
	enable	Button enable flag.

void CF_setPictureImage	(	string	pictureboxname,
		Image	newimage
	)			`[inherited]`

Sets picture box image.

An image to use here can easily be obtained by using the CFTools.ImageFromFile() function.

Parameters:

	pictureboxname	Picture box name.
	newimage	New picture box image.

void CF_setPlayPauseButton	(	bool	pause,
		bool	rear
	)			`[inherited]`

Sets state of play/pause button.

void CF_setPositionIndicator	(	string	which,
		int	positioncount,
		int	currentposition
	)			`[inherited]`

Sets position indicator value.

Parameters:

	which	Position indicator name.
	positioncount	Position indicator total count.
	currentposition	Position indicator current position.

void CF_setSlider	(	string	which,
		int	svalue
	)			`[inherited]`

Sets slider value.

Parameters:

	which	Slider name.
	svalue	New value.

virtual void CF_setupReadSettings	(	int	page,
		bool	advanced
	)			`[virtual]`

Called by CFSetup base class to load settings values.

This functions is called by CFSetup base class, for instance, when a user clicks back/forward to scan through settings pages, and when the settings are initially shown (if CF_initSetup() is used in the CFSetup constructor).

Parameters:

	page	Current settings page that is to be displayed.
	advanced	Flag indicating whether or not Advanced Settings are enabled.

void CF_setVisibleModal ( bool visible ) [inherited]

Sets whether a modal is visible.

void CF_setWindowState ( FormWindowState state ) [inherited]

Set Centrafuse window state.

void CF_startRecordVoice	(	int	mixerdevice,
		int	mixerinput,
		string	savetofile
	)			`[inherited]`

Start Record voice clip.

string CF_stopRecordVoice ( ) [inherited]

Stop Record voice clip.

void CF_systemCommand	(	CF_Actions	command,
		string	param1,
		string	param2,
		string	param3,
		string	param4
	)			`[inherited]`

Performs system command.

Parameters:

	command	System command.
	param1	Parameter one.
	param2	Parameter two.
	param3	Parameter three.
	param4	Parameter four.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		string	param2,
		out string	resultvalue,
		out string	resulttext,
		out object	resultobject,
		CFControls.CFListViewItem[]	listitems,
		bool	showfiles,
		bool	browseable,
		bool	showextension,
		bool	enablesubactions,
		bool	fireforwardback,
		bool	fireplusminus,
		int	display
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	param2	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.
	resultobject	Returns result object when available.
	listitems	Array of skinListboxItems to display, only used with CF_Dialogs.FileBrowser.
	showfiles	Determines whether to display files or just directories, only used with CF_Dialogs.FileBrowser.
	browseable	Determines whether CF_Dialogs.FileBrowser is browseable, only used with CF_Dialogs.FileBrowser.
	showextension	Determines whether to show file extensions, only used with CF_Dialogs.FileBrowser.
	enablesubactions	Determines whether the add and remove buttons are enabled, only used with CF_Dialogs.FileBrowser.
	fireforwardback	Determines whether to fire DialogResult events with forward/back buttons. Clicking forward is the same as selecting OK and clicking back will send DialogResult.Abort.
	fireplusminus	Determines whether to fire DialogResult events with plus/minus buttons. Clicking plus will send DialogResult.Yes and minus will send DialogResult.No.
	display	Determines which display to use.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		string	param2,
		out string	resultvalue,
		out string	resulttext,
		CFControls.CFListViewItem[]	listitems
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	param2	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.
	listitems	Array of skinListboxItems to display, only used with CF_Dialogs.FileBrowser.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		string	param2,
		out string	resultvalue,
		out string	resulttext,
		bool	showfiles,
		bool	browseable,
		bool	showextension,
		bool	enablesubactions
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	param2	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.
	showfiles	Determines whether to display files or just directories, only used with CF_Dialogs.FileBrowser.
	browseable	Determines whether CF_Dialogs.FileBrowser is browseable, only used with CF_Dialogs.FileBrowser.
	showextension	Determines whether to show file extensions, only used with CF_Dialogs.FileBrowser.
	enablesubactions	Determines whether the add and remove buttons are enabled, only used with CF_Dialogs.FileBrowser.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		string	param2,
		out string	resultvalue,
		out string	resulttext
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	param2	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		out string	resultvalue,
		out string	resulttext,
		bool	showfiles,
		bool	browseable,
		bool	showextension,
		bool	enablesubactions
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.
	showfiles	Determines whether to display files or just directories, only used with CF_Dialogs.FileBrowser.
	browseable	Determines whether CF_Dialogs.FileBrowser is browseable, only used with CF_Dialogs.FileBrowser.
	showextension	Determines whether to show file extensions, only used with CF_Dialogs.FileBrowser.
	enablesubactions	Determines whether the add and remove buttons are enabled, only used with CF_Dialogs.FileBrowser.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		string	param,
		out string	resultvalue,
		out string	resulttext
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	param	Extra parameter used by some dialogs.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext,
		out string	resultvalue,
		out string	resulttext
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.
	resultvalue	Returns result value when available.
	resulttext	Returns result text when available.

Returns:: Returns dialog result.

DialogResult CF_systemDisplayDialog	(	CF_Dialogs	dialog,
		string	displaytext
	)			`[inherited]`

Displays system dialog.

Parameters:

	dialog	Dialog to display.
	displaytext	Display text.

Returns:: Returns dialog result.

CF_Actions CF_systemGetCurrentLocation ( out string param1 ) [inherited]

Get current location.

Parameters:

param1

Will be populated with the plugin or application name, when current location is PLUGIN or EXTERNALAPP.

void CF_textToSpeech	(	string	text,
		bool	synchronous
	)			`[inherited]`

Converts text to speech.

void CF_textToSpeech ( string text ) [inherited]

Converts text to speech.

void CF_textToSpeechStop ( ) [inherited]

Stops text to speech.

void CF_updateBufferStatus	(	string	plugin,
		bool	buffermode
	)			`[inherited]`

Update buffer status.

void CF_updateButtonText	(	string	buttonName,
		string	text,
		bool	docaseconversion
	)			`[inherited]`

Sets button text.

Parameters:

	buttonName	Button name.
	text	New text.
	docaseconversion	Do case conversion (upper, lower, title) as set in font property.

void CF_updateButtonText	(	string	buttonName,
		string	text
	)			`[inherited]`

Sets button text.

Parameters:

	buttonName	Button name.
	text	New text.

void CF_updateText	(	string	labelName,
		string	text,
		bool	docaseconversion
	)			`[inherited]`

Sets label text.

Parameters:

	labelName	Label name.
	text	New text.
	docaseconversion	Flag to enable auto case conversion.

void CF_updateText	(	string	labelName,
		string	text
	)			`[inherited]`

Sets label text.

Parameters:

	labelName	Label name.
	text	New text.

void CF_writePluginLog	(	string	msg,
		bool	writemain
	)			`[protected, inherited]`

Writes plugin specific log.

Stored in plugin specific appdata directory, which is created by default the first time plugin calls CF3_initPlugin()

Parameters:

	msg	Log message to write to file.
	writemain	Write log message to main centrafuse.log in addition to plugin specific log.

void CF_writePluginLog ( string msg ) [protected, inherited]

Writes plugin specific log.

Stored in plugin specific appdata directory, which is created by default the first time plugin calls CF3_initPlugin()

Parameters:

msg

Log message to write to file.

delegate void CFAudioStreamDataChangeEventHandler	(	object	sender,
		CFTagInformation	e
	)			`[protected, inherited]`

Audio Stream Data Change Event Handler.

delegate void CFAudioStreamMessageChangeEventHandler	(	object	sender,
		string	e
	)			`[protected, inherited]`

Audio Stream Message Change Event Handler.

delegate void CFBufferStatusEventHandler	(	object	sender,
		CFBufferStatusArgs	e
	)			`[protected, inherited]`

Buffer Status Event Handler.

delegate void CFDriveEventHandler	(	object	sender,
		CFDriveEventArgs	e
	)			`[protected, inherited]`

Drive Event Handler.

delegate void CFPlaylistHandler	(	CFControls.CFListViewItem[]	playlist,
		bool	push
	)			`[protected, inherited]`

Playlist loaded Event Handler.

delegate void CFPowerModeChangedEventHandler	(	object	sender,
		CFPowerModeChangedEventArgs	e
	)			`[protected, inherited]`

Drive Event Handler.

DialogResult ShowDialog ( Form owner ) [inherited]

ShowDialog override used to set modal flag.

new DialogResult ShowDialog ( ) [inherited]

ShowDialog override used to set modal flag.

Member Data Documentation

CFControls.CFAdvancedList [] advancedlistArray = null [inherited]

Scroll Listview collection.

bool advancedSettingsOn = false [static]

Flag indicating whether or not Advanced Settings are enabled.

CFControls.CFButton [] buttonArray = null [inherited]

Button collection.

CFButtonIndexes [] buttonIndexes = null [protected, inherited]

Button index array.

int buttonLocation = 1 [inherited]

Current button location.

bool buttonSelected = false [inherited]

Currently selected button flag.

CFDisplayHooks CF_displayHooks [inherited]

Plugin instance display hooks.

CFEvents CF_events = null [protected, inherited]

Plugin instance centrafuse event handlers.

CFGlobalParams CF_globalParams = null [static, inherited]

Centrafuse static global parameters.

CFParams CF_params = null [inherited]

Plugin instance parameters.

CFControls.CFButton currButton = null [protected, inherited]

Currently selected button.

CFControls.CFLabel [] labelArray = null [inherited]

Label collection.

CFControls.CFListView [] listviewArray = null [inherited]

Listview collection.

CFControls.CFPanel [] panelArray = null [inherited]

Panel collection.

CFControls.CFPictureBox2 [] picturebox2Array = null [inherited]

PictureBox2 collection.

CFControls.CFPictureBox [] pictureboxArray = null [inherited]

Picture box collection.

internal ConfigReader pluginConfig = null [protected, inherited]

Configuration reader.

internal LanguageReader pluginLang = null [protected, inherited]

Language reader.

SkinReader pluginSkinReader = null [inherited]

Skin reader.

CFControls.CFPositionIndicator [] positionindicatorArray = null [inherited]

Position indicator collection.

CFControls.CFVis [] visArray = null [inherited]

Visualization collection.

Property Documentation

CFSetupHandler [] ButtonHandler [get, set, protected]

CFSetupHandler array containing the handlers that will be called when a settings button is clicked.

Array indexes correspond to (index + button number), i.e. ButtonHandler[0] is the handler called when Settings button 1 is clicked, ButtonHandler[5] is the handler called when Settings button 6 (on or off) is clicked, etc, etc...

string [] ButtonText [get, set, protected]

String array containing the text that will be displayed for each text button, the "setting name" per say.

string [] ButtonValue [get, set, protected]

String array containing the text value that will be displayed for each text button, the "setting value" per say.

For Buttons 1-4, this value will be a text value displayed withing the button itself. For Buttons 5-8, this value shall be "True", or "False", used to determine which of the On/Off buttons will be highlighted.

int currentButtonIndex [get, protected, inherited]

Gets current button index.

ICFMain MainForm [get, set, inherited]

Gets or sets main form.

new FormWindowState WindowState [get, set, inherited]

Gets or sets form WindowState.

Event Documentation

EventHandler CFSetup_cancel [protected]

Called when the Cancel button is clicked.

The plugin setup need not handle this event if there is no special processing needed.
If not handled, the base class will set DialogResult = DialogResult.Cancel.
If handled, the handler shall at least set DialogResult.Result to some DialogResult value, as required by the plugin.

EventHandler CFSetup_ok [protected]

Called when the OK button is clicked. The plugin setup need not handle this event if there is no special processing needed.
If not handled, the base CFSetup class will ask user if they wish to overwrite settings, and if user continues, will call pluginConfig.savePluginConfig() and pluginLang.savePluginLang() and then set DialogResult = DialogResult.OK.
If handled, the handler shall at least set DialogResult.Result to some DialogResult value, as required by the plugin.

CFSetup Class Reference

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Overview

Advanced and Basic Settings

The Setup constructor

The CF_setupReadSettings() Override

Settings Fields Button Handlers

OK and Cancel Button Handlers

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation