Canvas.cs

using Ndapi.Core;
using Ndapi.Core.Handles;
using Ndapi.Enums;

namespace Ndapi;

/// <summary>
/// Represents a canvas object.
/// </summary>
public class Canvas : NdapiObject<Canvas>
{
    /// <summary>
    /// Creates a canvas object.
    /// </summary>
    /// <param name="module">Canvas owner.</param>
    /// <param name="name">Canvas name.</param>
    public Canvas(FormModule module, string name) : base(name, ObjectType.Canvas, module)
    {
    }

    /// <summary>
    /// Creates a canvas object.
    /// </summary>
    /// <param name="group">Canvas owner.</param>
    /// <param name="name">Canvas name.</param>
    public Canvas(ObjectGroup group, string name) : base(name, ObjectType.Canvas, group)
    {
    }

    internal Canvas(ObjectSafeHandle handle) : base(handle, ObjectType.Canvas)
    {
    }

    /// <summary>
    /// Gets or sets the background color.
    /// </summary>
    [Property(NdapiConstant.D2FP_BACK_COLOR)]
    public string BackgroundColor
    {
        get => GetStringProperty(NdapiConstant.D2FP_BACK_COLOR);
        set => SetStringProperty(NdapiConstant.D2FP_BACK_COLOR, value);
    }

    /// <summary>
    /// Gets or sets the appearance of the object border.
    /// </summary>
    [Property(NdapiConstant.D2FP_BEVEL)]
    public Bevel Bevel
    {
        get => GetNumberProperty<Bevel>(NdapiConstant.D2FP_BEVEL);
        set => SetNumberProperty(NdapiConstant.D2FP_BEVEL, value);
    }

    /// <summary>
    /// Gets or sets the canvas type.
    /// </summary>
    [Property(NdapiConstant.D2FP_CNV_TYP)]
    public CanvasType CanvasType
    {
        get => GetNumberProperty<CanvasType>(NdapiConstant.D2FP_CNV_TYP);
        set => SetNumberProperty(NdapiConstant.D2FP_CNV_TYP, value);
    }

    /// <summary>
    /// Gets or sets the comment.
    /// </summary>
    [Property(NdapiConstant.D2FP_COMMENT)]
    public string Comment
    {
        get => GetStringProperty(NdapiConstant.D2FP_COMMENT);
        set => SetStringProperty(NdapiConstant.D2FP_COMMENT, value);
    }

    /// <summary>
    /// Gets or sets the pattern to be used for the fill region.
    /// Patterns are rendered in the two colors specified by <see cref="BackgroundColor"/> and <see cref="ForegroundColor"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_FILL_PAT)]
    public string FillPattern
    {
        get => GetStringProperty(NdapiConstant.D2FP_FILL_PAT);
        set => SetStringProperty(NdapiConstant.D2FP_FILL_PAT, value);
    }

    /// <summary>
    /// Gets or sets the font name.
    /// </summary>
    [Property(NdapiConstant.D2FP_FONT_NAM)]
    public string FontName
    {
        get => GetStringProperty(NdapiConstant.D2FP_FONT_NAM);
        set => SetStringProperty(NdapiConstant.D2FP_FONT_NAM, value);
    }

    /// <summary>
    /// Gets or sets the font size.
    /// </summary>
    [Property(NdapiConstant.D2FP_FONT_SIZ)]
    public int FontSize
    {
        get => GetNumberProperty(NdapiConstant.D2FP_FONT_SIZ);
        set => SetNumberProperty(NdapiConstant.D2FP_FONT_SIZ, value);
    }

    /// <summary>
    /// Gets or sets the font spacing.
    /// </summary>
    [Property(NdapiConstant.D2FP_FONT_SPCING)]
    public FontSpacing FontSpacing
    {
        get => GetNumberProperty<FontSpacing>(NdapiConstant.D2FP_FONT_SPCING);
        set => SetNumberProperty(NdapiConstant.D2FP_FONT_SPCING, value);
    }

    /// <summary>
    /// Gets or sets the font style.
    /// </summary>
    [Property(NdapiConstant.D2FP_FONT_STY)]
    public FontStyle FontStyle
    {
        get => GetNumberProperty<FontStyle>(NdapiConstant.D2FP_FONT_STY);
        set => SetNumberProperty(NdapiConstant.D2FP_FONT_STY, value);
    }

    /// <summary>
    /// Gets or sets the font weight.
    /// </summary>
    [Property(NdapiConstant.D2FP_FONT_WGHT)]
    public FontWeight FontWeight
    {
        get => GetNumberProperty<FontWeight>(NdapiConstant.D2FP_FONT_WGHT);
        set => SetNumberProperty(NdapiConstant.D2FP_FONT_WGHT, value);
    }

