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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 38 промежуточных версий этого же участника)
Строка 1: Строка 1:
* [[ FGX.Button | Вверх к родителю: FGX.Button ]]
+
* [[ FGX.Button.TfgCustomButton | Вверх к родителю: TfgCustomButton ]]
* [[ FGX.Button.TfgButton_Methods | Методы ]]
+
* [[ FGX.Button | К модулю: FGX.Button ]]
* [[ FGX.Button.TfgButton_Properties | Свойства ]]
 
  
 
Delphi
 
Delphi
  
<code>TfgButton = class (TfgCustomButton)</code>
+
<syntaxhighlight lang="Delphi">TfgButton = class (TfgCustomButton)</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.Button.TfgCustomButton|TfgCustomButton]]</span> -> <span class="type-border">[[FGX.Button.TfgButton|TfgButton]]</span></p>
  
{| class="wikitable sortable"
+
== Описание ==
|}
 
  
== Методы ==
+
<span style="color:gray">Описание отсутствует.</span>
 +
== Свойства ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
|}
+
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Kind: [[FGX.Button.Types.TfgButtonKind|TfgButtonKind]]</code>
 +
<p>Вид кнопки, который отвечает за ее внешний вид.</p><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.Kind|Kind]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Appearance: [[FGX.Button.Appearance.TfgButtonAppearance|TfgButtonAppearance]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>CharCase: [[FGX.Button.TfgButtonTextCharCase|TfgButtonTextCharCase]]</code>
 +
<p>Режим отображения надписи (оригинальное отображение, в нижнем регистре, в верхнем регистре, первая буква в предложении заглавная).</p><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.CharCase|CharCase]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Text: [[string]]</code>
  
== Свойства ==
+
<p>Надпись на кнопке.</p><div class="info">Надпись не выводится при <i>ImageLocation = TfgImageLocation.Center</i></div><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.Text|Text]].</small></small>
 
+
|-
{| class="wikitable sortable"
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IconName: [[TfgAssetName|TfgAssetName]]</code>
 +
<p>Название ресурса, содержащего картинку, которая будет выводиться на кнопке.</p><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.IconName|IconName]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextSettings: [[FGX.Button.Types.TfgButtonTextSettings|TfgButtonTextSettings]]</code>
 +
<p>Настройки шрифта/цветов отображения надписи <i>Text</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.TextSettings|TextSettings]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextShadow: [[FGX.Types.Shadow.TfgBorderShadow|TfgBorderShadow]]</code>
 +
<p>Тень текста.</p><small style="color: red"><small>Описание взято от [[FGX.Button.TfgCustomButton.TextShadow|TextShadow]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColor: [[TAlphaColor]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <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>
 +
<p>Нужно ли использовать заданные внешние отступы <i>Margins</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.AlignWithMargins|AlignWithMargins]].</small></small>
 +
|-
 +
| <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>Enabled: [[Boolean]]</code>
 +
<p>Настройка отключения реакции на воздействия пользователя на компонент.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Enabled|Enabled]].</small></small>
 +
|-
 +
| <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>
 +
<p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.LookupName|LookupName]].</small></small>
 +
|-
 +
| <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.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.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.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.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.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: [[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>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <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>
 +
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Visible|Visible]].</small></small>
 
|}
 
|}
  
Строка 25: Строка 95:
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
|}
+
|-
 
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code>
== Константы ==
+
<p>Вызывается перед удалением контрола. А именно перед вызовом деструктора.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnDestroy|OnDestroy]].</small></small>
 
+
|-
{| class="wikitable sortable"
+
| <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>OnPaint: [[TfgPaintEvent|TfgPaintEvent]]</code>
 +
<p>Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnPaint|OnPaint]].</small></small>
 +
|-
 +
| <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>OnZoom: [[TfgZoomEvent|TfgZoomEvent]]</code>
 +
<p>Срабатывает, когда пользователь опускает два пальца на экран и начинает их сводить/разводить.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnZoom|OnZoom]].</small></small>
 +
|-
 +
| <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: [[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>
 +
<p>Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnTap|OnTap]].</small></small>
 
|}
 
|}

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

Delphi

TfgButton = class (TfgCustomButton)

TComponent -> TfgControl -> TfgCustomButton -> TfgButton

Описание

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

Свойства

property
Kind: TfgButtonKind

Вид кнопки, который отвечает за ее внешний вид.

Описание взято от Kind.
property
Appearance: TfgButtonAppearance

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

property
CharCase: TfgButtonTextCharCase

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

Описание взято от CharCase.
property
Text: string

Надпись на кнопке.

Надпись не выводится при ImageLocation = TfgImageLocation.Center
Описание взято от Text.
property
IconName: TfgAssetName

Название ресурса, содержащего картинку, которая будет выводиться на кнопке.

Описание взято от IconName.
property
TextSettings: TfgButtonTextSettings

Настройки шрифта/цветов отображения надписи Text .

Описание взято от TextSettings.
property
TextShadow: TfgBorderShadow

Тень текста.

Описание взято от TextShadow.
property
TintColor: TAlphaColor

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

property
TintColorName: TfgAssetName

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

property
Alignment: TfgControlAlignment

Настройки выравнивания контрола в рамках родителя.

Описание взято от Alignment.
property
AlignWithMargins: Boolean

Нужно ли использовать заданные внешние отступы Margins .

Описание взято от AlignWithMargins.
property
BackgroundName: TfgAssetName

Настройки отображения заднего фона контрола.

Описание взято от BackgroundName.
property
Enabled: Boolean

Настройка отключения реакции на воздействия пользователя на компонент.

Описание взято от Enabled.
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
OnDestroy: TNotifyEvent

Вызывается перед удалением контрола. А именно перед вызовом деструктора.

Описание взято от OnDestroy.
event
OnResized: TfgResizedEvent

Вызывается когда контрол изменил свой размерм.

Описание взято от OnResized.
event
OnPaint: TfgPaintEvent

Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.

Описание взято от OnPaint.
event
OnLongTap: TfgLongTapEvent

Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.

Описание взято от OnLongTap.
event
OnZoom: TfgZoomEvent

Срабатывает, когда пользователь опускает два пальца на экран и начинает их сводить/разводить.

Описание взято от OnZoom.
event
OnPositionChanged: TfgPositionChangedEvent

Вызывается когда контрол поменял свою позицию.

Описание взято от OnPositionChanged.
event
OnTouch: TfgTouchEvent

Вызывается в момент касания пользователем экрана устройства.

Описание взято от OnTouch.
event
OnTap: TNotifyEvent

Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.

Описание взято от OnTap.