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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
(Метка: замена)
Строка 10: Строка 10:
 
Прямые наследники:
 
Прямые наследники:
 
[[FGX.PageControl.TfgPageControl|TfgPageControl]]
 
[[FGX.PageControl.TfgPageControl|TfgPageControl]]
 
== Описание ==
 
 
<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">function</syntaxhighlight> || <code lang="Delphi">GoToNextPage(const AOnlyVisible: [[Boolean]]): [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code>
 
 
<p>Выполняет анимированное переключение страницы с текущей на следующую, возвращая выбранную страницу. При этом выбор следующей страницы может осуществляется, как видимой, так и не видимой страницы.</p><div class="info">Если следующей страницы нет, то вернет nil.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GoToPreviousPage(const AOnlyVisible: [[Boolean]]): [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code>
 
 
<p>Выполняет анимированное переключение страницы с текущей на предыдущую, возвращая выбранную страницу. При этом выбор предыдущей страницы может осуществляется, как видимой, так и не видимой страницы.</p><div class="info">Если следующей страницы нет, то вернет nil.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">HasNextPage(const AOnlyVisible: [[Boolean]]): [[Boolean]]</code>
 
 
<p>Определяет, если ли следующая страница, относительно текущей, которую можно выбрать.</p><div class="info">Если ни одно вкладка не выбрана, то выполняет определение с первой вкладки.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">HasPreviousPage(const AOnlyVisible: [[Boolean]]): [[Boolean]]</code>
 
 
<p>Определяет, если ли предыдущая страница, относительно текущей, которую можно выбрать.</p><div class="info">Если ни одно вкладка не выбрана, то выполняет определение с последней вкладки.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">AddPage(const ATitle: [[string]]; const AIconName: [[TfgAssetName|TfgAssetName]]): [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code>
 
 
<p>Добавляет новую вкладку с заголовком <i>ATitle</i> и иконкой по имени <i>AIconName</i> .</p><div class="info">Активную вкладку в контроле не меняет.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">DeleteCurrentPage(): [[Boolean]]</code>
 
 
<p>Удаляет текущую страницу, если она есть.</p><div class="info">Возвращает True - если текущая страница была и она удалена. False - если текущей страницы не было.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">DeletePage(const APage: [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]): [[Boolean]]</code>
 
 
<p>Удаляет страницу контрола по ее инстансу <i>APage</i> .</p><div class="info">Не допускается указывать nil. Если страница существует среди страниц контрола и она была удалена, то вернет True.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">DeletePage(const APageIndex: [[Integer]]): [[Boolean]]</code>
 
 
<p>Удаляет страницу контрола с её содержимым по указанному индексу <i>APageIndex</i> .</p><div class="info">Не допускается указывать индекс не существующей страницы.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Clear()</code>
 
<p>Удаляет все страницы контрола с их содержимым.</p>
 
|}
 
 
== Свойства ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ActivePage: [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code>
 
 
<p>Активная/выбранная страница ( <i>PageIndex</i> ).</p><div class="info">Если ни одна страница не выбрана, вернет nil.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PagesCount: [[Integer]]</code>
 
<p>Количество страниц.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Pages[const AIndex]: [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code>
 
 
<p>Возвращает страницу по указанному индексу.</p><div class="info">Не допускается указывать индекс не существующей страницы.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PageIndex: [[Integer]]</code>
 
 
<p>Индекс активной/текущей выбранной страницы.</p><div class="info">Смена вкладок идет без анимации.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SwipeEnabled: [[Boolean]]</code>
 
<p>Можно ли перелистывать страницы пальцем или нет.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TabsHeight: [[Single]]</code>
 
 
<p>Высота вкладок.</p><div class="info">Если указано 0, то вкладки будут стандартной высоты, согласно платформе. Если требуется скрыть вкладки, то нужно воспользоваться <i>TabsPosition = Invisible</i></div>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TabsPosition: [[FGX.PageControl.TfgTabsPosition|TfgTabsPosition]]</code>
 
<p>Положение вкладок относительно контрола.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColor: [[TAlphaColor]]</code>
 
<p>Цветовой оттенок вкладки.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColorName: [[TfgAssetName|TfgAssetName]]</code>
 
 
<p>Ресурс цвета оттенка вкладки.</p><div class="info">Если указан ресурс цвета, то он имеет более высокий приоритет над <i>TintColor</i> . Поэтому именно он и будет использоваться. Если же в ресурсе цвет не указан (Null) или его нет, то будет использоваться <i>TintColor</i> .</div>
 
|}
 
 
== События ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPageSelecting: [[TfgOnPageSelecting]]</code>
 
<p>Срабатывает в процессе смены текущей страницы, позволяя отследить сам процесс смены.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanged: [[TNotifyEvent]]</code>
 
<p>Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPageSelected: [[TfgOnPageSelected]]</code>
 
<p>Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Дополнительно передает индекс выбранной страницы и сам экземпляр страницы.</p>
 
|}
 
 
== Константы ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>UndefinedPageIndex: [[Integer]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTabsHeight: [[Integer]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTabsPosition: [[FGX.PageControl.TfgTabsPosition|TfgTabsPosition]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTintColor: [[TAlphaColor]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSwipeEnabled: [[Boolean]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|}
 

Версия 18:13, 29 июня 2019

Delphi

TfgCustomPageControl = class (TfgControl, IFGXContainer)

TComponent -> TfgControl -> TfgCustomPageControl

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