    /// <summary>
    /// Gets or sets the foreground color.
    /// </summary>
    [Property(NdapiConstant.D2FP_FORE_COLOR)]
    public string ForegroundColor
    {
        get => GetStringProperty(NdapiConstant.D2FP_FORE_COLOR);
        set => SetStringProperty(NdapiConstant.D2FP_FORE_COLOR, value);
    }

    /// <summary>
    /// Gets or sets the height.
    /// </summary>
    [Property(NdapiConstant.D2FP_HEIGHT)]
    public int Height
    {
        get => GetNumberProperty(NdapiConstant.D2FP_HEIGHT);
        set => SetNumberProperty(NdapiConstant.D2FP_HEIGHT, value);
    }

    /// <summary>
    /// Gets or sets the associated help book topic.
    /// </summary>
    [Property(NdapiConstant.D2FP_HELP_BOOK_TOPIC)]
    public string HelpBookTopic
    {
        get => GetStringProperty(NdapiConstant.D2FP_HELP_BOOK_TOPIC);
        set => SetStringProperty(NdapiConstant.D2FP_HELP_BOOK_TOPIC, value);
    }

    /// <summary>
    /// Gets or sets the language direction.
    /// </summary>
    [Property(NdapiConstant.D2FP_LANG_DIR)]
    public LanguageDirection LanguageDirection
    {
        get => GetNumberProperty<LanguageDirection>(NdapiConstant.D2FP_LANG_DIR);
        set => SetNumberProperty(NdapiConstant.D2FP_LANG_DIR, value);
    }

    /// <summary>
    /// Gets or sets the name of the popup object.
    /// </summary>
    [Property(NdapiConstant.D2FP_POPUP_MNU_NAM)]
    public string PopupMenuName
    {
        get => GetStringProperty(NdapiConstant.D2FP_POPUP_MNU_NAM);
        set => SetStringProperty(NdapiConstant.D2FP_POPUP_MNU_NAM, value);
    }

    /// <summary>
    /// Gets or sets whether runtime should display the canvas when the end user or the application
    /// navigates to an item on the canvas. 
    /// This property is valid only when the <see cref="CanvasType"/> is set to <see cref="CanvasType.Tab"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_RAISE_ON_ENT)]
    public bool RaiseOnEntry
    {
        get => GetBooleanProperty(NdapiConstant.D2FP_RAISE_ON_ENT);
        set => SetBooleanProperty(NdapiConstant.D2FP_RAISE_ON_ENT, value);
    }

    /// <summary>
    /// Gets or sets the location where tabs are attached to a tab canvas.
    /// </summary>
    [Property(NdapiConstant.D2FP_TAB_ATT_EDGE)]
    public TabAttachmentEdge TabAttachmentEdge
    {
        get => GetNumberProperty<TabAttachmentEdge>(NdapiConstant.D2FP_TAB_ATT_EDGE);
        set => SetNumberProperty(NdapiConstant.D2FP_TAB_ATT_EDGE, value);
    }

    /// <summary>
    /// Gets or sets the tab style.
    /// </summary>
    [Property(NdapiConstant.D2FP_TAB_STY)]
    public TabStyle TabStyle
    {
        get => GetNumberProperty<TabStyle>(NdapiConstant.D2FP_TAB_STY);
        set => SetNumberProperty(NdapiConstant.D2FP_TAB_STY, value);
    }

    /// <summary>
    /// Gets or sets the visual attribute name.
    /// </summary>
    [Property(NdapiConstant.D2FP_VAT_NAM)]
    public string VisualAttributeName
    {
        get => GetStringProperty(NdapiConstant.D2FP_VAT_NAM);
        set => SetStringProperty(NdapiConstant.D2FP_VAT_NAM, value);
    }

    /// <summary>
    /// Gets or sets whether the canvas is initially shown or hidden in the window to which it is assigned.
    /// This property is valid only when the <see cref="CanvasType"/> is set to <see cref="CanvasType.Stacked"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_VISIBLE)]
    public bool IsVisible
    {
        get => GetBooleanProperty(NdapiConstant.D2FP_VISIBLE);
        set => SetBooleanProperty(NdapiConstant.D2FP_VISIBLE, value);
    }

