FGX.DrawerLayout.TfgCustomDrawerLayout: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 38 промежуточных версий этого же участника)
Строка 1: Строка 1:
* [[ FGX.DrawerLayout | Вверх к родителю: FGX.DrawerLayout ]]
+
* [[ FGX.Controls.TfgControl | Вверх к родителю: TfgControl ]]
 +
* [[ FGX.DrawerLayout | К модулю: FGX.DrawerLayout ]]
  
 
Delphi
 
Delphi
  
<code lang="Delphi">TfgCustomDrawerLayout = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)</code>
+
<syntaxhighlight lang="Delphi">TfgCustomDrawerLayout = class (TfgControl, IFGXContainer)</syntaxhighlight>
 +
 
 +
<p class="class-inheritance"><span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Controls.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.DrawerLayout.TfgCustomDrawerLayout|TfgCustomDrawerLayout]]</span></p>
 +
 
 +
Прямые наследники:
 +
[[FGX.DrawerLayout.TfgDrawerLayout|TfgDrawerLayout]]
  
 
== Описание ==
 
== Описание ==
  
Описание отсутствует.
+
<span style="color:gray">Описание отсутствует.</span>
 +
== Конструкторы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|}
 +
 
 +
== Методы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Open(const AAnimate: [[Boolean]])</code>
 +
 
 +
<p>Открывает панель <i>Drawer</i> с анимацией или без (зависит от параметра <i>AAnimate</i> ).</p><div class="info">Если панель открыта, то ничего не делает.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Close(const AAnimate: [[Boolean]])</code>
 +
 
 +
<p>Закрывает панель <i>Drawer</i> с анимацией или без (зависит от параметра <i>AAnimate</i> ).</p><div class="info">Если панель закрыта, то ничего не делает.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsOpened(): [[Boolean]]</code>
 +
<p>Возвращает <i>True</i> , если панель <i>Drawer</i> открыта. <i>False</i> - в противном случаи.</p>
 +
|}
 +
 
 +
== Свойства ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Drawer: [[FGX.DrawerLayout.TfgCustomDrawer|TfgCustomDrawer]]</code>
 +
<p>Выдвигаемая панель.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Content: [[FGX.DrawerLayout.TfgMainContent|TfgMainContent]]</code>
 +
<p>Основной контент, контрол поверх которого выдвивается панель <i>Drawer</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ToggleControl: [[FGX.Controls.TfgControl|TfgControl]]</code>
 +
 
 +
<p>Контрол, который отвечает за открытие и закрытие дровера.</p><div class="info">Дровер автоматически распознает тип контрола и умеет корректно работать даже <i>TfgNavigationBar</i> .</div>
 +
|}
  
== Конструкторы ==
+
== События ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <code>constructor</code> || <code>Create(AOwner: [[TComponent]])</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBeginOpen: [[TNotifyEvent]]</code>
 +
<p>Срабатывает в момент начала выдвигания панели <i>Drawer</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnOpened: [[TNotifyEvent]]</code>
 +
<p>Срабатывает, когода панель <i>Drawer</i> полностью открыта.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBeginClose: [[TNotifyEvent]]</code>
 +
<p>Срабатывает в момент начала задвигания панели <i>Drawer</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnClosed: [[TNotifyEvent]]</code>
 +
<p>Срабатывает в момент полного закрытия панели <i>Drawer</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnStateChanged: [[TfgDrawerStateChangedEvent|TfgDrawerStateChangedEvent]]</code>
 +
<p>Информирует пользователя об изменениях в состоянии панели (не двигается, двигается, закрыта/открыта).</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSlideChanged: [[TfgDrawerSlideChangedEvent|TfgDrawerSlideChangedEvent]]</code>
 +
<p>Информаирует о степени закрытия/открытия панели <i>Drawer</i> . Параметр <i>ANormalizedOffset</i> содержит нормализованное значение [0..1], где 0 - панель полностью закрыта, 1 - полностью открыта.</p>
 +
|}
  
 +
== Константы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultDrawerWidth: [[Integer]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}

Текущая версия на 17:18, 23 декабря 2022

Delphi

TfgCustomDrawerLayout = class (TfgControl, IFGXContainer)

TComponent -> TfgControl -> TfgCustomDrawerLayout

Прямые наследники: TfgDrawerLayout

Описание

Описание отсутствует.

Конструкторы

constructor
Create(AOwner: TComponent)

Описание отсутствует.

Методы

procedure
Open(const AAnimate: Boolean)

Открывает панель Drawer с анимацией или без (зависит от параметра AAnimate ).

Если панель открыта, то ничего не делает.
procedure
Close(const AAnimate: Boolean)

Закрывает панель Drawer с анимацией или без (зависит от параметра AAnimate ).

Если панель закрыта, то ничего не делает.
function
IsOpened(): Boolean

Возвращает True , если панель Drawer открыта. False - в противном случаи.

Свойства

property
Drawer: TfgCustomDrawer

Выдвигаемая панель.

property
Content: TfgMainContent

Основной контент, контрол поверх которого выдвивается панель Drawer .

property
ToggleControl: TfgControl

Контрол, который отвечает за открытие и закрытие дровера.

Дровер автоматически распознает тип контрола и умеет корректно работать даже TfgNavigationBar .

События

event
OnBeginOpen: TNotifyEvent

Срабатывает в момент начала выдвигания панели Drawer .

event
OnOpened: TNotifyEvent

Срабатывает, когода панель Drawer полностью открыта.

event
OnBeginClose: TNotifyEvent

Срабатывает в момент начала задвигания панели Drawer .

event
OnClosed: TNotifyEvent

Срабатывает в момент полного закрытия панели Drawer .

event
OnStateChanged: TfgDrawerStateChangedEvent

Информирует пользователя об изменениях в состоянии панели (не двигается, двигается, закрыта/открыта).

event
OnSlideChanged: TfgDrawerSlideChangedEvent

Информаирует о степени закрытия/открытия панели Drawer . Параметр ANormalizedOffset содержит нормализованное значение [0..1], где 0 - панель полностью закрыта, 1 - полностью открыта.

Константы

const
DefaultDrawerWidth: Integer

Описание отсутствует.