AUI_AnyWin.cs

#region Header
/*
    ==============================================================================
      Author: Zoltan Hrabovszki <zh@openkeyword.de>

      Copyright © 2012, 2013, 2014, 2015 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 

    This file is part of OpenKeyWord.

    OpenKeyWord is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenKeyWord is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.

    Diese Datei ist Teil von OpenKeyWord.

    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.

    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.

    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
#endregion Header

namespace OKW.GUI.AUI
{
    using System;
    using System.Collections.Generic;
    using System.Text;
    using System.Windows.Forms;

    using OKW.Log;

    public class AUI_AnyWin
    {
        #region Fields

        protected string controlID;

        protected OKW_Wait4Value MyWait4Value = new OKW_Wait4Value();

        protected string text;

        protected string title;

        #endregion Fields

        #region Constructors

        public AUI_AnyWin(string fpsTitel, string fpsText, string fpsControlID)
        {
            this.text = fpsText;
            this.title = fpsTitel;
            this.controlID = fpsControlID;
        }

        #endregion Constructors

        #region Methods

        public virtual void Click_On()
        {
            this.LogFunctionStartDebug("Click_On()");

            // ControlClick($titel, $text, 21006 , "right", 2)
            if (0 == AutoItX3.AU3_ControlClick(this.title, this.text, this.controlID, "left", 1, 5, 5))
            {
                // EXCEPTION: GUIException- Nachricht auslagern.
                this.LogObjectData();
                this.LogFunctionEndDebug();
                throw new GUIException("AutoIt Fehler...");
            }

            this.LogFunctionEndDebug();
            return;
        }

        public virtual bool GetValue_ACTIVE()
        {
            LogFunctionStartDebug("GetValue_ACTIVE");

            bool lvbReturn = false;

            LogFunctionEndDebug(lvbReturn);

            throw new NotImplementedException("AutoIt unterstützt das Auslesen von Tooltips nicht:-(");

            // return lvbReturn;
        }

        public virtual bool GetValue_FOCUS()
        {
            this.LogFunctionStartDebug("GetValue_FOCUS");

            bool lvbReturn = false;

            this.LogFunctionEndDebug(lvbReturn);

            throw new NotImplementedException("Die Implementierung GetValue_FOCUS von ist noch nicht erfolg");

            //return lvbReturn;
        }

        public virtual List<string> GetValue_TOOLTIP()
        {
            this.LogFunctionStartDebug("GetValue_TOOLTIP");

            List<string> lvLsReturn = new List<string>();
            this.LogFunctionEndDebug(lvLsReturn);

            throw new NotImplementedException("AutoIt unterstützt das Auslesen von Tooltips nicht:-(");

            //return lvLsReturn;
        }

        public void LogFunctionStartDebug(string fpsMethodName, string P1_Name, string P1_Value)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + "." + fpsMethodName, P1_Name, P1_Value);
        }

        public void LogFunctionStartDebug(string fpsMethodName)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + "." + fpsMethodName);
        }

        public virtual bool LogValue_ACTIVE()
        {
            this.LogFunctionStartDebug("LogValue_ACTIVE");

            bool lvbReturn = this.GetValue_ACTIVE();

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        public virtual bool LogValue_FOCUS()
        {
            this.LogFunctionStartDebug("LogValue_FOCUS");

            bool lvbReturn = this.GetValue_FOCUS();

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        public virtual List<string> LogValue_TOOLTIP()
        {
            this.LogFunctionStartDebug("LogValue_TOOLTIP");

            List<string> lvLsReturn = this.GetValue_TOOLTIP();

            this.LogFunctionEndDebug(lvLsReturn);

            return lvLsReturn;
        }

        public virtual List<string> MemorizeTooltip()
        {
            this.LogFunctionStartDebug("MemorizeTooltip");

            List<string> lvLsReturn = this.GetValue_TOOLTIP();

            this.LogFunctionEndDebug(lvLsReturn);

            return lvLsReturn;
        }

        public virtual bool Memorize_ACTIVE()
        {
            this.LogFunctionStartDebug("Memorize_ACTIVE");

            bool lvbReturn = this.GetValue_ACTIVE();

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        public virtual bool Memorize_FOCUS()
        {
            this.LogFunctionStartDebug("Memorize_FOCUS");

            bool lvbReturn = this.GetValue_FOCUS();

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        public string ReadClipboard()
        {
            string lvs_Return = string.Empty;

            this.LogFunctionStartDebug("ReadClipboard");

            lvs_Return = AutoItX3.ClipGet();

            this.LogFunctionEndDebug(lvs_Return);

            return lvs_Return;
        }

        public virtual void TypeKey(List<string> fps_Values)
        {
            this.LogFunctionStartDebug("TypeKey", "fps_Values", fps_Values.ToString());

            // Loop through all List-Values with foreach...
            foreach (string Value in fps_Values)
            {
                Logger.Instance.LogPrintDebug(">>" + Value + "<<");

                if (0 == AutoItX3.AU3_ControlFocus(this.title, this.text, this.controlID))
                {
                    // AutoIt Fehler...
                    this.LogObjectData();
                    this.LogFunctionEndDebug();
                    throw new GUIException("AutoIt Fehler...");
                }

                AutoItX3.AU3_ControlSend(this.title, this.text, this.controlID, Value, 1);
            }

            this.LogFunctionEndDebug();
            return;
        }

        public virtual List<string> VerifyTooltip(List<string> fplsExpectedValue)
        {
            this.LogFunctionStartDebug("MemorizeTooltip", "fplsExpectedValue", fplsExpectedValue[1]);

            List<string> lvLsReturn;

            // GetValue_TOOLTIP als delegaten definieren
            OKW_Wait4Value.ListStringCallBack myCallBack = this.GetValue_TOOLTIP;

            // Nun mit dem erwarteten Sollwert und GetValue_TOOLTIP ggf. auf den Wert Warten.
            lvLsReturn = this.MyWait4Value.Wait4Value(fplsExpectedValue, myCallBack);

            this.LogFunctionEndDebug(lvLsReturn);

            return lvLsReturn;
        }

        public virtual bool Verify_ACTIVE(bool fpbExpectedValue)
        {
            this.LogFunctionStartDebug("Memorize_ACTIVE", "fpbExpectedValue", fpbExpectedValue.ToString());

            bool lvbReturn = false;

            // GetValue_TOOLTIP als delegaten definieren
            OKW_Wait4Value.BoolCallBack myCallBack = this.GetValue_ACTIVE;

            // Nun mit dem erwarteten Sollwert und GetValue_TOOLTIP ggf. auf den Wert Warten.
            lvbReturn = this.MyWait4Value.Wait4Value(fpbExpectedValue, myCallBack);

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        public virtual bool Verify_FOCUS(bool fpbExpectedValue)
        {
            this.LogFunctionStartDebug("Verify_FOCUS", "fpbExpectedValue", fpbExpectedValue.ToString());

            bool lvbReturn = false;

            // GetValue_TOOLTIP als delegaten definieren
            OKW_Wait4Value.BoolCallBack myCallBack = this.GetValue_FOCUS;

            // Nun mit dem erwarteten Sollwert und GetValue_FOCUS ggf. auf den Wert Warten.
            lvbReturn = this.MyWait4Value.Wait4Value(fpbExpectedValue, myCallBack);

            this.LogFunctionEndDebug(lvbReturn);

            return lvbReturn;
        }

        protected void LogFunctionEndDebug()
        {
            Logger.Instance.LogFunctionEndDebug();
        }

        protected void LogFunctionEndDebug(string fps_Return)
        {
            Logger.Instance.LogFunctionEndDebug(fps_Return);
        }

        protected void LogFunctionEndDebug(bool fpb_Return)
        {
            Logger.Instance.LogFunctionEndDebug(fpb_Return);
        }

        protected void LogFunctionEndDebug(List<string> fpls_Return)
        {
            Logger.Instance.LogFunctionEndDebug(fpls_Return);
        }

        protected void LogObjectData()
        {
            Log.Logger.Instance.LogPrint("     title: >>" + this.title + "<<");
            Log.Logger.Instance.LogPrint("      text: >>" + this.text + "<<");
            Log.Logger.Instance.LogPrint(" controlID: >>" + this.controlID + "<<");
        }

        #endregion Methods
    }
}