API reference - Class QCompleter

Notation used in Ruby API documentation

Description: Binding of QCompleter

Class hierarchy: QCompleter » QObject

Sub-classes: CompletionMode, ModelSorting

Public constructors

new QCompleternew(QObject ptr parent = 0)Constructor QCompleter::QCompleter(QObject *parent)
new QCompleternew(QAbstractItemModel ptr model,
QObject ptr parent = 0)
Constructor QCompleter::QCompleter(QAbstractItemModel *model, QObject *parent)
new QCompleternew(string[] completions,
QObject ptr parent = 0)
Constructor QCompleter::QCompleter(const QStringList &completions, QObject *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[event]voidactivated(const QModelIndex index)Signal declaration for QCompleter::activated(const QModelIndex &index)
[event]voidactivated_qs(string text)Signal declaration for QCompleter::activated(const QString &text)
[const]Qt_CaseSensitivitycaseSensitivityMethod Qt::CaseSensitivity QCompleter::caseSensitivity()
voidcaseSensitivity=(const Qt_CaseSensitivity caseSensitivity)Method void QCompleter::setCaseSensitivity(Qt::CaseSensitivity caseSensitivity)
voidcomplete(const QRect rect = QRect())Method void QCompleter::complete(const QRect &rect)
[const]intcompletionColumnMethod int QCompleter::completionColumn()
voidcompletionColumn=(int column)Method void QCompleter::setCompletionColumn(int column)
[const]intcompletionCountMethod int QCompleter::completionCount()
[const]QCompleter_CompletionModecompletionModeMethod QCompleter::CompletionMode QCompleter::completionMode()
voidcompletionMode=(const QCompleter_CompletionMode mode)Method void QCompleter::setCompletionMode(QCompleter::CompletionMode mode)
[const]QAbstractItemModel ptrcompletionModelMethod QAbstractItemModel *QCompleter::completionModel()
[const]stringcompletionPrefixMethod QString QCompleter::completionPrefix()
voidcompletionPrefix=(string prefix)Method void QCompleter::setCompletionPrefix(const QString &prefix)
[const]intcompletionRoleMethod int QCompleter::completionRole()
voidcompletionRole=(int role)Method void QCompleter::setCompletionRole(int role)
[const]stringcurrentCompletionMethod QString QCompleter::currentCompletion()
[const]QModelIndexcurrentIndexMethod QModelIndex QCompleter::currentIndex()
[const]intcurrentRowMethod int QCompleter::currentRow()
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QCompleter::destroyed(QObject *)
[event]voidhighlighted(const QModelIndex index)Signal declaration for QCompleter::highlighted(const QModelIndex &index)
[event]voidhighlighted_qs(string text)Signal declaration for QCompleter::highlighted(const QString &text)
[const]intmaxVisibleItemsMethod int QCompleter::maxVisibleItems()
voidmaxVisibleItems=(int maxItems)Method void QCompleter::setMaxVisibleItems(int maxItems)
[const]QAbstractItemModel ptrmodelMethod QAbstractItemModel *QCompleter::model()
voidmodel=(QAbstractItemModel ptr c)Method void QCompleter::setModel(QAbstractItemModel *c)
[const]QCompleter_ModelSortingmodelSortingMethod QCompleter::ModelSorting QCompleter::modelSorting()
voidmodelSorting=(const QCompleter_ModelSorting sorting)Method void QCompleter::setModelSorting(QCompleter::ModelSorting sorting)
[virtual,const]stringpathFromIndex(const QModelIndex index)Virtual method QString QCompleter::pathFromIndex(const QModelIndex &index)
[const]QAbstractItemView ptrpopupMethod QAbstractItemView *QCompleter::popup()
voidpopup=(QAbstractItemView ptr popup)Method void QCompleter::setPopup(QAbstractItemView *popup)
voidsetCaseSensitivity(const Qt_CaseSensitivity caseSensitivity)Method void QCompleter::setCaseSensitivity(Qt::CaseSensitivity caseSensitivity)
voidsetCompletionColumn(int column)Method void QCompleter::setCompletionColumn(int column)
voidsetCompletionMode(const QCompleter_CompletionMode mode)Method void QCompleter::setCompletionMode(QCompleter::CompletionMode mode)
voidsetCompletionPrefix(string prefix)Method void QCompleter::setCompletionPrefix(const QString &prefix)
voidsetCompletionRole(int role)Method void QCompleter::setCompletionRole(int role)
boolsetCurrentRow(int row)Method bool QCompleter::setCurrentRow(int row)
voidsetMaxVisibleItems(int maxItems)Method void QCompleter::setMaxVisibleItems(int maxItems)
voidsetModel(QAbstractItemModel ptr c)Method void QCompleter::setModel(QAbstractItemModel *c)
voidsetModelSorting(const QCompleter_ModelSorting sorting)Method void QCompleter::setModelSorting(QCompleter::ModelSorting sorting)
voidsetPopup(QAbstractItemView ptr popup)Method void QCompleter::setPopup(QAbstractItemView *popup)
voidsetWidget(QWidget ptr widget)Method void QCompleter::setWidget(QWidget *widget)
voidsetWrapAround(bool wrap)Method void QCompleter::setWrapAround(bool wrap)
[virtual,const]string[]splitPath(string path)Virtual method QStringList QCompleter::splitPath(const QString &path)
[const]QWidget ptrwidgetMethod QWidget *QCompleter::widget()
voidwidget=(QWidget ptr widget)Method void QCompleter::setWidget(QWidget *widget)
[const]boolwrapAroundMethod bool QCompleter::wrapAround()
voidwrapAround=(bool wrap)Method void QCompleter::setWrapAround(bool wrap)

Public static methods and constants

[static,const]new QCompleter_ModelSorting ptrCaseInsensitivelySortedModelEnum constant QCompleter::CaseInsensitivelySortedModel
[static,const]new QCompleter_ModelSorting ptrCaseSensitivelySortedModelEnum constant QCompleter::CaseSensitivelySortedModel
[static,const]new QCompleter_CompletionMode ptrInlineCompletionEnum constant QCompleter::InlineCompletion
[static,const]new QCompleter_CompletionMode ptrPopupCompletionEnum constant QCompleter::PopupCompletion
[static,const]new QCompleter_CompletionMode ptrUnfilteredPopupCompletionEnum constant QCompleter::UnfilteredPopupCompletion
[static,const]new QCompleter_ModelSorting ptrUnsortedModelEnum constant QCompleter::UnsortedModel
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QCompleter::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QCompleter::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QCompleter::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QCompleter::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QCompleter::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QCompleter::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QCompleter::disconnectNotify(const char *signal)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QCompleter::event(QEvent *)
[virtual]booleventFilter(QObject ptr o,
QEvent ptr e)
Virtual method bool QCompleter::eventFilter(QObject *o, QEvent *e)
[const]intreceivers(string signal)Method int QCompleter::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QCompleter::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QCompleter::timerEvent(QTimerEvent *)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[static,const] new QCompleter_ModelSorting ptr CaseInsensitivelySortedModel

Description: Enum constant QCompleter::CaseInsensitivelySortedModel

[static,const] new QCompleter_ModelSorting ptr CaseSensitivelySortedModel

Description: Enum constant QCompleter::CaseSensitivelySortedModel

[static,const] new QCompleter_CompletionMode ptr InlineCompletion

Description: Enum constant QCompleter::InlineCompletion

[static,const] new QCompleter_CompletionMode ptr PopupCompletion

Description: Enum constant QCompleter::PopupCompletion

[static,const] new QCompleter_CompletionMode ptr UnfilteredPopupCompletion

Description: Enum constant QCompleter::UnfilteredPopupCompletion

[static,const] new QCompleter_ModelSorting ptr UnsortedModel

Description: Enum constant QCompleter::UnsortedModel

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[event] void activated(const QModelIndex index)

Description: Signal declaration for QCompleter::activated(const QModelIndex &index)

You can bind a procedure to this signal.

[event] void activated_qs(string text)

Description: Signal declaration for QCompleter::activated(const QString &text)

You can bind a procedure to this signal.

[const] Qt_CaseSensitivity caseSensitivity

Description: Method Qt::CaseSensitivity QCompleter::caseSensitivity()

Python specific notes:

The object exposes a readable attribute 'caseSensitivity'. This is the getter.

void caseSensitivity=(const Qt_CaseSensitivity caseSensitivity)

Description: Method void QCompleter::setCaseSensitivity(Qt::CaseSensitivity caseSensitivity)

Python specific notes:

The object exposes a writable attribute 'caseSensitivity'. This is the setter.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QCompleter::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void complete(const QRect rect = QRect())

Description: Method void QCompleter::complete(const QRect &rect)

[const] int completionColumn

Description: Method int QCompleter::completionColumn()

Python specific notes:

The object exposes a readable attribute 'completionColumn'. This is the getter.

void completionColumn=(int column)

Description: Method void QCompleter::setCompletionColumn(int column)

Python specific notes:

The object exposes a writable attribute 'completionColumn'. This is the setter.

[const] int completionCount

Description: Method int QCompleter::completionCount()

[const] QCompleter_CompletionMode completionMode

Description: Method QCompleter::CompletionMode QCompleter::completionMode()

Python specific notes:

The object exposes a readable attribute 'completionMode'. This is the getter.

void completionMode=(const QCompleter_CompletionMode mode)

Description: Method void QCompleter::setCompletionMode(QCompleter::CompletionMode mode)

Python specific notes:

The object exposes a writable attribute 'completionMode'. This is the setter.

[const] QAbstractItemModel ptr completionModel

Description: Method QAbstractItemModel *QCompleter::completionModel()

[const] string completionPrefix

Description: Method QString QCompleter::completionPrefix()

Python specific notes:

The object exposes a readable attribute 'completionPrefix'. This is the getter.

void completionPrefix=(string prefix)

Description: Method void QCompleter::setCompletionPrefix(const QString &prefix)

Python specific notes:

The object exposes a writable attribute 'completionPrefix'. This is the setter.

[const] int completionRole

Description: Method int QCompleter::completionRole()

Python specific notes:

The object exposes a readable attribute 'completionRole'. This is the getter.

void completionRole=(int role)

Description: Method void QCompleter::setCompletionRole(int role)

Python specific notes:

The object exposes a writable attribute 'completionRole'. This is the setter.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] string currentCompletion

