FGX.ListMenu.TfgListMenu: различия между версиями
Admin (обсуждение | вклад) (summary) |
Admin (обсуждение | вклад) (summary) |
||
(не показано 19 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
* [[ FGX.ListMenu.TfgCustomListMenu | Вверх к родителю: TfgCustomListMenu ]] | * [[ FGX.ListMenu.TfgCustomListMenu | Вверх к родителю: TfgCustomListMenu ]] | ||
+ | * [[ FGX.ListMenu | К модулю: FGX.ListMenu ]] | ||
Delphi | Delphi | ||
<syntaxhighlight lang="Delphi">TfgListMenu = class (TfgCustomListMenu)</syntaxhighlight> | <syntaxhighlight lang="Delphi">TfgListMenu = class (TfgCustomListMenu)</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.ListMenu.TfgCustomListMenu|TfgCustomListMenu]]</span> -> <span class="type-border">[[FGX.ListMenu.TfgListMenu|TfgListMenu]]</span></p> | ||
== Описание == | == Описание == | ||
− | < | + | <p>Компонент вывода меню. Поддерживает разные стили пунктов меню, позволяя удобно и быстро создать меню, отвечающее требования по внешнему виду на каждой целевой платформе.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu|TfgCustomListMenu]].</small></small> |
− | |||
== Свойства == | == Свойства == | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Appearance: [[FGX.ListMenu.Appearance.TfgListMenuAppearance|TfgListMenuAppearance]]</code> | ||
+ | <span style="color:gray">Описание отсутствует.</span> | ||
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Items: [[FGX.ListMenu.Types.TfgListMenuItemsCollection|TfgListMenuItemsCollection]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Items: [[FGX.ListMenu.Types.TfgListMenuItemsCollection|TfgListMenuItemsCollection]]</code> | ||
− | < | + | <p>Пункты меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.Items|Items]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[.TfgListMenuSelectionMode|TfgListMenuSelectionMode]]</code> | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[FGX.ListMenu.Types.TfgListMenuSelectionMode|TfgListMenuSelectionMode]]</code> |
− | < | + | <p>Режим выделения пунктов меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.SelectionMode|SelectionMode]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code> | ||
− | < | + | <p>Цвет выделение пунктов меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.SelectionColor|SelectionColor]].</small></small> |
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorName: [[TfgAssetName|TfgAssetName]]</code> | ||
+ | <p>Название ресурса цвета выделения пунктов меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.SelectionColorName|SelectionColorName]].</small></small> | ||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IconVisibleMode: [[FGX.ListMenu.Types.TfgListMenuIconVisibleMode|TfgListMenuIconVisibleMode]]</code> | ||
+ | <p>Способ отображения иконки <i>TfgListMenuItem.IconName</i> у пунктов меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.IconVisibleMode|IconVisibleMode]].</small></small> | ||
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Alignment: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Alignment: [[FGX.Controls.Types.TfgControlAlignment|TfgControlAlignment]]</code> |
− | Настройки выравнивания контрола в рамках родителя.< | + | <p>Настройки выравнивания контрола в рамках родителя.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Alignment|Alignment]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignWithMargins: [[Boolean]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignWithMargins: [[Boolean]]</code> | ||
− | Нужно ли использовать заданные внешние отступы | + | <p>Нужно ли использовать заданные внешние отступы <i>Margins</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.AlignWithMargins|AlignWithMargins]].</small></small> |
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Enabled: [[Boolean]]</code> | ||
+ | <p>Настройка отключения реакции на воздействия пользователя на компонент.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Enabled|Enabled]].</small></small> | ||
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BackgroundName: [[ | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BackgroundName: [[TfgAssetName|TfgAssetName]]</code> |
− | Настройки отображения заднего фона контрола.< | + | <p>Настройки отображения заднего фона контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.BackgroundName|BackgroundName]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Locked: [[Boolean]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Locked: [[Boolean]]</code> | ||
− | Позволяет заблокировать выделение компонента мышкой в дизайн тайме.< | + | <p>Позволяет заблокировать выделение компонента мышкой в дизайн тайме.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Locked|Locked]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code> | ||
− | Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.< | + | <p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.LookupName|LookupName]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[.TfgPositionMode|TfgPositionMode]]</code> | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[FGX.Controls.Types.TfgPositionMode|TfgPositionMode]]</code> |
− | Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).< | + | <p>Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.PositionMode|PositionMode]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX.Controls.Types.TfgPosition|TfgPosition]]</code> |
− | Позиция контрола в локальных логических координатах родителя | + | <p>Позиция контрола в локальных логических координатах родителя <i>Parent</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Position|Position]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>RelativePosition: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>RelativePosition: [[FGX.Controls.Types.TfgRelativePosition|TfgRelativePosition]]</code> |
− | Относительная позиция контролов относительно родителя. Актуально только для | + | <p>Относительная позиция контролов относительно родителя. Актуально только для <b>PositionMode = Relative</b> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.RelativePosition|RelativePosition]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Size: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Size: [[FGX.Controls.Types.TfgSize|TfgSize]]</code> |
− | Размер контрола в логических координатах.< | + | <p>Размер контрола в логических координатах.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Size|Size]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX.Controls.Types.TfgConstraints|TfgConstraints]]</code> |
− | Ограничение на размеры контрола.< | + | <p>Ограничение на размеры контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Constraints|Constraints]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX. | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX.Controls.Types.TfgMargins|TfgMargins]]</code> |
− | Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.< | + | <p>Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Margins|Margins]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[.TfgGestureKinds|TfgGestureKinds]]</code> | + | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[FGX.Controls.TfgGestureKinds|TfgGestureKinds]]</code> |
− | Виды поддерживаемых жестов.< | + | <p>Виды поддерживаемых жестов.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.GestureKinds|GestureKinds]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HitTest: [[Boolean]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HitTest: [[Boolean]]</code> | ||
Строка 62: | Строка 76: | ||
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Opacity: [[Single]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Opacity: [[Single]]</code> | ||
− | Прозрачность контрола.< | + | <p>Прозрачность контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Opacity|Opacity]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code> | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code> | ||
− | Видимость контрола.< | + | <p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Visible|Visible]].</small></small> |
|} | |} | ||
Строка 72: | Строка 86: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSelectionChanged: [[TfgSelectionChangedEvent|TfgSelectionChangedEvent]]</code> |
− | < | + | <p>Пользователь совершил выделение одного или нескольких пунктов меню. За возможность выделения пункта отвечает свойство <i>TfgListMenuItem.Selectable</i> и стиль <i>TfgListMenuItem.Style</i> .</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.OnSelectionChanged|OnSelectionChanged]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnItemCheckChanged: [[TfgItemCheckChangedEvent]]</code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnItemCheckChanged: [[TfgItemCheckChangedEvent|TfgItemCheckChangedEvent]]</code> |
− | < | + | <p>Пользователь нажал на CheckBox/Switch в пункте меню.</p><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.OnItemCheckChanged|OnItemCheckChanged]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTapItem: [[TfgItemTapEvent]]</code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTapItem: [[TfgItemTapEvent|TfgItemTapEvent]]</code> |
− | < | + | |
+ | <p>Пользователь нажал на пункт меню.</p><div class="info">В зависимости от режима выделения <i>SelectionMode</i> , стиля пункта меню <i>TfgListMenuItem.Style</i> и свойства <i>TfgListMenuItem.Selectable</i> нажатие на пункт не обязательно приводит к выделению.</div><small style="color: red"><small>Описание взято от [[FGX.ListMenu.TfgCustomListMenu.OnTapItem|OnTapItem]].</small></small> | ||
|- | |- | ||
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code> | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code> | ||
− | Вызывается перед удалением контрола. А именно перед вызовом деструктора.< | + | <p>Вызывается перед удалением контрола. А именно перед вызовом деструктора.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnDestroy|OnDestroy]].</small></small> |
− | |||
− | |||
− | |||
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnResized: [[TfgResizedEvent|TfgResizedEvent]]</code> |
− | Вызывается | + | <p>Вызывается когда контрол изменил свой размерм.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnResized|OnResized]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTap: [[TfgLongTapEvent]]</code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTap: [[TfgLongTapEvent|TfgLongTapEvent]]</code> |
− | Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.< | + | <p>Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnLongTap|OnLongTap]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPositionChanged: [[TfgPositionChangedEvent]]</code> | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPositionChanged: [[TfgPositionChangedEvent|TfgPositionChangedEvent]]</code> |
− | Вызывается когда контрол поменял свою позицию.< | + | <p>Вызывается когда контрол поменял свою позицию.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnPositionChanged|OnPositionChanged]].</small></small> |
|- | |- | ||
− | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTouch: [[ | + | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTouch: [[TfgTouchEvent|TfgTouchEvent]]</code> |
− | Вызывается в момент касания пользователем экрана устройства.< | + | <p>Вызывается в момент касания пользователем экрана устройства.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnTouch|OnTouch]].</small></small> |
|- | |- | ||
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTap: [[TNotifyEvent]]</code> | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTap: [[TNotifyEvent]]</code> | ||
− | Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.< | + | <p>Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnTap|OnTap]].</small></small> |
|} | |} |
Текущая версия на 17:20, 23 декабря 2022
Delphi
TfgListMenu = class (TfgCustomListMenu)
TComponent -> TfgControl -> TfgCustomListMenu -> TfgListMenu
Описание
Компонент вывода меню. Поддерживает разные стили пунктов меню, позволяя удобно и быстро создать меню, отвечающее требования по внешнему виду на каждой целевой платформе.
Описание взято от TfgCustomListMenu.
Свойства
property
|
Appearance: TfgListMenuAppearance
Описание отсутствует. |
property
|
Items: TfgListMenuItemsCollection
Пункты меню. Описание взято от Items. |
property
|
SelectionMode: TfgListMenuSelectionMode
Режим выделения пунктов меню. Описание взято от SelectionMode. |
property
|
SelectionColor: TAlphaColor
Цвет выделение пунктов меню. Описание взято от SelectionColor. |
property
|
SelectionColorName: TfgAssetName
Название ресурса цвета выделения пунктов меню. Описание взято от SelectionColorName. |
property
|
IconVisibleMode: TfgListMenuIconVisibleMode
Способ отображения иконки TfgListMenuItem.IconName у пунктов меню. Описание взято от IconVisibleMode. |
property
|
Alignment: TfgControlAlignment
Настройки выравнивания контрола в рамках родителя. Описание взято от Alignment. |
property
|
AlignWithMargins: Boolean
Нужно ли использовать заданные внешние отступы Margins . Описание взято от AlignWithMargins. |
property
|
Enabled: Boolean
Настройка отключения реакции на воздействия пользователя на компонент. Описание взято от Enabled. |
property
|
BackgroundName: TfgAssetName
Настройки отображения заднего фона контрола. Описание взято от BackgroundName. |
property
|
Locked: Boolean
Позволяет заблокировать выделение компонента мышкой в дизайн тайме. Описание взято от Locked. |
property
|
LookupName: string
Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева. Описание взято от LookupName. |
property
|
PositionMode: TfgPositionMode
Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно). Описание взято от PositionMode. |
property
|
Position: TfgPosition
Позиция контрола в локальных логических координатах родителя Parent . Описание взято от Position. |
property
|
RelativePosition: TfgRelativePosition
Относительная позиция контролов относительно родителя. Актуально только для PositionMode = Relative . Описание взято от RelativePosition. |
property
|
Size: TfgSize
Размер контрола в логических координатах. Описание взято от Size. |
property
|
Constraints: TfgConstraints
Ограничение на размеры контрола. Описание взято от Constraints. |
property
|
Margins: TfgMargins
Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера. Описание взято от Margins. |
property
|
GestureKinds: TfgGestureKinds
Виды поддерживаемых жестов. Описание взято от GestureKinds. |
property
|
HitTest: Boolean
Описание отсутствует. |
property
|
Opacity: Single
Прозрачность контрола. Описание взято от Opacity. |
property
|
Visible: Boolean
Видимость контрола. Описание взято от Visible. |
События
event
|
OnSelectionChanged: TfgSelectionChangedEvent
Пользователь совершил выделение одного или нескольких пунктов меню. За возможность выделения пункта отвечает свойство TfgListMenuItem.Selectable и стиль TfgListMenuItem.Style . Описание взято от OnSelectionChanged. |
event
|
OnItemCheckChanged: TfgItemCheckChangedEvent
Пользователь нажал на CheckBox/Switch в пункте меню. Описание взято от OnItemCheckChanged. |
event
|
OnTapItem: TfgItemTapEvent
Пользователь нажал на пункт меню. В зависимости от режима выделения SelectionMode , стиля пункта меню TfgListMenuItem.Style и свойства TfgListMenuItem.Selectable нажатие на пункт не обязательно приводит к выделению. Описание взято от OnTapItem.
|
event
|
OnDestroy: TNotifyEvent
Вызывается перед удалением контрола. А именно перед вызовом деструктора. Описание взято от OnDestroy. |
event
|
OnResized: TfgResizedEvent
Вызывается когда контрол изменил свой размерм. Описание взято от OnResized. |
event
|
OnLongTap: TfgLongTapEvent
Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану. Описание взято от OnLongTap. |
event
|
OnPositionChanged: TfgPositionChangedEvent
Вызывается когда контрол поменял свою позицию. Описание взято от OnPositionChanged. |
event
|
OnTouch: TfgTouchEvent
Вызывается в момент касания пользователем экрана устройства. Описание взято от OnTouch. |
event
|
OnTap: TNotifyEvent
Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану. Описание взято от OnTap. |