documentation.

This commit is contained in:
2019-01-14 00:34:35 -06:00
parent 32c2f25196
commit 40c7772559
15 changed files with 315 additions and 56 deletions

View File

@@ -3,11 +3,24 @@ using System;
namespace RecrownedAthenaeum.UI.Skin.Definitions
{
/// <summary>
/// Definition for a button.
/// </summary>
public class ButtonSkinDefinition : ISkinDefinition
{
/// <summary>
/// Names for the regions in the texture atlas respectively.
/// </summary>
public string upRegion, downRegion, disabledRegion, selectedRegion;
///<inheritDoc/>
public Type UIModuleType { get { return typeof(Button); } }
/// <summary>
/// Constructs the definition with minimum requirements.
/// </summary>
/// <param name="downRegion">Name of region specifying the texture shown for when the button is pressed down.</param>
/// <param name="upRegion">Name of region specifying the texture shown for when the button is not pressed.</param>
public ButtonSkinDefinition(string downRegion, string upRegion)
{
this.downRegion = downRegion;

View File

@@ -2,8 +2,14 @@
namespace RecrownedAthenaeum.UI.Skin.Definitions
{
/// <summary>
/// A definition for the skin system.
/// </summary>
public interface ISkinDefinition
{
/// <summary>
/// The module type this definition is definining.
/// </summary>
Type UIModuleType { get; }
}
}