FGX.PageControl.TfgCustomPageControl: различия между версиями
Admin (обсуждение | вклад) (summary) |
Admin (обсуждение | вклад) (summary) |
||
(не показаны 44 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
− | * [[ FGX. | + | * [[ FGX.Controls.TfgControl | Вверх к родителю: TfgControl ]] |
+ | * [[ FGX.PageControl | К модулю: FGX.PageControl ]] | ||
Delphi | Delphi | ||
− | < | + | <syntaxhighlight lang="Delphi">TfgCustomPageControl = 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.PageControl.TfgCustomPageControl|TfgCustomPageControl]]</span></p> | ||
+ | |||
+ | Прямые наследники: | ||
+ | [[FGX.PageControl.TfgPageControl|TfgPageControl]] | ||
+ | |||
+ | == Описание == | ||
+ | |||
+ | <p>Контейнер вкладок <i>TfgPage</i> .</p> | ||
== Конструкторы == | == Конструкторы == | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code> |
− | + | <span style="color:gray">Описание отсутствует.</span> | |
|} | |} | ||
Строка 17: | Строка 26: | ||
{| class="wikitable sortable" | {| 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">GoToPage(const APageIndex: [[Integer]]): [[FGX.PageControl.TfgCustomPage|TfgCustomPage]]</code> | ||
+ | <p>Выполняет анимированное переключение страницы с текущей на видимыею страницу с указанным индексом, возвращая выбранную страницу.</p> | ||
+ | |- | ||
+ | | <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">GetNextPageIndex(const APageIndex: [[Integer]]; const AOnlyVisible: [[Boolean]]): [[Integer]]</code> |
− | Определяет, | + | |
+ | <p>Определяет индекс следующей вкладки после <i>APageIndex</i> с учетом видимости вкладок <i>AOnlyVisible</i> .</p><div class="info">Если таких вкладок нет, вернет -1.</div> | ||
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetPreviousPageIndex(const APageIndex: [[Integer]]; const AOnlyVisible: [[Boolean]]): [[Integer]]</code> |
− | Определяет, | + | |
+ | <p>Определяет индекс предыдущей вкладки перед <i>APageIndex</i> с учетом видимости вкладок <i>AOnlyVisible</i> .</p><div class="info">Если таких вкладок нет, вернет -1.</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">IsPageExisted(const APageIndex: [[Integer]]): [[Boolean]]</code> |
− | + | <p>Проверяет, существует ли вкладка по указанному индексу <i>APageIndex</i> .</p> | |
|- | |- | ||
− | | < | + | | <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> | ||
|- | |- | ||
− | | <code lang="Delphi">procedure</ | + | | <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> | ||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Changed()</code> | ||
+ | |||
+ | <p>Форсирует вызов событий <i>OnPageSelected</i> и <i>OnChanged</i> .</p><div class="info">Используете этот метод, если после программного изменения текущей вкладки, вам необходимо, чтобы данные события были вызваны.</div> | ||
|} | |} | ||
Строка 49: | Строка 84: | ||
{| class="wikitable sortable" | {| 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> | ||
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TitleTextSettings: [[FGX.PageControl.Types.TfgPageTitleTextSettings|TfgPageTitleTextSettings]]</code> |
− | + | <p>Настройки отображения заголовков на вкладках.</p> | |
|} | |} | ||
Строка 84: | Строка 127: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPageSelecting: [[TfgPageSelectingEvent|TfgPageSelectingEvent]]</code> |
− | Срабатывает в процессе смены текущей страницы, позволяя отследить сам процесс смены. | + | <p>Срабатывает в процессе смены текущей страницы, позволяя отследить сам процесс смены.</p> |
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanged: [[TNotifyEvent]]</code> |
− | Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. | + | |
+ | <p>Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц.</p><div class="info">Вызывается только, когда пользователь интерактивно меняет активную вкладку.</div> | ||
|- | |- | ||
− | | < | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPageSelected: [[TfgPageSelectedEvent|TfgPageSelectedEvent]]</code> |
− | Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Дополнительно передает индекс выбранной страницы и сам экземпляр страницы. | + | <p>Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Дополнительно передает индекс выбранной страницы и сам экземпляр страницы.</p> |
|} | |} | ||
Строка 98: | Строка 142: | ||
{| class="wikitable sortable" | {| 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> | |
|} | |} |
Текущая версия на 17:22, 23 декабря 2022
Delphi
TfgCustomPageControl = class (TfgControl, IFGXContainer)
TComponent -> TfgControl -> TfgCustomPageControl
Прямые наследники: TfgPageControl
Содержание
Описание
Контейнер вкладок TfgPage .
Конструкторы
constructor
|
Create(AOwner: TComponent)
Описание отсутствует. |
Методы
function
|
GoToNextPage(const AOnlyVisible: Boolean): TfgCustomPage
Выполняет анимированное переключение страницы с текущей на следующую, возвращая выбранную страницу. При этом выбор следующей страницы может осуществляется, как видимой, так и не видимой страницы. Если следующей страницы нет, то вернет nil.
|
function
|
GoToPreviousPage(const AOnlyVisible: Boolean): TfgCustomPage
Выполняет анимированное переключение страницы с текущей на предыдущую, возвращая выбранную страницу. При этом выбор предыдущей страницы может осуществляется, как видимой, так и не видимой страницы. Если следующей страницы нет, то вернет nil.
|
function
|
GoToPage(const APageIndex: Integer): TfgCustomPage
Выполняет анимированное переключение страницы с текущей на видимыею страницу с указанным индексом, возвращая выбранную страницу. |
function
|
HasNextPage(const AOnlyVisible: Boolean): Boolean
Определяет, если ли следующая страница, относительно текущей, которую можно выбрать. Если ни одно вкладка не выбрана, то выполняет определение с первой вкладки.
|
function
|
HasPreviousPage(const AOnlyVisible: Boolean): Boolean
Определяет, если ли предыдущая страница, относительно текущей, которую можно выбрать. Если ни одно вкладка не выбрана, то выполняет определение с последней вкладки.
|
function
|
GetNextPageIndex(const APageIndex: Integer; const AOnlyVisible: Boolean): Integer
Определяет индекс следующей вкладки после APageIndex с учетом видимости вкладок AOnlyVisible . Если таких вкладок нет, вернет -1.
|
function
|
GetPreviousPageIndex(const APageIndex: Integer; const AOnlyVisible: Boolean): Integer
Определяет индекс предыдущей вкладки перед APageIndex с учетом видимости вкладок AOnlyVisible . Если таких вкладок нет, вернет -1.
|
function
|
AddPage(const ATitle: string; const AIconName: TfgAssetName): TfgCustomPage
Добавляет новую вкладку с заголовком ATitle и иконкой по имени AIconName . Меняет активную вкладку в контроле на добавляемую.
|
function
|
IsPageExisted(const APageIndex: Integer): Boolean
Проверяет, существует ли вкладка по указанному индексу APageIndex . |
function
|
DeleteCurrentPage(): Boolean
Удаляет текущую страницу, если она есть. Возвращает True - если текущая страница была и она удалена. False - если текущей страницы не было.
|
function
|
DeletePage(const APage: TfgCustomPage): Boolean
Удаляет страницу контрола по ее инстансу APage . Не допускается указывать nil. Если страница существует среди страниц контрола и она была удалена, то вернет True.
|
function
|
DeletePage(const APageIndex: Integer): Boolean
Удаляет страницу контрола с её содержимым по указанному индексу APageIndex . Не допускается указывать индекс не существующей страницы.
|
procedure
|
Clear()
Удаляет все страницы контрола с их содержимым. |
procedure
|
Changed()
Форсирует вызов событий OnPageSelected и OnChanged . Используете этот метод, если после программного изменения текущей вкладки, вам необходимо, чтобы данные события были вызваны.
|
Свойства
property
|
ActivePage: TfgCustomPage
Активная/выбранная страница ( PageIndex ). Если ни одна страница не выбрана, вернет nil.
|
property
|
PagesCount: Integer
Количество страниц. |
property
|
Pages[const AIndex]: TfgCustomPage
Возвращает страницу по указанному индексу. Не допускается указывать индекс не существующей страницы.
|
property
|
TintColorLink: TfgAssetColorLink
Описание отсутствует. |
property
|
PageIndex: Integer
Индекс активной/текущей выбранной страницы. Смена вкладок идет без анимации.
|
property
|
SwipeEnabled: Boolean
Можно ли перелистывать страницы пальцем или нет. |
property
|
TabsHeight: Single
Высота вкладок. Если указано 0, то вкладки будут стандартной высоты, согласно платформе. Если требуется скрыть вкладки, то нужно воспользоваться TabsPosition = Invisible
|
property
|
TabsPosition: TfgTabsPosition
Положение вкладок относительно контрола. |
property
|
TintColor: TAlphaColor
Цветовой оттенок вкладки. |
property
|
TintColorName: TfgAssetName
Ресурс цвета оттенка вкладки. Если указан ресурс цвета, то он имеет более высокий приоритет над TintColor . Поэтому именно он и будет использоваться. Если же в ресурсе цвет не указан (Null) или его нет, то будет использоваться TintColor .
|
property
|
TitleTextSettings: TfgPageTitleTextSettings
Настройки отображения заголовков на вкладках. |
События
event
|
OnPageSelecting: TfgPageSelectingEvent
Срабатывает в процессе смены текущей страницы, позволяя отследить сам процесс смены. |
event
|
OnChanged: TNotifyEvent
Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Вызывается только, когда пользователь интерактивно меняет активную вкладку.
|
event
|
OnPageSelected: TfgPageSelectedEvent
Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Дополнительно передает индекс выбранной страницы и сам экземпляр страницы. |
Константы
const
|
UndefinedPageIndex: Integer
Описание отсутствует. |
const
|
DefaultTabsHeight: Integer
Описание отсутствует. |
const
|
DefaultTabsPosition: TfgTabsPosition
Описание отсутствует. |
const
|
DefaultTintColor: TAlphaColor
Описание отсутствует. |
const
|
DefaultSwipeEnabled: Boolean
Описание отсутствует. |