Plugin interface to NoteFly status: DRAFT (Subject to change) revision: 6 More...

Inheritance diagram for IPlugin.IPluginHost:

Public Member Functions
void	AddNoteDefaultSettings (string title, int skinnr, int x, int y, int width, int height, string content, bool wordwarp)
	Add a note with some default settings: Locked = false, RolledUp = false, Ontop = false, Visible = true More...

void	UpdateAllNoteForms ()
	Update all notes forms, in case some notefly application wide settings are changed. More...

string[]	GetSkinsNames ()
	Get a list of skin names More...

int	GetSkinNr (string skinname)
	Get the skin position in the list belong to a skinname. More...

string	GetSkinName (int skinnr)
	Get the skinname belonging to a particulair skin position. More...

Color	GetPrimaryClr (int skinnr)
	Get the primary color of a skin. More...

Color	GetSelectClr (int skinnr)
	Get the select color of a skin. More...

Color	GetHighlightClr (int skinnr)
	Get the highligh color of a skin. More...

Color	GetTextClr (int skinnr)
	Get the text color of a skin. More...

Bitmap	GetPrimaryTexture (int skinnr)
	Get the texture bitmap of a skin More...

string	GetPrimaryTextureFile (int skinnr)
	Get the texture filepath of a skin. More...

ImageLayout	GetPrimaryTextureLayout (int skinnr)
	Get the texture layout of a skin More...

void	ReloadAllSkins ()
	Remove all skins and load them all again from skins.xml. More...

string	GetSettingsFile ()
	Gets filepath to the settings file of NoteFly. More...

string	GetSkinsFile ()
	Gets filepath to the skins file of NoteFly. More...

string	GetNotesSavepath ()
	Get the notes save path of NoteFly More...

void	LogPluginInfo (string infomsg)
	Log info level information for a plugin to NoteFly logfile. More...

void	LogPluginError (string errormsg)
	Log error level information for a plugin to NoteFly login More...

string	GetAssemblyTitle ()
	Get the name of the program. More...

string	GetAssemblyVersionAsString ()
	Get the version of the program as string, in the form: major.minor.release version numbers More...

bool	GetSettingBool (string settingname)
	Get a NoteFly boolean setting. More...

int	GetSettingInt (string settingsname)
	Get a NoteFly integer setting. More...

float	GetSettingFloat (string settingsname)
	Get a NoteFly float setting. More...

string	GetSettingString (string settingsname)
	Get a NoteFly string setting. More...

string	GetInstallFolder ()
	Get the installation folder. More...

string	GetOS ()
	Get the operating system where this program is running on. More...

Properties
int	CountNotes `[get]`
	Gets the number of notes More...

int	CountSkins `[get]`
	Gets the number of skins More...

Detailed Description

Member Function Documentation

void IPlugin.IPluginHost.AddNoteDefaultSettings	(	string	title,
		int	skinnr,
		int	x,
		int	y,
		int	width,
		int	height,
		string	content,
		bool	wordwarp
	)

Parameters

title	The title of the note
skinnr	The skin position of note skin
x	X coordinate of the note on the screen
y	Y coordinate of the note on the screen
width	The width of the note.
height	The height of the note.
content	The content of the note.
wordwarp	Is the note content word warped.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetAssemblyTitle ( )

Returns: The assembly title.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetAssemblyVersionAsString ( )

Returns: The assembly version as string

Implemented in NoteFly.Notes.

Color IPlugin.IPluginHost.GetHighlightClr ( int skinnr )

Parameters

skinnr The skin position

Returns: Get skin hightlight color.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetInstallFolder ( )

Returns

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetNotesSavepath ( )

Returns: The notes save directory

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetOS ( )

Returns

Implemented in NoteFly.Notes.

Color IPlugin.IPluginHost.GetPrimaryClr ( int skinnr )

Parameters

skinnr Skin position

Returns: The skin primary color.

Implemented in NoteFly.Notes.

Bitmap IPlugin.IPluginHost.GetPrimaryTexture ( int skinnr )

Parameters

skinnr The skin position

Returns: The primary texture bitmap.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetPrimaryTextureFile ( int skinnr )

Parameters

skinnr The skin position

Returns: The primary texture file path.

Implemented in NoteFly.Notes.

ImageLayout IPlugin.IPluginHost.GetPrimaryTextureLayout ( int skinnr )

Parameters

skinnr The skin position

Returns: The primart texture imagelayout

Implemented in NoteFly.Notes.

Color IPlugin.IPluginHost.GetSelectClr ( int skinnr )

Parameters

skinnr The skin position

Returns: The select color of the skin.

Implemented in NoteFly.Notes.

bool IPlugin.IPluginHost.GetSettingBool ( string settingname )

Parameters

settingname The setting name to look the value for.

Returns: Boolean setting value.

Implemented in NoteFly.Notes.

float IPlugin.IPluginHost.GetSettingFloat ( string settingsname )

Parameters

settingsname The setting name to look the value for.

Returns: Float setting value.

Implemented in NoteFly.Notes.

int IPlugin.IPluginHost.GetSettingInt ( string settingsname )

Parameters

settingsname The setting name to look the value for.

Returns: Integer setting value.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetSettingsFile ( )

Returns: The settings file path

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetSettingString ( string settingsname )

Parameters

settingsname The setting name to look the value for.

Returns: String setting value.

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetSkinName ( int skinnr )

Parameters

skinnr Skin position

Returns: The name of the skin

Implemented in NoteFly.Notes.

int IPlugin.IPluginHost.GetSkinNr ( string skinname )

Parameters

skinname The name of the skin to get the position from

Returns: The skin position

Implemented in NoteFly.Notes.

string IPlugin.IPluginHost.GetSkinsFile ( )

Returns: The skins file path

Implemented in NoteFly.Notes.

string [] IPlugin.IPluginHost.GetSkinsNames ( )

Returns: A string array of all skin names loaded.

Implemented in NoteFly.Notes.

Color IPlugin.IPluginHost.GetTextClr ( int skinnr )

Parameters

skinnr The skin position

Returns: The skin text color.

Implemented in NoteFly.Notes.

void IPlugin.IPluginHost.LogPluginError ( string errormsg )

Parameters

errormsg The error message to log

Implemented in NoteFly.Notes.

void IPlugin.IPluginHost.LogPluginInfo ( string infomsg )

Parameters

infomsg The info message to log

Implemented in NoteFly.Notes.

void IPlugin.IPluginHost.ReloadAllSkins ( )

Implemented in NoteFly.Notes.

void IPlugin.IPluginHost.UpdateAllNoteForms ( )

Implemented in NoteFly.Notes.

Property Documentation

int IPlugin.IPluginHost.CountNotes

get

int IPlugin.IPluginHost.CountSkins

get

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation