Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QMetaPropertyBuilder Class Reference

\inmodule QtCore More...

#include <qmetaobjectbuilder_p.h>

Collaboration diagram for QMetaPropertyBuilder:

Public Member Functions

 QMetaPropertyBuilder ()
int index () const
 Returns the index of this property within its QMetaObjectBuilder.
QByteArray name () const
 Returns the name associated with this property.
QByteArray type () const
 Returns the type associated with this property.
bool hasNotifySignal () const
 Returns true if this property has a notify signal; false otherwise.
QMetaMethodBuilder notifySignal () const
 Returns the notify signal associated with this property.
void setNotifySignal (const QMetaMethodBuilder &value)
 Sets the notify signal associated with this property to value.
void removeNotifySignal ()
 Removes the notify signal from this property.
bool isReadable () const
 Returns true if this property is readable; otherwise returns false.
bool isWritable () const
 Returns true if this property is writable; otherwise returns false.
bool isResettable () const
 Returns true if this property can be reset to a default value; otherwise returns false.
bool isDesignable () const
 Returns true if this property is designable; otherwise returns false.
bool isScriptable () const
 Returns true if the property is scriptable; otherwise returns false.
bool isStored () const
 Returns true if the property is stored; otherwise returns false.
bool isEditable () const
bool isUser () const
 Returns true if this property is designated as the USER property, i.e., the one that the user can edit or that is significant in some other way.
bool hasStdCppSet () const
 Returns true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern.
bool isEnumOrFlag () const
 Returns true if the property is an enumerator or flag type; otherwise returns false.
bool isConstant () const
 Returns true if the property is constant; otherwise returns false.
bool isFinal () const
 Returns true if the property is final; otherwise returns false.
bool isAlias () const
 Returns true if the property is an alias.
bool isBindable () const
 Returns true if the property is bindable The default value is false.
bool isRequired () const
 Returns true if the property is required.
void setReadable (bool value)
 Sets this property to readable if value is true.
void setWritable (bool value)
 Sets this property to writable if value is true.
void setResettable (bool value)
 Sets this property to resettable if value is true.
void setDesignable (bool value)
 Sets this property to designable if value is true.
void setScriptable (bool value)
 Sets this property to scriptable if value is true.
void setStored (bool value)
 Sets this property to storable if value is true.
void setUser (bool value)
 Sets the USER flag on this property to value.
void setStdCppSet (bool value)
 Sets the C++ setter flag on this property to value, which is true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern.
void setEnumOrFlag (bool value)
 Sets this property to be of an enumerator or flag type if value is true.
void setConstant (bool value)
 Sets the CONSTANT flag on this property to value.
void setFinal (bool value)
 Sets the FINAL flag on this property to value.
void setAlias (bool value)
 Sets the ALIAS flag on this property to value.
void setBindable (bool value)
 Sets theBINDABLE flag on this property to value.
void setRequired (bool value)
 Sets theREQUIRED flag on this property to value.
int revision () const
 Returns the revision of this property.
void setRevision (int revision)
 Sets the revision of this property.

Friends

class QMetaObjectBuilder

Detailed Description

\inmodule QtCore

The QMetaPropertyBuilder class enables modifications to a property definition on a meta object builder.

Definition at line 190 of file qmetaobjectbuilder_p.h.

Constructor & Destructor Documentation

◆ QMetaPropertyBuilder()

QMetaPropertyBuilder::QMetaPropertyBuilder ( )
inline

Definition at line 193 of file qmetaobjectbuilder_p.h.

Member Function Documentation

◆ hasNotifySignal()

bool QMetaPropertyBuilder::hasNotifySignal ( ) const

Returns true if this property has a notify signal; false otherwise.

See also
notifySignal(), setNotifySignal(), removeNotifySignal()

Definition at line 1852 of file qmetaobjectbuilder.cpp.

◆ hasStdCppSet()

bool QMetaPropertyBuilder::hasStdCppSet ( ) const

Returns true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern.

Designer and uic query hasStdCppSet() in order to avoid expensive QObject::setProperty() calls. All properties in Qt [should] follow this pattern. The default value is false.

See also
setStdCppSet()

Definition at line 2020 of file qmetaobjectbuilder.cpp.

◆ index()

int QMetaPropertyBuilder::index ( ) const
inline

Returns the index of this property within its QMetaObjectBuilder.