Description: Method QString QCompleter::currentCompletion()

[const] QModelIndex currentIndex

Description: Method QModelIndex QCompleter::currentIndex()

[const] int currentRow

Description: Method int QCompleter::currentRow()

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QCompleter::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QCompleter::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QCompleter::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QCompleter::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr o,QEvent ptr e)

Description: Virtual method bool QCompleter::eventFilter(QObject *o, QEvent *e)

This method can be reimplemented in a derived class.

[event] void highlighted(const QModelIndex index)

Description: Signal declaration for QCompleter::highlighted(const QModelIndex &index)

You can bind a procedure to this signal.

[event] void highlighted_qs(string text)

Description: Signal declaration for QCompleter::highlighted(const QString &text)

You can bind a procedure to this signal.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[const] int maxVisibleItems

Description: Method int QCompleter::maxVisibleItems()

Python specific notes:

The object exposes a readable attribute 'maxVisibleItems'. This is the getter.

void maxVisibleItems=(int maxItems)

Description: Method void QCompleter::setMaxVisibleItems(int maxItems)

Python specific notes:

The object exposes a writable attribute 'maxVisibleItems'. This is the setter.

[const] QAbstractItemModel ptr model

Description: Method QAbstractItemModel *QCompleter::model()

Python specific notes:

