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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
Строка 7: Строка 7:
  
 
<p class="class-inheritance"><span class="type-border">[[System.TObject|TObject]]</span> -> <span class="type-border">[[FGX.ListMenu.TfgListMenuSelectionController|TfgListMenuSelectionController]]</span></p>
 
<p class="class-inheritance"><span class="type-border">[[System.TObject|TObject]]</span> -> <span class="type-border">[[FGX.ListMenu.TfgListMenuSelectionController|TfgListMenuSelectionController]]</span></p>
 +
 +
  
 
== Описание ==
 
== Описание ==
Строка 19: Строка 21:
 
<span style="color:gray">Описание отсутствует.</span>
 
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}
 +
  
 
== Методы ==
 
== Методы ==
Строка 41: Строка 44:
 
<p>Сбрасывает текущее выделение пункта меню с указанным индексом.</p>
 
<p>Сбрасывает текущее выделение пункта меню с указанным индексом.</p>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectItem(const AItemIndex: [[Integer]])</code>
+
| <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>
 
<p>Выделяет пункт меню с указанным индексом.</p><div class="info">Работает только, если стиль пункта меню поддерживает выделение <i>TfgCollectionViewStyle.Selectable</i> и стоит режим выделения отличный от <i>SelectionMode != TfgListMenuSelectionMode.None</i> .</div>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectAllItems()</code>
+
| <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>
 
<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>
 
|}
 
|}
 +
  
 
== Свойства ==
 
== Свойства ==
Строка 63: Строка 74:
 
<p>Ссылка на меню с которым работает контроллер.</p>
 
<p>Ссылка на меню с которым работает контроллер.</p>
 
|}
 
|}
 +
  
 
== Константы ==
 
== Константы ==

Версия 02:15, 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

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