Definition at line 195 of file qmetaobjectbuilder_p.h.

◆ isAlias()

bool QMetaPropertyBuilder::isAlias ( ) const

Returns true if the property is an alias.

The default value is false

Definition at line 2074 of file qmetaobjectbuilder.cpp.

◆ isBindable()

bool QMetaPropertyBuilder::isBindable ( ) const

Returns true if the property is bindable The default value is false.

Definition at line 2087 of file qmetaobjectbuilder.cpp.

◆ isConstant()

bool QMetaPropertyBuilder::isConstant ( ) const

Returns true if the property is constant; otherwise returns false.

The default value is false.

Definition at line 2048 of file qmetaobjectbuilder.cpp.

◆ isDesignable()

bool QMetaPropertyBuilder::isDesignable ( ) const

Returns true if this property is designable; otherwise returns false.

This default value is false.

See also
setDesignable(), isScriptable(), isStored()

Definition at line 1955 of file qmetaobjectbuilder.cpp.

◆ isEditable()

bool QMetaPropertyBuilder::isEditable ( ) const

◆ isEnumOrFlag()

bool QMetaPropertyBuilder::isEnumOrFlag ( ) const

Returns true if the property is an enumerator or flag type; otherwise returns false.

This default value is false.

See also
setEnumOrFlag()

Definition at line 2035 of file qmetaobjectbuilder.cpp.

◆ isFinal()

bool QMetaPropertyBuilder::isFinal ( ) const

Returns true if the property is final; otherwise returns false.

The default value is false.

Definition at line 2061 of file qmetaobjectbuilder.cpp.

◆ isReadable()

bool QMetaPropertyBuilder::isReadable ( ) const

Returns true if this property is readable; otherwise returns false.

The default value is true.

See also
setReadable(), isWritable()

Definition at line 1910 of file qmetaobjectbuilder.cpp.

◆ isRequired()

bool QMetaPropertyBuilder::isRequired ( ) const

Returns true if the property is required.

The default is false.

Definition at line 2098 of file qmetaobjectbuilder.cpp.

◆ isResettable()

bool QMetaPropertyBuilder::isResettable ( ) const

Returns true if this property can be reset to a default value; otherwise returns false.

The default value is false.

See also
setResettable()

Definition at line 1940 of file qmetaobjectbuilder.cpp.

◆ isScriptable()

bool QMetaPropertyBuilder::isScriptable ( ) const

Returns true if the property is scriptable; otherwise returns false.

This default value is true.

See also
setScriptable(), isDesignable(), isStored()

Definition at line 1970 of file qmetaobjectbuilder.cpp.

◆ isStored()

bool QMetaPropertyBuilder::isStored ( ) const

Returns true if the property is stored; otherwise returns false.

This default value is false.

See also
setStored(), isDesignable(), isScriptable()

Definition at line 1985 of file qmetaobjectbuilder.cpp.

◆ isUser()

bool QMetaPropertyBuilder::isUser ( ) const

Returns true if this property is designated as the USER property, i.e., the one that the user can edit or that is significant in some other way.

Otherwise it returns false. This default value is false.

See also
setUser(), isDesignable(), isScriptable()

Definition at line 2002 of file qmetaobjectbuilder.cpp.

◆ isWritable()

bool QMetaPropertyBuilder::isWritable ( ) const

Returns true if this property is writable; otherwise returns false.

The default value is true.

See also
setWritable(), isReadable()

Definition at line 1925 of file qmetaobjectbuilder.cpp.

◆ name()

QByteArray QMetaPropertyBuilder::name ( ) const

Returns the name associated with this property.

See also
type()

Definition at line 1824 of file qmetaobjectbuilder.cpp.

◆ notifySignal()

QMetaMethodBuilder QMetaPropertyBuilder::notifySignal ( ) const

Returns the notify signal associated with this property.

See also
hasNotifySignal(), setNotifySignal(), removeNotifySignal()

Definition at line 1866 of file qmetaobjectbuilder.cpp.

◆ removeNotifySignal()

void QMetaPropertyBuilder::removeNotifySignal ( )

Removes the notify signal from this property.

See also
hasNotifySignal(), notifySignal(), setNotifySignal()

Definition at line 1897 of file qmetaobjectbuilder.cpp.

◆ revision()

