xenadmin/XenAdmin/TabPages/NotificationsBasePage.cs

/* Copyright (c) Cloud Software Group, Inc. 
 * 
 * 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 System.Windows.Forms;
using XenAdmin.Controls.MainWindowControls;
using XenAdmin.Help;

namespace XenAdmin.TabPages
{
    public class NotificationsBasePage : UserControl, IControlWithHelp
    {
        public event Action FiltersChanged;

        protected void OnFiltersChanged()
        {
            FiltersChanged?.Invoke();
        }

        protected virtual void RefreshPage()
        { }

        protected virtual void RegisterEventHandlers()
        { }

        protected virtual void DeregisterEventHandlers()
        { }

        public void ShowPage()
        {
            Visible = true;
            RefreshPage();
            RegisterEventHandlers();
        }

        public void HidePage()
        {
            Visible = false;
            DeregisterEventHandlers();
        }

        public virtual NotificationsSubMode NotificationsSubMode { get; }

        public virtual string HelpID => "";

        public virtual bool FilterIsOn => false;
    }
}