/
EFeatureDisplayType.cs
38 lines (35 loc) · 1.44 KB
/
EFeatureDisplayType.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
namespace HomeSeer.PluginSdk.Devices {
/// <summary>
/// <para>
/// The display type for a <see cref="HsFeature"/>.
/// This controls the way a feature and its controls are displayed in the HomeSeer UI.
/// </para>
/// </summary>
/// <remarks>
/// <para>While in grid view:</para>
/// <para>
/// When there are sibling features set as <see cref="Important"/>, <see cref="Normal"/> features will be shown in the status bar.
/// When there are no sibling features set as <see cref="Important"/>, all <see cref="Normal"/> features will be analyzed
/// to determine a single <see cref="Important"/> feature to display.
/// </para>
/// <para>While in list view:</para>
/// <para>
/// <see cref="HsFeature"/>s are displayed <see cref="Important"/> first and then <see cref="Normal"/>.
/// </para>
/// <para> The term 'sibling features' refers to features that are a part of the same device. </para>
/// </remarks>
public enum EFeatureDisplayType {
/// <summary>
/// Do not apply any special display behavior to the <see cref="HsFeature"/>.
/// </summary>
Normal = 0,
/// <summary>
/// Prioritize the display of this <see cref="HsFeature"/> and its controls.
/// </summary>
Important = 1,
/// <summary>
/// Hide the <see cref="HsFeature"/> in grid view and list view.
/// </summary>
Hidden = 2
}
}