The object exposes a readable attribute 'model'. This is the getter.

void model=(QAbstractItemModel ptr c)

Description: Method void QCompleter::setModel(QAbstractItemModel *c)

Python specific notes:

The object exposes a writable attribute 'model'. This is the setter.

[const] QCompleter_ModelSorting modelSorting

Description: Method QCompleter::ModelSorting QCompleter::modelSorting()

Python specific notes:

The object exposes a readable attribute 'modelSorting'. This is the getter.

void modelSorting=(const QCompleter_ModelSorting sorting)

Description: Method void QCompleter::setModelSorting(QCompleter::ModelSorting sorting)

Python specific notes:

The object exposes a writable attribute 'modelSorting'. This is the setter.

[static] new QCompleter new(QObject ptr parent = 0)

Description: Constructor QCompleter::QCompleter(QObject *parent)

This method creates an object of class QCompleter.

Python specific notes:

This method is the default initializer of the object

[static] new QCompleter new(QAbstractItemModel ptr model,QObject ptr parent = 0)

Description: Constructor QCompleter::QCompleter(QAbstractItemModel *model, QObject *parent)

This method creates an object of class QCompleter.

Python specific notes:

This method is the default initializer of the object

[static] new QCompleter new(string[] completions,QObject ptr parent = 0)

