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
qdesigner_internal::QDesignerPromotion Class Reference

#include <qdesigner_promotion_p.h>

+ Inheritance diagram for qdesigner_internal::QDesignerPromotion:
+ Collaboration diagram for qdesigner_internal::QDesignerPromotion:

Public Member Functions

 QDesignerPromotion (QDesignerFormEditorInterface *core)
 
PromotedClasses promotedClasses () const override
 Returns a list of promoted classes along with their base classes in alphabetical order.
 
QSet< QStringreferencedPromotedClassNames () const override
 Returns a set of promoted classed that are referenced by the currently opened forms.
 
bool addPromotedClass (const QString &baseClass, const QString &className, const QString &includeFile, QString *errorMessage) override
 Add a promoted class named with the base class and include file includeFile.
 
bool removePromotedClass (const QString &className, QString *errorMessage) override
 Remove the promoted class named className unless it is referenced by a form.
 
bool changePromotedClassName (const QString &oldclassName, const QString &newClassName, QString *errorMessage) override
 Change the class name of a promoted class from oldClassName to newClassName.
 
bool setPromotedClassIncludeFile (const QString &className, const QString &includeFile, QString *errorMessage) override
 Change the include file of a promoted class named className to be includeFile.
 
QList< QDesignerWidgetDataBaseItemInterface * > promotionBaseClasses () const override
 Return a list of base classes that are suitable for promotion.
 
- Public Member Functions inherited from QDesignerPromotionInterface
 QDesignerPromotionInterface ()=default
 
virtual ~QDesignerPromotionInterface ()=default
 

Additional Inherited Members

- Public Types inherited from QDesignerPromotionInterface
using PromotedClasses = QList<PromotedClass>
 A list of PromotedClass items.
 

Detailed Description

Definition at line 28 of file qdesigner_promotion_p.h.

Constructor & Destructor Documentation

◆ QDesignerPromotion()

qdesigner_internal::QDesignerPromotion::QDesignerPromotion ( QDesignerFormEditorInterface * core)
explicit

Definition at line 105 of file qdesigner_promotion.cpp.

Member Function Documentation

◆ addPromotedClass()

bool qdesigner_internal::QDesignerPromotion::addPromotedClass ( const QString & baseClass,
const QString & className,
const QString & includeFile,
QString * errorMessage )
overridevirtual

Add a promoted class named with the base class and include file includeFile.

Returns true on success or false along with an error message in errorMessage on failure.

Implements QDesignerPromotionInterface.

Definition at line 109 of file qdesigner_promotion.cpp.

◆ changePromotedClassName()

bool qdesigner_internal::QDesignerPromotion::changePromotedClassName ( const QString & oldClassName,
const QString & newClassName,
QString * errorMessage )
overridevirtual

Change the class name of a promoted class from oldClassName to newClassName.

Returns true on success or false along with an error message in errorMessage on failure.

Implements QDesignerPromotionInterface.

Definition at line 288 of file qdesigner_promotion.cpp.

◆ promotedClasses()

QDesignerPromotion::PromotedClasses qdesigner_internal::QDesignerPromotion::promotedClasses ( ) const
overridevirtual

Returns a list of promoted classes along with their base classes in alphabetical order.

It can be used to populate tree models for editing promoted widgets.

Implements QDesignerPromotionInterface.

Definition at line 179 of file qdesigner_promotion.cpp.

◆ promotionBaseClasses()

QList< QDesignerWidgetDataBaseItemInterface * > qdesigner_internal::QDesignerPromotion::promotionBaseClasses ( ) const
overridevirtual

Return a list of base classes that are suitable for promotion.

Implements QDesignerPromotionInterface.

Definition at line 144 of file qdesigner_promotion.cpp.

◆ referencedPromotedClassNames()

QSet< QString > qdesigner_internal::QDesignerPromotion::referencedPromotedClassNames ( ) const
overridevirtual

Returns a set of promoted classed that are referenced by the currently opened forms.

Implements QDesignerPromotionInterface.

Definition at line 221 of file qdesigner_promotion.cpp.

◆ removePromotedClass()

bool qdesigner_internal::QDesignerPromotion::removePromotedClass ( const QString & className,
QString * errorMessage )
overridevirtual

Remove the promoted class named className unless it is referenced by a form.

Returns true on success or false along with an error message in errorMessage on failure.

Implements QDesignerPromotionInterface.

Definition at line 250 of file qdesigner_promotion.cpp.

◆ setPromotedClassIncludeFile()

bool qdesigner_internal::QDesignerPromotion::setPromotedClassIncludeFile ( const QString & className,
const QString & includeFile,
QString * errorMessage )
overridevirtual

Change the include file of a promoted class named className to be includeFile.

Returns true on success or false along with an error message in errorMessage on failure.

Implements QDesignerPromotionInterface.

Definition at line 331 of file qdesigner_promotion.cpp.


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