    /// <summary>
    /// Gets or sets the viewport height.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_HGT)]
    public int ViewportHeight
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_HGT);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_HGT, value);
    }

    /// <summary>
    /// Gets or sets the viewport width.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_WID)]
    public int ViewportWidth
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_WID);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_WID, value);
    }

    /// <summary>
    /// Gets or sets the X position of canvas's upper left corner relative to the upper left corner of the window's current content view. 
    /// This property is valid only when the <see cref="CanvasType"/> is set to <see cref="CanvasType.Stacked"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_X_POS)]
    public int ViewportXPosition
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_X_POS);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_X_POS, value);
    }

    /// <summary>
    /// Gets or sets the X position of the view's upper left corner relative to the upper left corner of the canvas.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_X_POS_ON_CNV)]
    public int ViewportXPositionOnCanvas
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_X_POS_ON_CNV);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_X_POS_ON_CNV, value);
    }

    /// <summary>
    /// Gets or sets the Y position of canvas's upper left corner relative to the upper left corner of the window's current content view. 
    /// This property is valid only when the <see cref="CanvasType"/> is set to <see cref="CanvasType.Stacked"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_Y_POS)]
    public int ViewportYPosition
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_Y_POS);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_Y_POS, value);
    }

    /// <summary>
    /// Gets or sets the Y position of the view's upper left corner relative to the upper left corner of the canvas.
    /// </summary>
    [Property(NdapiConstant.D2FP_VPRT_Y_POS_ON_CNV)]
    public int ViewportYPositionOnCanvas
    {
        get => GetNumberProperty(NdapiConstant.D2FP_VPRT_Y_POS_ON_CNV);
        set => SetNumberProperty(NdapiConstant.D2FP_VPRT_Y_POS_ON_CNV, value);
    }

    /// <summary>
    /// Gets or sets the white-on-black property.
    /// </summary>
    [Property(NdapiConstant.D2FP_WHITE_ON_BLACK)]
    public bool IsWhiteOnBlack
    {
        get => GetBooleanProperty(NdapiConstant.D2FP_WHITE_ON_BLACK);
        set => SetBooleanProperty(NdapiConstant.D2FP_WHITE_ON_BLACK, value);
    }

    /// <summary>
    /// Gets or sets the width.
    /// </summary>
    [Property(NdapiConstant.D2FP_WIDTH)]
    public int Width
    {
        get => GetNumberProperty(NdapiConstant.D2FP_WIDTH);
        set => SetNumberProperty(NdapiConstant.D2FP_WIDTH, value);
    }

    /// <summary>
    /// Gets or sets the window in which the canvas will be displayed at runtime.
    /// </summary>
    [Property(NdapiConstant.D2FP_WND_OBJ)]
    public Window Window
    {
        get => GetObjectProperty<Window>(NdapiConstant.D2FP_WND_OBJ);
        set => SetObjectProperty(NdapiConstant.D2FP_WND_OBJ, value);
    }

    /// <summary>
    /// Gets or sets the window name in which the canvas will be displayed at runtime.
    /// </summary>
    [Property(NdapiConstant.D2FP_WND_NAM)]
    public string WindowName
    {
        get => GetStringProperty(NdapiConstant.D2FP_WND_NAM);
        set => SetStringProperty(NdapiConstant.D2FP_WND_NAM, value);
    }

    /// <summary>
    /// Gets or sets the side of the canvas from where the gradient color begins
    /// or that there should be no gradient color used.
    /// </summary>
    [Property(NdapiConstant.D2FP_GRADIENT_START)]
    public GradientStartSide GradientStartSide
    {
        get => GetNumberProperty<GradientStartSide>(NdapiConstant.D2FP_GRADIENT_START);
        set => SetNumberProperty(NdapiConstant.D2FP_GRADIENT_START, value);
    }

    /// <summary>
    /// Gets all the graphics objects attached to the canvas.
    /// </summary>
    [Property(NdapiConstant.D2FP_GRAPHIC)]
    public NdapiObjectList<Graphics> Graphics =>
        GetObjectList<Graphics>(NdapiConstant.D2FP_GRAPHIC);

    /// <summary>
    /// Gets all the tab pages associated with the current canvas.
    /// This property is valid only when the <see cref="CanvasType"/> is set to <see cref="CanvasType.Tab"/>.
    /// </summary>
    [Property(NdapiConstant.D2FP_TAB_PAGE)]
    public NdapiObjectList<TabPage> TabPages =>
        GetObjectList<TabPage>(NdapiConstant.D2FP_TAB_PAGE);

    /// <summary>
    /// Creates a child graphics.
    /// </summary>
    /// <param name="name">Name of the child graphics.</param>
    /// <returns>The child object.</returns>
    public Graphics CreateGraphics(string name) => new(this, name);

    /// <summary>
    /// Creates a tab page.
    /// </summary>
    /// <param name="name">Name of the tab page.</param>
    /// <returns>The child object.</returns>
    public TabPage CreateTabPage(string name) => new(this, name);
}