Description: Constructor QCompleter::QCompleter(const QStringList &completions, QObject *parent)

This method creates an object of class QCompleter.

Python specific notes:

This method is the default initializer of the object

[virtual,const] string pathFromIndex(const QModelIndex index)

Description: Virtual method QString QCompleter::pathFromIndex(const QModelIndex &index)

This method can be reimplemented in a derived class.

[const] QAbstractItemView ptr popup

Description: Method QAbstractItemView *QCompleter::popup()

Python specific notes:

The object exposes a readable attribute 'popup'. This is the getter.

void popup=(QAbstractItemView ptr popup)

Description: Method void QCompleter::setPopup(QAbstractItemView *popup)

Python specific notes:

The object exposes a writable attribute 'popup'. This is the setter.

[const] int receivers(string signal)

Description: Method int QCompleter::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

[const] QObject ptr sender

Description: Method QObject *QCompleter::sender()

This method is protected and can only be called from inside a derived class.

void setCaseSensitivity(const Qt_CaseSensitivity caseSensitivity)

Description: Method void QCompleter::setCaseSensitivity(Qt::CaseSensitivity caseSensitivity)

Python specific notes:

The object exposes a writable attribute 'caseSensitivity'. This is the setter.

void setCompletionColumn(int column)

Description: Method void QCompleter::setCompletionColumn(int column)

Python specific notes:

The object exposes a writable attribute 'completionColumn'. This is the setter.

void setCompletionMode(const QCompleter_CompletionMode mode)

Description: Method void QCompleter::setCompletionMode(QCompleter::CompletionMode mode)

Python specific notes:

The object exposes a writable attribute 'completionMode'. This is the setter.

void setCompletionPrefix(string prefix)

Description: Method void QCompleter::setCompletionPrefix(const QString &prefix)

Python specific notes:

The object exposes a writable attribute 'completionPrefix'. This is the setter.

void setCompletionRole(int role)

Description: Method void QCompleter::setCompletionRole(int role)

Python specific notes:

The object exposes a writable attribute 'completionRole'. This is the setter.

bool setCurrentRow(int row)

Description: Method bool QCompleter::setCurrentRow(int row)

void setMaxVisibleItems(int maxItems)

Description: Method void QCompleter::setMaxVisibleItems(int maxItems)

Python specific notes:

The object exposes a writable attribute 'maxVisibleItems'. This is the setter.

void setModel(QAbstractItemModel ptr c)

Description: Method void QCompleter::setModel(QAbstractItemModel *c)

Python specific notes:

The object exposes a writable attribute 'model'. This is the setter.

void setModelSorting(const QCompleter_ModelSorting sorting)

Description: Method void QCompleter::setModelSorting(QCompleter::ModelSorting sorting)

Python specific notes:

The object exposes a writable attribute 'modelSorting'. This is the setter.

void setPopup(QAbstractItemView ptr popup)

Description: Method void QCompleter::setPopup(QAbstractItemView *popup)

Python specific notes:

The object exposes a writable attribute 'popup'. This is the setter.

void setWidget(QWidget ptr widget)

Description: Method void QCompleter::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

void setWrapAround(bool wrap)

Description: Method void QCompleter::setWrapAround(bool wrap)

Python specific notes:

The object exposes a writable attribute 'wrapAround'. This is the setter.

[virtual,const] string[] splitPath(string path)

Description: Virtual method QStringList QCompleter::splitPath(const QString &path)

This method can be reimplemented in a derived class.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QCompleter::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QCompleter::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QCompleter::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QCompleter::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QCompleter::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[const] QWidget ptr widget

Description: Method QWidget *QCompleter::widget()

Python specific notes:

The object exposes a readable attribute 'widget'. This is the getter.

void widget=(QWidget ptr widget)

Description: Method void QCompleter::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

[const] bool wrapAround

Description: Method bool QCompleter::wrapAround()

Python specific notes:

The object exposes a readable attribute 'wrapAround'. This is the getter.

void wrapAround=(bool wrap)

Description: Method void QCompleter::setWrapAround(bool wrap)

Python specific notes:

The object exposes a writable attribute 'wrapAround'. This is the setter.