Interfaces.cs

// =============================================================================
// GPAL - Generally Positive Automation Library
// Copyright © 2026 Software Decisions, Inc. All rights reserved.
//
// This file is part of GPAL.
// Licensed under the Business Source License 1.1
//
// Primary development, architecture, and vision by Michael B. Vederman,
// CEO of Software Decisions, Inc., Texas.
//
// Internal development maintained privately.
// Public releases appear on GitHub: https://github.com/SoftwareDecisionsInc/GPAL.
//
// See LICENSE for full terms, including Additional Use Grant.
// =============================================================================
 
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using OpenQA.Selenium;
using GenerallyPositive.Browser;
using static GenerallyPositive.GPALForm.GPALForm;
using static GenerallyPositive.Enums;
using static GenerallyPositive.GPAL;
using System.Windows.Forms.DataVisualization.Charting;
using System.Windows.Forms;
using System.Data;
 
namespace GenerallyPositive.GPALForm
{
    #region <FormInterfaces>
    public interface IAllowDefault
    {
        IAllowControlSettingsEnabledAndDefault Default { get; }
    }
    public interface IAllowFillInFrom
    {
        IAllowFormSettingsAndActions FillInFrom(GPALFile inputFile);
        IAllowFormSettingsAndActions AppendFrom(GPALFile inputFile);
        IAllowFormSettingsAndActions InsertFrom(GPALFile inputFile);
 
        IAllowFormSettingsAndActions FillInFrom(GPALDatabase inputDatabase);
        IAllowFormSettingsAndActions AppendFrom(GPALDatabase inputDatabase);
        IAllowFormSettingsAndActions InsertFrom(GPALDatabase inputDatabase);
 
        IAllowFormSettingsAndActions FillInFrom(IGPALGrid<string> inputGrid);
        IAllowFormSettingsAndActions AppendFrom(IGPALGrid<string> inputGrid);
        IAllowFormSettingsAndActions InsertFrom(IGPALGrid<string> inputGrid);
    }
    public interface IAllowChartSettings
    {
        IAllowControlSettingsAndChartSettings WithSeries(Series series);
        IAllowControlSettingsAndChartSettings WithPalette(ChartColorPalette colorPalette);
        IAllowControlSettingsAndChartSettings WithTitle(string title);
    }
    public interface IAllowDataGridViewSettings
    {
        IAllowControlSettingsAndDataGridViewSettings WithDatatable(DataTable dataTable);
        IAllowControlSettingsAndDataGridViewSettings WithSelectSQL(string selectSQL);
        IAllowControlSettingsAndDataGridViewSettings WithUpdateSQL(string updateSQL);
        IAllowControlSettingsAndDataGridViewSettings WithDeleteSQL(string deleteSQL);
        IAllowControlSettingsAndDataGridViewSettings WithColumns(int columns);
        IAllowControlSettingsAndDataGridViewSettings WithRows(int rows);
    }
    public interface IAllowDataGridViewActions : IAllowFillInFrom
    {
        IAllowControlAndDataGridViewSettingsAndActions WithCurrentCelll(DataGridViewCell dataGridCell);
        IAllowControlAndDataGridViewSettingsAndActions WithEndColumn(int column);   // for range operations
        IAllowControlAndDataGridViewSettingsAndActions WithEndRow(int row);   // for range operations
        IAllowControlAndDataGridViewSettingsAndActions GetGrid(out IGPALGrid<string> grid);
    }
    public interface IAllowFontSettings
    {
        IAllowControlSettingsAndFontSettings WithFont(Font font);
        IAllowControlSettingsAndFontSettings WithTextAlignment(ContentAlignment contentAlignment);
        IAllowControlSettingsAndFontSettings WithAutoSize(bool autoSize);
    }
    public interface IAllowControlSettings
    {
        IAllowForEventControlSettings WithCallback<TDelegate>(TDelegate handler)
            where TDelegate : Delegate;
        [Settings(Description = "Attach a handler that runs off the UI thread, so the form keeps painting while it works. GPAL controls set from it marshal back on their own.")]
        IAllowForEventControlSettings WithCallbackOffUIThread<TDelegate>(TDelegate handler)
            where TDelegate : Delegate;
        IAllowControlSettings WithHeight(int height);
        IAllowControlSettings WithName(string name);
        IAllowControlSettings WithTag(object tag);
        IAllowControlSettings WithAlignment(ContentAlignment alignment);
        IAllowControlSettingsAndFontSettings WithText(string textToUse);
        IAllowControlSettings WithShortcutKey(System.Windows.Forms.Keys shortCutKey);
        IAllowToolTipDelay WithToolTip(string toolTipText);
        dynamic ToGPALObject();
    }
    public interface IAllowForEventControlSettings: IAllowControlSettings
    {
        IAllowControlSettings ForEvent(ControlEventType eventType);
    }
    public interface IAllowFileSelectorControlSettings : IAllowControlSettings
    {
        IAllowFileSelectorControlSettings WithTitle(string title);
        IAllowFileSelectorControlSettings WithInitialDirectory(string path);
        IAllowFileSelectorControlSettings WithFilter(string filter);
        IAllowFileSelectorControlSettings WithSelectFolder(bool folderMode);
        IAllowFileSelectorControlSettings WithMultiSelect(bool allowMulti);
        IAllowFileSelectorControlSettings WithCompact(bool compact);
        IAllowFileSelectorControlSettings WithPlaceholder(string placeholder);
    }
    public interface IAllowSplitterControlSettings : IAllowControlSettings
    {
        IAllowSplitterControlSettings HSplit(int leftWidth);
        IAllowSplitterControlSettings HSplit(double leftPercent);
        IAllowSplitterControlSettings VSplit(int topHeight);
        IAllowSplitterControlSettings VSplit(double topPercent);
        IAllowSplitterControlSettings WithFormControl(object gPALFormControl);
        // the base one hands back IAllowControlSettings, which has neither the panes nor a typed ToGPALObject, so
        // a splitter given a height would come out of the chain as dynamic and only fail once the form is built
        new IAllowSplitterControlSettings WithHeight(int height);
        new GPALSplitter ToGPALObject();
    }
    public interface IAllowGroupBoxControlSettings : IAllowControlSettings
    {
        new IAllowGroupBoxControlSettings WithText(string text);
        IAllowGroupBoxControlSettings WithFormControl(object gPALFormControl);
        new GPALGroupBox ToGPALObject();
    }
    public interface IAllowTreeViewControlSettings : IAllowControlSettings
    {
        IAllowTreeViewControlSettings WithCheckBoxes(bool enable);
        IAllowTreeViewControlSettings WithShowLines(bool show);
        IAllowTreeViewControlSettings WithShowPlusMinus(bool show);
    }
    public interface IAllowDateTimePickerControlSettings : IAllowControlSettings
    {
        IAllowDateTimePickerControlSettings WithValue(DateTime value);
        IAllowDateTimePickerControlSettings WithFormat(DateTimePickerFormat format);
        IAllowDateTimePickerControlSettings WithCustomFormat(string formatString);
    }
    public interface IAllowNumericUpDownControlSettings : IAllowControlSettings
    {
        IAllowNumericUpDownControlSettings WithValue(decimal value);
        IAllowNumericUpDownControlSettings WithMinimum(decimal min);
        IAllowNumericUpDownControlSettings WithMaximum(decimal max);
        IAllowNumericUpDownControlSettings WithIncrement(decimal inc);
        IAllowNumericUpDownControlSettings WithDecimalPlaces(int places);
    }
    public interface IAllowListVIewControlSettings : IAllowControlSettings
    {
        IAllowListVIewControlSettings WithColumns(params string[] headers);
        IAllowListVIewControlSettings WithCheckBoxes(bool enable = true);
        IAllowListVIewControlSettings WithView(ListViewMode view);
        IAllowListVIewControlSettings WithFullRowSelect(bool enable);
        IAllowListVIewControlSettings WithMultiSelect(bool enable);
        IAllowListVIewControlSettings WithColumnWeight(double weight);
        IAllowListVIewControlSettings WithSortable(bool sortable = true);
    }
    public interface IAllowStatusStripControlSettings : IAllowControlSettings
    {
        new IAllowStatusStripControlSettings WithText(string text);
    }
    public interface IAllowMenuBarControlSettings : IAllowControlSettings
    {
        IAllowMenuBarControlSettings WithMenu(string topMenu);
        IAllowMenuBarControlSettings WithItem(GPALBarItem item);
        IAllowMenuBarControlSettings WithSeparator();
    }
    public interface IAllowToolbarControlSettings : IAllowControlSettings
    {
        IAllowToolbarControlSettings WithItem(GPALBarItem item);
        IAllowToolbarControlSettings WithSeparator();
    }
    public interface IAllowBarItemSettings : IAllowControlSettings
    {
        new IAllowBarItemSettings WithText(string text);
        // declared here rather than taken from IAllowEnabled, whose WithEnabled answers with the settings
        // every control shares. this one keeps the chain on a bar item
        IAllowBarItemSettings WithEnabled(bool trueFalse = true);
        IAllowBarItemSettings WithImage(Image image);
        IAllowBarItemSettings WithImage(GPALFile file);
    }
    public interface IAllowRichTextBoxControlSettings : IAllowControlSettings, IAllowEnabled, IAllowReadOnly
    {
        new IAllowRichTextBoxControlSettings WithText(string text);
    }
    public interface IAllowComboBoxControlSettings : IAllowControlSettings
    {
        IAllowComboBoxControlSettings WithItems(params string[] itemArray);
        IAllowComboBoxControlSettings WithItems(IEnumerable<string> itemCollection);
        IAllowComboBoxControlSettings WithItems(Array itemArray);
        IAllowComboBoxControlSettings WithSelectedIndex(int index);
        IAllowComboBoxControlSettings WithSelectedItem(string name);
    }
    public interface IAllowDataGridViewControlSettings : IAllowControlSettings
    {
        IAllowDataGridViewControlSettings WithColumns(params string[] columnNames);
        IAllowDataGridViewControlSettings WithReadOnly(bool readOnly);
        IAllowDataGridViewControlSettings WithAutoGenerateColumns(bool autoGenerate);
        IAllowDataGridViewControlSettings WithGrid(IGPALGrid<string> grid);
    }
    public interface IAllowProgressBarControlSettings : IAllowControlSettings
    {
        IAllowProgressBarControlSettings WithValue(int value);
        IAllowProgressBarControlSettings WithMinimum(int min);
        IAllowProgressBarControlSettings WithMaximum(int max);
        IAllowProgressBarControlSettings WithStyle(ProgressBarStyle style);
    }
    public interface IAllowTableLayoutPanelSettings
    {
        IAllowControlSettingsAndTableLayoutPanelSettings WithGrowStyle(TableLayoutPanelGrowStyle tableLayoutPanelGrowStyle);
        IAllowControlSettingsAndTableLayoutPanelSettings WithColumnCount(int columnCount);
        IAllowControlSettingsAndTableLayoutPanelSettings WithRowCount(int rowCount);
    }
    public interface IAllowCallBack
    {
        // return values
        // 0 = not handled
        // 1 = handled
        // -1 = error
        // IAllowAfterAnySelector CallIfFound(Form.CallIfDelegate callIfFound);
        // IAllowAfterAnySelector CallIfNotFound(Form.CallIfDelegate callIfNotFound);
        IAllowFormSettingsAndActions CallAfterFillIn(GPALForm.CallAfterFillInDelegate callAfterFillIn);
    }
    public interface IAllowFormActions
    {
        IAllowFormActionsAndFillIn Show();
        IAllowFormActions ShowDialog();
        IAllowFormActions Hide();
        dynamic ToGPALObject();
    }
    public interface IAllowToolTipDelay : IAllowControlSettings
    {
        IAllowControlSettings WithToolTipDelay(int delayInMs);
    }
    public interface IAllowFormActionsAndFillIn
        : IAllowFillInFrom
        , IAllowFormActions
    { }
 
    public interface IAllowFormSettings
    {
        [Settings(Description = "Add a control to the form. Containers are built whole first, so a splitter or a group box is added the same way as anything else")]
        IAllowFormSettingsAndActions WithFormControl(GPALControl gPALFormControl);
        IAllowFormSettingsAndActions WithWidth(int width);
        IAllowFormSettingsAndActions WithHeight(int height);
        IAllowFormSettingsAndActions WithTop(int top);
        IAllowFormSettingsAndActions WithLeft(int left);
        IAllowFormSettingsAndActions WithTitle(string title);
    }
    public interface IAllowControlSettingsAndChartSettings
        : IAllowControlSettings
        , IAllowChartSettings
    { }
    public interface IAllowControlSettingsAndDataGridViewSettings
        : IAllowControlSettings
        , IAllowDataGridViewSettings
    { }
    public interface IAllowControlAndDataGridViewSettingsAndActions
        : IAllowControlSettings
        , IAllowDataGridViewSettings
        , IAllowDataGridViewActions
    { }
    public interface IAllowControlSettingsAndFontSettings
        : IAllowControlSettings
        , IAllowFontSettings
    { }
    public interface IAllowControlSettingsAndEnabled
        : IAllowControlSettings
        , IAllowEnabled
        , IAllowReadOnly
        , IAllowPlaceholder
    { }
    public interface IAllowControlSettingsAndTableLayoutPanelSettings
        : IAllowControlSettings
        , IAllowTableLayoutPanelSettings
    { }
    public interface IAllowControlSettingsPlaceholderEnabledAndPassword
        : IAllowControlSettings
        , IAllowEnabled
        , IAllowPassword
        , IAllowPlaceholder
        , IAllowReadOnly
    { }
    public interface IAllowControlSettingsEnabledAndChecked
        : IAllowControlSettings
        , IAllowEnabled
        , IAllowChecked
    { }
    public interface IAllowControlSettingsEnabledAndDefault
        : IAllowControlSettings
        , IAllowEnabled
        , IAllowDefault
    { }
    public interface IAllowControlSettingsAndChecked
        : IAllowControlSettings
        , IAllowChecked
    { }
    public interface IAllowFormSettingsAndActions
        : IAllowFormSettings
        , IAllowFormActions
        , IAllowCallBack
    { }
    #endregion <FormInterfaces>
    #region <Atoms>
    public interface IAllowChecked { IAllowControlSettings WithChecked(bool trueFalse = false); }
    public interface IAllowEnabled { IAllowControlSettings WithEnabled(bool trueFalse = true); }
    public interface IAllowPassword { IAllowControlSettings IsPassword { get; } }
    public interface IAllowPlaceholder { IAllowControlSettings WithPlaceholder(string PlaceholderText);  }
    public interface IAllowReadOnly { IAllowControlSettings WithReadOnly(bool readOnly = true); }
    #endregion
}