.. _TbtkScriptApplicationWindowsNamespace:

TbtkScriptApplicationWindowsNamespace
``````````````````````````````````````````````````````````````````````

.. pas:class:: TbtkScriptApplicationWindowsNamespace

    :term:`Пространство имен <Скриптовое пространство имен>` для методов и свойств работающих с окнами, формами, фокусом и контролами приложения, не отягощенными знаниями о модели данных.
    
    .. seealso::

        :ref:`Спецификация на формы приложения<application_windows_spec>`

    .. warning:: |not_supported|

.. _builtin_forms_scriptapi: 

:term:`Встроенные формы <Встроенная форма>`
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

.. warning:: |not_supported|

.. pas:class::

    .. pas:method:: GetActiveBuiltinForm(): TbtkScriptFormObject

        Возвращает активную :term:`встроенную форму <Встроенная форма>`.

        :rtype: TbtkScriptFormObject

    .. pas:method:: CloseAllBuiltinForms()
        
        Закрыть все :term:`встроенные формы <Встроенная форма>`. 
    
    .. pas:method:: CloseAllBuiltinFormsExceptCurrent()

        Закрыть все :term:`встроенные формы <Встроенная форма>` за исключением формы которая принадлежит выборке в которой выполняется скрипт.
    
    .. pas:method:: GetDockByForm(Form: TbtkScriptFormObject): TbtkScriptFormDockObject

        Получить :term:`док <Док форм>` владеющий формой *Form*.

        :rtype: TbtkScriptFormDockObject
    
    .. pas:method:: GetFormIndexInDock(Form: TbtkScriptFormObject): Integer;

        Получить индекс порядка расположения *Form* в ее :term:`доке <Док форм>` .

        :rtype: Integer
    
    .. pas:attribute:: BuiltinSites[Index: Integer]: TbtkScriptFormDockSiteObject

        Получить :term:`Док-сайт` по *Index* из коллекции. Свойство *readonly*.
            
        :rtype: TbtkScriptFormDockObject

        Под индекс 0 всегда :term:`Док-сайт` :term:`главной формы <Главная форма>`.

        .. note::

            На текущий момент :term:`Док-сайт` может существовать только у :term:`главной формы <Главная форма>`, но в будущем планируется добавить возможность размещения док-сайт'ов на других :term:`формах <Форма>`.


.. pas:class:: TbtkScriptFormDockSiteObject

    Скриптовый класс-обертка над :term:`док-сайтом <Док-сайт>`.

    .. warning:: |not_supported|

    .. pas:method:: Index(): Integer

        Возвращает индекс объекта в :class:`TbtkScriptApplicationWindowsNamespace.BuiltinSites`

        :rtype: Integer

    .. pas:attribute:: Layout: TbtkDockSiteLayout

        Свойство определяет разметку :term:`док-сайта <Док-сайт>`   

        :rtype: TbtkDockSiteLayout


    .. pas:method:: GetActiveForm(): TbtkScriptFormObject

         Возвращает активную :term:`форму<Форма>` в текущем :term:`док-сайте<Док-сайт>`

         :rtype: TbtkScriptFormObject 

    .. pas:attribute:: ActiveDock: TbtkScriptFormDockObject

        Активный :term:`Док форм`.

        :rtype: TbtkScriptFormDockObject

    .. pas:method:: DockCount(): Integer

        Количество :term:`доков форм<Док форм>` в :pas:attr:`~TbtkScriptFormDockSiteObject.Docks`

        :rtype: Integer

    .. pas:attribute:: Docks [Index: Integer]: TbtkScriptFormDockObject 

        Получить :term:`Док форм` по индексу из коллекции. Свойство *readonly*.
            

        :rtype: TbtkScriptFormDockObject


.. pas:class:: TbtkDockSiteLayout

    Перечисление.

    Виды разметок поддерживаемых в :term:`Док-сайт`

    .. warning:: |not_supported|

    .. pas:attribute:: dslOneDock

        Один :term:`док<Док форм>`

    .. pas:attribute:: dslTwoColumns

        Два :term:`дока<Док форм>` разделенных вертикально

    .. pas:attribute:: dslThreeColumns

        Три :term:`дока<Док форм>` разделенных вертикально

    .. pas:attribute:: dslTwoRows

        Два :term:`дока<Док форм>` разделенных горизонтально

    .. pas:attribute:: dslThreeRows

        Три :term:`дока<Док форм>` разделенных горизонтально

    .. pas:attribute:: dslFourDocksInGrid

        4 :term:`дока <Док форм>` разделенных горизонтально и вертикально крестом



.. pas:class:: TbtkScriptFormDockObject

    Скриптовый класс-обертка над :term:`доком-форм <Док форм>`.

    .. warning:: |not_supported|

    .. pas:method:: Index(): Integer

        Индекс объекта в :pas:class:`~TbtkScriptFormDockSiteObject.Docks`.

        :rtype: Integer

    .. pas:method:: GetActiveForm(): TbtkScriptFormObject

        Возвращает активную форму в текущем доке. :pas:meth:`TbtkScriptFormDockObject.Index`

        :rtype: TbtkScriptFormObject

    .. pas:attribute:: Site: TbtkScriptFormDockSiteObject

        Возвращает :term:`Док-сайт` владеющий текущим доком.

        :rtype: TbtkScriptFormDockSiteObject

    .. pas:method:: Activated(): Boolean

        Возвращает активность текущего дока.

        :rtype: Boolean

        .. seealso::

            :pas:attr:`TbtkScriptFormDockSiteObject.ActiveDock`

    .. pas:method:: Activate()

        Активирует док.

        .. seealso::

            :pas:attr:`TbtkScriptFormDockSiteObject.ActiveDock`

    .. pas:method:: FormCount(): Integer

        Количество форм в :pas:attr:`~TbtkScriptFormDockObject.Forms`

        :rtype: Integer


    .. pas:attribute:: Forms [Index: Integer]: TbtkScriptFormObject

        Получить :term:`встроенную форму <Встроенная форма>` по индексу из коллекции. Свойство *readonly*.

        :rtype: TbtkScriptFormObject

    .. pas:method:: InsertForm(Index: Integer; Form: TbtkScriptFormObject)

        Вставить *Form* в коллекцию :pas:attr:`~TbtkScriptFormDockObject.Forms` текущего дока в позицию *Index*. 
        При этом *Form* будет извлечена из предыдущего дока.

        .. note::

            Вставка формы не приводит к автоматической активации ни формы, ни дока. За исключением случая когда  переносится уже активная форма, в этом случае сменится и активность дока.

            Чтобы активировать вставленную форму, необходимо вызывать метод активации формы :pas:meth:`TbtkScriptFormObject.BringToFront`.