Материал из Wiki.crossplatform.ru

Текущая версия на 14:34, 12 января 2009

Внимание: Актуальная версия перевода документации находится здесь

__NOTOC__

[править] QCompleter Class Reference
^{[модуль QtGui ]}

The QCompleter class provides completions based on an item model. Далее...

 #include <QCompleter>

Inherits QObject.

Класс был добавлен в Qt 4.2.

• Список всех членов, включая унаследованные

[править] Открытые типы

• enum CompletionMode { PopupCompletion, InlineCompletion, UnfilteredPopupCompletion }
• enum ModelSorting { UnsortedModel, CaseSensitivelySortedModel, CaseInsensitivelySortedModel }

[править] Свойства

• 1 свойство, унаследованное от QObject

[править] Открытые функции

• QCompleter ( QObject * parent = 0 )
• QCompleter ( QAbstractItemModel * model, QObject * parent = 0 )
• QCompleter ( const QStringList & list, QObject * parent = 0 )
• ~QCompleter ()
• Qt::CaseSensitivity caseSensitivity () const
• int completionColumn () const
• int completionCount () const
• CompletionMode completionMode () const
• QAbstractItemModel * completionModel () const
• QString completionPrefix () const
• int completionRole () const
• QString currentCompletion () const
• QModelIndex currentIndex () const
• int currentRow () const
• QAbstractItemModel * model () const
• ModelSorting modelSorting () const
• virtual QString pathFromIndex ( const QModelIndex & index ) const
• QAbstractItemView * popup () const
• void setCaseSensitivity ( Qt::CaseSensitivity caseSensitivity )
• void setCompletionColumn ( int column )
• void setCompletionMode ( CompletionMode mode )
• void setCompletionRole ( int role )
• bool setCurrentRow ( int row )
• void setModel ( QAbstractItemModel * model )
• void setModelSorting ( ModelSorting sorting )
• void setPopup ( QAbstractItemView * popup )
• void setWidget ( QWidget * widget )
• virtual QStringList splitPath ( const QString & path ) const
• QWidget * widget () const
• bool wrapAround () const

• 29 открытых функций, унаследованных от QObject

[править] Открытые слоты

• void complete ( const QRect & rect = QRect() )
• void setCompletionPrefix ( const QString & prefix )
• void setWrapAround ( bool wrap )

• 1 открытый слот, унаследованный от QObject

[править] Сигналы

• void activated ( const QString & text )
• void activated ( const QModelIndex & index )
• void highlighted ( const QString & text )
• void highlighted ( const QModelIndex & index )

• 1 сигнал, унаследованный от QObject

[править] Дополнительные унаследованные члены

• 5 статических открытых членов, унаследованных от QObject
• 7 защищенных функций, унаследованных от QObject

[править] Подробное описание

The QCompleter class provides completions based on an item model.

You can use QCompleter to provide auto completions in any Qt widget, such as QLineEdit and QComboBox. When the user starts typing a word, QCompleter suggests possible ways of completing the word, based on a word list. The word list is provided as a QAbstractItemModel. (For simple applications, where the word list is static, you can pass a QStringList to QCompleter's constructor.)

• Basic Usage
• Iterating Through Completions
• The Completion Model
• Handling Tree Models

[править] Basic Usage

A QCompleter is used typically with a QLineEdit or QComboBox. For example, here's how to provide auto completions from a simple word list in a QLineEdit:

 QStringList wordList;
 wordList << "alpha" << "omega" << "omicron" << "zeta";
 
 QLineEdit *lineEdit = new QLineEdit(this);
 
 QCompleter *completer = new QCompleter(wordList, this);
 completer->setCaseSensitivity(Qt::CaseInsensitive);
 lineEdit->setCompleter(completer);

A QDirModel can be used to provide auto completion of file names. Пример:

 QCompleter *completer = new QCompleter(this);
 completer->setModel(new QDirModel(completer));
 lineEdit->setCompleter(completer);

To set the model on which QCompleter should operate, call setModel(). By default, QCompleter will attempt to match the completion prefix (i.e., the word that the user has started typing) against the Qt::EditRole data stored in column 0 in the model case sensitively. This can be changed using setCompletionRole(), setCompletionColumn(), and setCaseSensitivity().

If the model is sorted on the column and role that are used for completion, you can call setModelSorting() with either QCompleter::CaseSensitivelySortedModel or QCompleter::CaseInsensitivelySortedModel as the argument. On large models, this can lead to significant performance improvements, because QCompleter can then use binary search instead of linear search.

The model can be a list model, a table model, or a tree model. Completion on tree models is slightly more involved and is covered in the Handling Tree Models section below.

The completionMode() determines the mode used to provide completions to the user.

[править] Iterating Through Completions

To retrieve a single candidate string, call setCompletionPrefix() with the text that needs to be completed and call currentCompletion(). You can iterate through the list of completions as below:

 for (int i = 0; completer->setCurrentRow(i); i++)
     qDebug() << completer->currentCompletion() << " is match number " << i;

completionCount() returns the total number of completions for the current prefix. completionCount() should be avoided when possible, since it requires a scan of the entire model.

[править] The Completion Model

completionModel() return a list model that contains all possible completions for the current completion prefix, in the order in which they appear in the model. This model can be used to display the current completions in a custom view. Calling setCompletionPrefix() automatically refreshes the completion model.

[править] Handling Tree Models

QCompleter can look for completions in tree models, assuming that any item (or sub-item or sub-sub-item) can be unambiguously represented as a string by specifying the path to the item. The completion is then performed one level at a time.

Let's take the example of a user typing in a file system path. The model is a (hierarchical) QDirModel. The completion occurs for every element in the path. For example, if the current text is C:\Wind, QCompleter might suggest Windows to complete the current path element. Similarly, if the current text is C:\Windows\Sy, QCompleter might suggest System.

For this kind of completion to work, QCompleter needs to be able to split the path into a list of strings that are matched at each level. For C:\Windows\Sy, it needs to be split as "C:", "Windows" and "Sy". The default implementation of splitPath(), splits the completionPrefix using QDir::separator() if the model is a QDirModel.

To provide completions, QCompleter needs to know the path from an index. This is provided by pathFromIndex(). The default implementation of pathFromIndex(), returns the data for the completionRole() for list models and the absolute file path if the mode is a QDirModel.

See also QAbstractItemModel, QLineEdit, QComboBox, and Completer Example.

[править] Описание типов

[править]

enum QCompleter::CompletionMode

This enum specifies how completions are provided to the user.

See also setCompletionMode().

[править]

enum QCompleter::ModelSorting

This enum specifies how the items in the model are sorted.

See also setModelSorting().

[править] Описание cвойств

[править]

caseSensitivity : Qt::CaseSensitivity

This property holds the case sensitivity of the matching.

The default is Qt::CaseSensitive.

Функции доступа:

• Qt::CaseSensitivity caseSensitivity () const
• void setCaseSensitivity ( Qt::CaseSensitivity caseSensitivity )

See also completionColumn, completionRole, and modelSorting.

[править]

completionColumn : int

This property holds the column in the model in which completions are searched for.

If the popup() is a QListView, it is automatically setup to display this column.

By default, the match column is 0.

Функции доступа:

• int completionColumn () const
• void setCompletionColumn ( int column )

See also completionRole and caseSensitivity.

[править]

completionMode : CompletionMode

This property holds how the completions are provided to the user.

The default value is QCompleter::PopupCompletion.

Функции доступа:

• CompletionMode completionMode () const
• void setCompletionMode ( CompletionMode mode )

[править]

completionPrefix : QString

This property holds the completion prefix used to provide completions.

The completionModel() is updated to reflect the list of possible matches for prefix.

Функции доступа:

• QString completionPrefix () const
• void setCompletionPrefix ( const QString & prefix )

[править]

completionRole : int

This property holds the item role to be used to query the contents of items for matching.

The default role is Qt::EditRole.

Функции доступа:

• int completionRole () const
• void setCompletionRole ( int role )

See also completionColumn and caseSensitivity.

[править]

modelSorting : ModelSorting

This property holds the way the model is sorted.

By default, no assumptions are made about the order of the items in the model that provides the completions.

If the model's data for the completionColumn() and completionRole() is sorted in ascending order, you can set this property to CaseSensitivelySortedModel or CaseInsensitivelySortedModel. On large models, this can lead to significant performance improvements because the completer object can then use a binary search algorithm instead of linear search algorithm.

The sort order (i.e ascending or descending order) of the model is determined dynamically by inspecting the contents of the model.

Note: The performance improvements described above cannot take place when the completer's caseSensitivity is different to the case sensitivity used by the model's when sorting.

Функции доступа:

• ModelSorting modelSorting () const
• void setModelSorting ( ModelSorting sorting )

See also setCaseSensitivity() and QCompleter::ModelSorting.

[править]

wrapAround : bool

This property holds the completions wrap around when navigating through items.

The default is true.

Это свойство было введено в Qt 4.3.

Функции доступа:

• bool wrapAround () const
• void setWrapAround ( bool wrap )

[править] Описание функций-членов

[править]

QCompleter::QCompleter ( QObject * parent = 0 )

Constructs a completer object with the given parent.

[править]

QCompleter::QCompleter ( QAbstractItemModel * model, QObject * parent = 0 )

Constructs a completer object with the given parent that provides completions from the specified model.

[править]

QCompleter::QCompleter ( const QStringList & list, QObject * parent = 0 )

Constructs a QCompleter object with the given parent that uses the specified list as a source of possible completions.

[править]

QCompleter::~QCompleter ()

Destroys the completer object.

[править]

void QCompleter::activated ( const QString & text ) [signal]

This signal is sent when an item in the popup() is activated by the user (by clicking or pressing return). The item's text is given.

[править]

void QCompleter::activated ( const QModelIndex & index ) [signal]

Эта перегруженная функция предоставлена для удобства.

This signal is sent when an item in the popup() is activated by the user. (by clicking or pressing return). The item's index in the completionModel() is given.

[править]

void QCompleter::complete ( const QRect & rect = QRect() ) [slot]

For QCompleter::PopupCompletion and QCompletion::UnfilteredPopupCompletion modes, calling this function displays the popup displaying the current completions. By default, if rect is not specified, the popup is displayed on the bottom of the widget(). If rect is specified the popup is displayed on the left edge of the rectangle.

For QCompleter::InlineCompletion mode, the highlighted() signal is fired with the current completion.

[править]

int QCompleter::completionCount () const

Returns the number of completions for the current prefix. For an unsorted model with a large number of items this can be expensive. Use setCurrentRow() and currentCompletion() to iterate through all the completions.

[править]

QAbstractItemModel * QCompleter::completionModel () const

Returns the completion model. The completion model is a read-only list model that contains all the possible matches for the current completion prefix. The completion model is auto-updated to reflect the current completions.

See also completionPrefix and model().

[править]

QString QCompleter::currentCompletion () const

Returns the current completion string. This includes the completionPrefix. When used alongside setCurrentRow(), it can be used to iterate through all the matches.

See also setCurrentRow() and currentIndex().

[править]

QModelIndex QCompleter::currentIndex () const

Returns the model index of the current completion in the completionModel().

See also setCurrentRow(), currentCompletion(), and model().

[править]

int QCompleter::currentRow () const

Returns the current row.

See also setCurrentRow().

[править]

void QCompleter::highlighted ( const QString & text ) [signal]

This signal is sent when an item in the popup() is highlighted by the user. It is also sent if complete() is called with the completionMode() set to QCOmpleter::InlineCompletion. The item's text is given.

[править]

void QCompleter::highlighted ( const QModelIndex & index ) [signal]

Эта перегруженная функция предоставлена для удобства.

This signal is sent when an item in the popup() is highlighted by the user. It is also sent if complete() is called with the completionMode() set to QCompleter::InlineCompletion. The item's index in the completionModel() is given.

[править]

QAbstractItemModel * QCompleter::model () const

Returns the model that provides completion strings.

See also setModel() and completionModel().

[править]

QString QCompleter::pathFromIndex ( const QModelIndex & index ) const [virtual]

Returns the path for the given index. The completer object uses this to obtain the completion text from the underlying model.

The default implementation returns the edit role of the item for list models. It returns the absolute file path if the model is a QDirModel.

See also splitPath().

[править]

QAbstractItemView * QCompleter::popup () const

Returns the popup used to display completions.

See also setPopup().

[править]

bool QCompleter::setCurrentRow ( int row )

Sets the current row to the row specified. Возвращает true в случае успеха; при неудаче возвращается false.

This function may be used along with currentCompletion() to iterate through all the possible completions.

See also currentRow(), currentCompletion(), and completionCount().

[править]

void QCompleter::setModel ( QAbstractItemModel * model )

Sets the model which provides completions to model. The model can be list model or a tree model. If a model has been already previously set and it has the QCompleter as its parent, it is deleted.

For convenience, if model is a QDirModel, QCompleter switches its caseSensitivity to Qt::CaseInsensitive on Windows and Qt::CaseSensitive on other platforms.

See also completionModel(), modelSorting, and Handling Tree Models.

[править]

void QCompleter::setPopup ( QAbstractItemView * popup )

Sets the popup used to display completions to popup. QCompleter takes ownership of the view.

A QListView is automatically created when the completionMode() is set to QCompleter::PopupCompletion or QCompleter::UnfilteredPopupCompletion. The default popup displays the completionColumn().

Ensure that this function is called before the view settings are modified. This is required since view's properties may require that a model has been set on the view (for example, hiding columns in the view requires a model to be set on the view).

See also popup().

[править]

void QCompleter::setWidget ( QWidget * widget )

Sets the widget for which completion are provided for to widget. This function is automatically called when a QCompleter is set on a QLineEdit using QLineEdit::setCompleter() or on a QComboBox using QComboBox::setCompleter(). The widget needs to be set explicitly when providing completions for custom widgets.

See also widget(), setModel(), and setPopup().

[править]

QStringList QCompleter::splitPath ( const QString & path ) const [virtual]

Splits the given path into strings that are used to match at each level in the model().

The default implementation of splitPath() splits a file system path based on QDir::separator() when the sourceModel() is a QDirModel.

When used with list models, the first item in the returned list is used for matching.

See also pathFromIndex() and Handling Tree Models.

[править]

QWidget * QCompleter::widget () const

Returns the widget for which the completer object is providing completions.

See also setWidget().