C# Class KeyboardEditor.KeyboardEditor

Inheritance: IPlugin, IKeyboardEditorRoot
Mostra file Open project: Invenietis/ck-certified

Public Properties

Property Type Description
PluginId INamedVersionedUniqueId

Private Properties

Property Type Description
GenerateBackupFileName string
OnHookInvoqued void
OnWindowClosing void

Public Methods

Method Description
BackupKeyboard ( IKeyboard keyboardToBackup ) : string

Backs up a keyboard. Returns the file path where the keyboard has been backed up. Throws a CKException if the IKeyboard implementation is not IStructuredSerializable

CancelModifications ( ) : void

Cancels all modifications made to the keyboard being currently modified Throws a NullReferenceException if KeyboardBackup is null.

EnsureBackupIsClean ( ) : void

Deletes the backup file if it exists sets KeyboardBackup to null

GetDefaultHelp ( ) : Stream
Save ( ) : void
Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
ShowHelp ( ) : void
Start ( ) : void
Stop ( ) : void
Teardown ( ) : void

Private Methods

Method Description
GenerateBackupFileName ( ) : string
OnHookInvoqued ( object sender, HookInvokedEventArgs e ) : void
OnWindowClosing ( object sender, System e ) : void

Method Details

BackupKeyboard() public method

Backs up a keyboard. Returns the file path where the keyboard has been backed up. Throws a CKException if the IKeyboard implementation is not IStructuredSerializable
public BackupKeyboard ( IKeyboard keyboardToBackup ) : string
keyboardToBackup IKeyboard The keyboard ot backup
return string

CancelModifications() public method

Cancels all modifications made to the keyboard being currently modified Throws a NullReferenceException if KeyboardBackup is null.
public CancelModifications ( ) : void
return void

EnsureBackupIsClean() public method

Deletes the backup file if it exists sets KeyboardBackup to null
public EnsureBackupIsClean ( ) : void
return void

GetDefaultHelp() public method

public GetDefaultHelp ( ) : Stream
return Stream

Save() public method

public Save ( ) : void
return void

Setup() public method

public Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
info CK.Plugin.IPluginSetupInfo
return bool

ShowHelp() public method

public ShowHelp ( ) : void
return void

Start() public method

public Start ( ) : void
return void

Stop() public method

public Stop ( ) : void
return void

Teardown() public method

public Teardown ( ) : void
return void

Property Details

PluginId public_oe static_oe property

public static INamedVersionedUniqueId PluginId
return INamedVersionedUniqueId