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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 10 промежуточных версий этого же участника)
Строка 11: Строка 11:
  
 
<p>Контроллер выделения пунктов меню. Отвечает за централизованное управление выделением пунктов меню.</p>
 
<p>Контроллер выделения пунктов меню. Отвечает за централизованное управление выделением пунктов меню.</p>
 +
== Конструкторы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(const AListMenu: [[FGX.ListMenu.TfgCustomListMenu|TfgCustomListMenu]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|}
 +
 +
== Методы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">BeginUpdate()</code>
 +
 +
<p>Информирует о том, что сейчас начнется пакетная обработка выделения. На это время оповещение нативного контрола приостанавливается и продолжится, после вызова парного метода <i>EndUpdate</i> .</p><div class="info"><i>BeginUpdate</i> - <i>EndUpdate</i> учитывают количество вызовов. Поэтому методы можно вызывать несколько раз. Однако, при этом выравнивание будет вызвано, когда будут вызваны все парные <i>EndUpdate</i> .</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">EndUpdate()</code>
 +
 +
<p>Информирует контрол о том, что заканчивается пакетная обработка выделения. Если этот вызов <i>EndUpdate</i> является последним парным к <i>BeginUpdate</i> , то нативный контрол получает обновленный список выделения.</p><div class="info"><i>BeginUpdate</i> - <i>EndUpdate</i> учитывают количество вызовов. Поэтому методы можно вызывать несколько раз. Однако, при этом выравнивание будет вызвано, когда будут вызваны все парные <i>EndUpdate</i> .</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsUpdating(): [[Boolean]]</code>
 +
<p>True - если контрол находится в состоянии пакетной обработки выделения. При этом на этот период уведомление нативного контрола о изменении выделения отключается.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ResetSelection()</code>
 +
<p>Сбрасывает текущее выделение всех выделенных пунктов меню.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ResetSelection(const AItemIndex: [[Integer]])</code>
 +
<p>Сбрасывает текущее выделение пункта меню с указанным индексом.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Select(const AItemIndex: [[Integer]])</code>
 +
 +
<p>Выделяет пункт меню с указанным индексом.</p><div class="info">Работает только, если стиль пункта меню поддерживает выделение <i>TfgCollectionViewStyle.Selectable</i> и стоит режим выделения отличный от <i>SelectionMode != TfgListMenuSelectionMode.None</i> .</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">RevertSelection(const AItemIndex: [[Integer]])</code>
 +
 +
<p>Меняет состояние элемента с выделенного на не выделенный и наоборот.</p><div class="info">Если элемент не поддерживает выделение или режим выделения равен TfgListMenuSelectionMode.None, то метод ничего не делает.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectAll()</code>
 +
 +
<p>Выделяет все элементы списка.</p><div class="info">Работает только, если стиль элемента поддерживает выделение <i>TfgListMenuItem.Selectable</i> и стоит режим выделения <i>SelectionMode = TfgListMenuSelectionMode.MultiSelect</i> .</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsSelected(const AItem: [[FGX.ListMenu.Types.TfgListMenuItem|TfgListMenuItem]]): [[Boolean]]</code>
 +
<p>Возвращает True, если элемент выделен.</p>
 +
|}
 +
 +
== Свойства ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Selection: [[TArray<FGX.ListMenu.Types.TfgListMenuItem>]]</code>
 +
<p>Массив индексов выделенных элементов.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Mode: [[FGX.ListMenu.Types.TfgListMenuSelectionMode|TfgListMenuSelectionMode]]</code>
 +
<p>Режим выделения пунктов меню.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ListMenu: [[FGX.ListMenu.TfgCustomListMenu|TfgCustomListMenu]]</code>
 +
<p>Ссылка на меню с которым работает контроллер.</p>
 +
|}
 +
 +
== Константы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSelectionMode: [[FGX.ListMenu.Types.TfgListMenuSelectionMode|TfgListMenuSelectionMode]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|}

Текущая версия на 02:51, 1 июля 2019

Delphi 

TfgListMenuSelectionController = class (TObject)

TObject -> TfgListMenuSelectionController

Описание

Контроллер выделения пунктов меню. Отвечает за централизованное управление выделением пунктов меню.

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

constructor
Create(const AListMenu: TfgCustomListMenu)

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

Методы

procedure
BeginUpdate()

Информирует о том, что сейчас начнется пакетная обработка выделения. На это время оповещение нативного контрола приостанавливается и продолжится, после вызова парного метода EndUpdate .

BeginUpdate - EndUpdate учитывают количество вызовов. Поэтому методы можно вызывать несколько раз. Однако, при этом выравнивание будет вызвано, когда будут вызваны все парные EndUpdate .
procedure
EndUpdate()

Информирует контрол о том, что заканчивается пакетная обработка выделения. Если этот вызов EndUpdate является последним парным к BeginUpdate , то нативный контрол получает обновленный список выделения.

BeginUpdate - EndUpdate учитывают количество вызовов. Поэтому методы можно вызывать несколько раз. Однако, при этом выравнивание будет вызвано, когда будут вызваны все парные EndUpdate .
function
IsUpdating(): Boolean

True - если контрол находится в состоянии пакетной обработки выделения. При этом на этот период уведомление нативного контрола о изменении выделения отключается.

procedure
ResetSelection()

Сбрасывает текущее выделение всех выделенных пунктов меню.

procedure
ResetSelection(const AItemIndex: Integer)

Сбрасывает текущее выделение пункта меню с указанным индексом.

procedure
Select(const AItemIndex: Integer)

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

Работает только, если стиль пункта меню поддерживает выделение TfgCollectionViewStyle.Selectable и стоит режим выделения отличный от SelectionMode != TfgListMenuSelectionMode.None .
procedure
RevertSelection(const AItemIndex: Integer)

Меняет состояние элемента с выделенного на не выделенный и наоборот.

Если элемент не поддерживает выделение или режим выделения равен TfgListMenuSelectionMode.None, то метод ничего не делает.
procedure
SelectAll()

Выделяет все элементы списка.

Работает только, если стиль элемента поддерживает выделение TfgListMenuItem.Selectable и стоит режим выделения SelectionMode = TfgListMenuSelectionMode.MultiSelect .
function
IsSelected(const AItem: TfgListMenuItem): Boolean

Возвращает True, если элемент выделен.

Свойства

property
Selection: [[TArray<FGX.ListMenu.Types.TfgListMenuItem>]]

Массив индексов выделенных элементов.

property
Mode: TfgListMenuSelectionMode

Режим выделения пунктов меню.

property
ListMenu: TfgCustomListMenu

Ссылка на меню с которым работает контроллер.

Константы

const
DefaultSelectionMode: TfgListMenuSelectionMode

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

Источник — http://docs.fgx-native.com/index.php?title=FGX.ListMenu.TfgListMenuSelectionController&oldid=26070