62 lines
3.2 KiB
C#
62 lines
3.2 KiB
C#
// Copyright (C) 2024, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
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);
|
|
}
|
|
}
|