ShiftOS.WinForms/IDesktopWidget.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using ShiftOS.Engine;

namespace ShiftOS.WinForms
{
    /// <summary>
    /// Provides base functionality for a ShiftOS desktop widget.
    /// </summary>
    public interface IDesktopWidget
    {
        /// <summary>
        /// Performs routine setup operations to keep the widget up to date.
        /// </summary>
        void Setup();

        /// <summary>
        /// Occurs when a skin is loaded.
        /// </summary>
        void OnSkinLoad();

        /// <summary>
        /// Occurs when a Shiftorium upgrade is installed.
        /// </summary>
        void OnUpgrade();

        /// <summary>
        /// Hides this desktop widget.
        /// </summary>
        void Hide();

        /// <summary>
        /// Shows this desktop widget.
        /// </summary>
        void Show();

        /// <summary>
        /// Gets or sets the location on the desktop that this widget resides.
        /// </summary>
        Point Location { get; set; }

        /// <summary>
        /// Gets or sets this widget's size.
        /// </summary>
        Size Size { get; set; }
    }
}