Files
duplicati/Duplicati/Library/Interface/ISettingsControl.cs
T
kenneth.skovhede@gmail.com a40f6acf37 A fairly large refactoring of the code.
This was based on the idea that the interfaces should remain static.
I hope this change is enough to ensure stable interfaces until release 1.2.

Overview of changes:
Moved all interfaces into the same dll.
Encryption and compression is now plugable modules, just as the backends.
Encryption/compression can now register an UI.
Encryption now uses AESCrypt as a default.
GPG does not default to using the --armor option.
Added support for generic modules, but none are written yet.
Added support for plugable settings pages in the "Options" dialog.

Fixed issue #148.
Duplicati now uses AESCrypt as the default encryption format.

Fixed issue #199.
GPG now supports custom commandline options.

Fixed issue #207.
Encryption modules are now plugable.

Fixed issue #118.
S3 credentials are now stored.

Fixed issue #151.
Backends can now register system wide options.


git-svn-id: https://duplicati.googlecode.com/svn/trunk@427 59da171f-624f-0410-aa54-27559c288bec
2010-06-19 21:08:21 +00:00

41 lines
2.0 KiB
C#

using System;
using System.Collections.Generic;
using System.Text;
namespace Duplicati.Library.Interface
{
/// <summary>
/// An interface for modules that register a control in the settings menu.
/// This control will be placed in a tab page.
/// The <see cref="GetConfiguration"/> method is invoked for each custom control module when generating a backup.
/// When editing/creating a backup job, the <see cref="BeginEdit"/> and <see cref="EndEdit"/> functions are invoked.
/// </summary>
public interface ISettingsControl : IGUIControl
{
/// <summary>
/// Gets a key that uniquely identifies the control
/// </summary>
string Key { get; }
/// <summary>
/// Called when the user is editing or creating a backup.
/// This method can alter the applicationSettings environment and thus communicate with another UI plugin,
/// such as an <see cref="IBackendGUI"/> or <see cref="IEncryptionGUI"/>.
/// </summary>
/// <param name="applicationSettings">The application settings</param>
/// <param name="guiOptions">The options saved earlier when configuring the control</param>
void BeginEdit(IDictionary<string, string> applicationSettings, IDictionary<string, string> guiOptions);
/// <summary>
/// Called when the user has finished editing or creating a backup.
/// This method can be used to alter the <see cref="guiOptions"/> collection,
/// and thus persist a change.
/// As the other elements can also modify the <see cref="applicationSettings"/> collection,
/// this can be used to communicate changes from another component.
/// </summary>
/// <param name="applicationSettings">The application settings</param>
/// <param name="guiOptions">The options saved earlier when configuring the control</param>
void EndEdit(IDictionary<string, string> applicationSettings, IDictionary<string, string> guiOptions);
}
}