xenadmin/XenAdmin/SettingsPanels/IEditPage.cs
Mihaela Stoica bd36a85bff CP-4816: Initial commit to git repo
Signed-off-by: Mihaela Stoica <mihaela.stoica@citrix.com>
2013-06-24 12:41:48 +01:00

77 lines
3.3 KiB
C#

/* Copyright (c) Citrix Systems Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms,
* with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
using System;
using XenAdmin.Actions;
using System.Drawing;
using XenAdmin.Controls;
using XenAPI;
using System.ComponentModel;
namespace XenAdmin.SettingsPanels
{
public interface IEditPage : VerticalTabs.VerticalTab
{
/** Each page's SaveSettings() can do two things:
* 1) Edit the cloned XenObject (which is a clone of the one in the cache)
* for simple field changes;
* 2) Return an AsyncAction for later or more complicated actions.
* When the user clicks OK on the PropertiesDialog, we run SaveSettings
* for each page. We then save all changes to the XenModelObject from step (1).
* Finally we execute each of the actions we have collected from step (2).
* Because we are expecting things to happen in that order, the SaveSettings()
* should not make any API calls itself: it should put them in its returned action.
*/
AsyncAction SaveSettings();
/** Sets the control's active object to match the current selection.
* Most actions should be carried out on the cloned object, which is guaranteed
* not to change while the dialog is open. Most pages therefore ignore the orig
* object, but some delegates from SaveSettings() need to know it too.
*/
void SetXenObjects(IXenObject orig, IXenObject clone);
/** Performs local validation on the fields in the control and lets the
* user know if it is ok to save the XenObject.
*/
bool ValidToSave { get; }
/** Show local validation balloon tooltips */
void ShowLocalValidationMessages();
/** Unregister listeners, dispose balloon tooltips, etc. */
void Cleanup();
/** Have any of the fields in the view changed since init? */
bool HasChanged { get; }
}
}