int QMetaPropertyBuilder::revision ( ) const

Returns the revision of this property.

See also
setRevision()

Definition at line 2274 of file qmetaobjectbuilder.cpp.

◆ setAlias()

void QMetaPropertyBuilder::setAlias ( bool value)

Sets the ALIAS flag on this property to value.

Definition at line 2244 of file qmetaobjectbuilder.cpp.

◆ setBindable()

void QMetaPropertyBuilder::setBindable ( bool value)

Sets theBINDABLE flag on this property to value.

Definition at line 2254 of file qmetaobjectbuilder.cpp.

◆ setConstant()

void QMetaPropertyBuilder::setConstant ( bool value)

Sets the CONSTANT flag on this property to value.

See also
isConstant()

Definition at line 2222 of file qmetaobjectbuilder.cpp.

◆ setDesignable()

void QMetaPropertyBuilder::setDesignable ( bool value)

Sets this property to designable if value is true.

See also
isDesignable(), setScriptable(), setStored()

Definition at line 2147 of file qmetaobjectbuilder.cpp.

◆ setEnumOrFlag()

void QMetaPropertyBuilder::setEnumOrFlag ( bool value)

Sets this property to be of an enumerator or flag type if value is true.

See also
isEnumOrFlag()

Definition at line 2210 of file qmetaobjectbuilder.cpp.

◆ setFinal()

void QMetaPropertyBuilder::setFinal ( bool value)

Sets the FINAL flag on this property to value.

See also
isFinal()

Definition at line 2234 of file qmetaobjectbuilder.cpp.

◆ setNotifySignal()

void QMetaPropertyBuilder::setNotifySignal ( const QMetaMethodBuilder & value)

Sets the notify signal associated with this property to value.

See also
hasNotifySignal(), notifySignal(), removeNotifySignal()

Definition at line 1880 of file qmetaobjectbuilder.cpp.

◆ setReadable()

void QMetaPropertyBuilder::setReadable ( bool value)

Sets this property to readable if value is true.

See also
isReadable(), setWritable()

Definition at line 2111 of file qmetaobjectbuilder.cpp.

◆ setRequired()

void QMetaPropertyBuilder::setRequired ( bool value)

Sets theREQUIRED flag on this property to value.

Definition at line 2263 of file qmetaobjectbuilder.cpp.

◆ setResettable()

void QMetaPropertyBuilder::setResettable ( bool value)

Sets this property to resettable if value is true.

See also
isResettable()

Definition at line 2135 of file qmetaobjectbuilder.cpp.

◆ setRevision()

void QMetaPropertyBuilder::setRevision ( int revision)

Sets the revision of this property.

See also
revision()

Definition at line 2287 of file qmetaobjectbuilder.cpp.

◆ setScriptable()

void QMetaPropertyBuilder::setScriptable ( bool value)

Sets this property to scriptable if value is true.

See also
isScriptable(), setDesignable(), setStored()

Definition at line 2159 of file qmetaobjectbuilder.cpp.

◆ setStdCppSet()

void QMetaPropertyBuilder::setStdCppSet ( bool value)

Sets the C++ setter flag on this property to value, which is true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern.

See also
hasStdCppSet()

Definition at line 2197 of file qmetaobjectbuilder.cpp.

◆ setStored()

void QMetaPropertyBuilder::setStored ( bool value)

Sets this property to storable if value is true.

See also
isStored(), setDesignable(), setScriptable()

Definition at line 2171 of file qmetaobjectbuilder.cpp.

◆ setUser()

void QMetaPropertyBuilder::setUser ( bool value)

Sets the USER flag on this property to value.

See also
isUser(), setDesignable(), setScriptable()

Definition at line 2183 of file qmetaobjectbuilder.cpp.

◆ setWritable()

void QMetaPropertyBuilder::setWritable ( bool value)

Sets this property to writable if value is true.

See also
isWritable(), setReadable()

Definition at line 2123 of file qmetaobjectbuilder.cpp.

◆ type()

QByteArray QMetaPropertyBuilder::type ( ) const

Returns the type associated with this property.

See also
name()

Definition at line 1838 of file qmetaobjectbuilder.cpp.

◆ QMetaObjectBuilder

friend class QMetaObjectBuilder
friend

Definition at line 243 of file qmetaobjectbuilder_p.h.


The documentation for this class was generated from the following files: