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
Public Member Functions | List of all members
QDesignerWidgetDataBaseItemInterface Class Referenceabstract

The QDesignerWidgetDataBaseItemInterface class provides an interface that is used to access individual items in \QD's widget database. More...

#include <abstractwidgetdatabase.h>

+ Inheritance diagram for QDesignerWidgetDataBaseItemInterface:
+ Collaboration diagram for QDesignerWidgetDataBaseItemInterface:

Public Member Functions

 QDesignerWidgetDataBaseItemInterface ()=default
 
virtual ~QDesignerWidgetDataBaseItemInterface ()=default
 Destroys the interface.
 
virtual QString name () const =0
 Returns the name of the widget.
 
virtual void setName (const QString &name)=0
 
virtual QString group () const =0
 Returns the name of the group that the widget belongs to.
 
virtual void setGroup (const QString &group)=0
 
virtual QString toolTip () const =0
 Returns the tool tip to be used by the widget.
 
virtual void setToolTip (const QString &toolTip)=0
 
virtual QString whatsThis () const =0
 Returns the "What's This?" help for the widget.
 
virtual void setWhatsThis (const QString &whatsThis)=0
 
virtual QString includeFile () const =0
 Returns the name of the include file that the widget needs when being built from source.
 
virtual void setIncludeFile (const QString &includeFile)=0
 
virtual QIcon icon () const =0
 Returns the icon used to represent the item.
 
virtual void setIcon (const QIcon &icon)=0
 
virtual bool isCompat () const =0
 Returns true if this type of widget is provided for compatibility purposes (e.g.
 
virtual void setCompat (bool compat)=0
 If compat is true, the widget is handled as a compatibility widget; otherwise it is handled normally by \QD.
 
virtual bool isContainer () const =0
 Returns true if this widget is intended to be used to hold other widgets; otherwise returns false.
 
virtual void setContainer (bool container)=0
 If container is true, the widget can be used to hold other widgets in \QD; otherwise \QD will refuse to let the user place other widgets inside it.
 
virtual bool isCustom () const =0
 Returns true if the widget is a custom widget; otherwise return false if it is a standard Qt widget.
 
virtual void setCustom (bool custom)=0
 If custom is true, the widget is handled specially by \QD; otherwise it is handled as a standard Qt widget.
 
virtual QString pluginPath () const =0
 Returns the path to use for the widget plugin.
 
virtual void setPluginPath (const QString &path)=0
 
virtual bool isPromoted () const =0
 Returns true if the widget is promoted; otherwise returns false.
 
virtual void setPromoted (bool b)=0
 If promoted is true, the widget is handled as a promoted widget by \QD and will use a placeholder widget to represent it; otherwise it is handled as a standard widget.
 
virtual QString extends () const =0
 Returns the name of the widget that the item extends.
 
virtual void setExtends (const QString &s)=0
 
virtual void setDefaultPropertyValues (const QList< QVariant > &list)=0
 Sets the default property values for the widget to the given list.
 
virtual QList< QVariant > defaultPropertyValues () const =0
 Returns a list of default values to be used as properties for the item.
 

Detailed Description

The QDesignerWidgetDataBaseItemInterface class provides an interface that is used to access individual items in \QD's widget database.

\inmodule QtDesigner

This class enables individual items in the widget database to be accessed and modified. Changes to the widget database itself are made through the QDesignerWidgetDataBaseInterface class.

Definition at line 19 of file abstractwidgetdatabase.h.

Constructor & Destructor Documentation

◆ QDesignerWidgetDataBaseItemInterface()

QDesignerWidgetDataBaseItemInterface::QDesignerWidgetDataBaseItemInterface ( )
default

◆ ~QDesignerWidgetDataBaseItemInterface()

virtual QDesignerWidgetDataBaseItemInterface::~QDesignerWidgetDataBaseItemInterface ( )
virtualdefault

Destroys the interface.

Member Function Documentation

◆ defaultPropertyValues()

virtual QList< QVariant > QDesignerWidgetDataBaseItemInterface::defaultPropertyValues ( ) const
pure virtual

Returns a list of default values to be used as properties for the item.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ extends()

virtual QString QDesignerWidgetDataBaseItemInterface::extends ( ) const
pure virtual

Returns the name of the widget that the item extends.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ group()

virtual QString QDesignerWidgetDataBaseItemInterface::group ( ) const
pure virtual

Returns the name of the group that the widget belongs to.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ icon()

virtual QIcon QDesignerWidgetDataBaseItemInterface::icon ( ) const
pure virtual

Returns the icon used to represent the item.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ includeFile()

virtual QString QDesignerWidgetDataBaseItemInterface::includeFile ( ) const
pure virtual

Returns the name of the include file that the widget needs when being built from source.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ isCompat()

virtual bool QDesignerWidgetDataBaseItemInterface::isCompat ( ) const
pure virtual

Returns true if this type of widget is provided for compatibility purposes (e.g.

Qt3Support widgets); otherwise returns false.

See also
setCompat()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ isContainer()

virtual bool QDesignerWidgetDataBaseItemInterface::isContainer ( ) const
pure virtual

Returns true if this widget is intended to be used to hold other widgets; otherwise returns false.

See also
setContainer()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ isCustom()

virtual bool QDesignerWidgetDataBaseItemInterface::isCustom ( ) const
pure virtual

Returns true if the widget is a custom widget; otherwise return false if it is a standard Qt widget.

See also
setCustom()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ isPromoted()

virtual bool QDesignerWidgetDataBaseItemInterface::isPromoted ( ) const
pure virtual

Returns true if the widget is promoted; otherwise returns false.

Promoted widgets are those that represent custom widgets, but which are represented in \QD by either standard Qt widgets or readily-available custom widgets.

See also
setPromoted()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ name()

virtual QString QDesignerWidgetDataBaseItemInterface::name ( ) const
pure virtual

Returns the name of the widget.

Implemented in qdesigner_internal::WidgetDataBaseItem.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

+ Here is the caller graph for this function:

◆ pluginPath()

virtual QString QDesignerWidgetDataBaseItemInterface::pluginPath ( ) const
pure virtual

Returns the path to use for the widget plugin.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setCompat()

virtual void QDesignerWidgetDataBaseItemInterface::setCompat ( bool compat)
pure virtual

If compat is true, the widget is handled as a compatibility widget; otherwise it is handled normally by \QD.

See also
isCompat()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setContainer()

virtual void QDesignerWidgetDataBaseItemInterface::setContainer ( bool container)
pure virtual

If container is true, the widget can be used to hold other widgets in \QD; otherwise \QD will refuse to let the user place other widgets inside it.

See also
isContainer()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setCustom()

virtual void QDesignerWidgetDataBaseItemInterface::setCustom ( bool custom)
pure virtual

If custom is true, the widget is handled specially by \QD; otherwise it is handled as a standard Qt widget.

See also
isCustom()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setDefaultPropertyValues()

virtual void QDesignerWidgetDataBaseItemInterface::setDefaultPropertyValues ( const QList< QVariant > & list)
pure virtual

Sets the default property values for the widget to the given list.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setExtends()

virtual void QDesignerWidgetDataBaseItemInterface::setExtends ( const QString & s)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setGroup()

virtual void QDesignerWidgetDataBaseItemInterface::setGroup ( const QString & group)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setIcon()

virtual void QDesignerWidgetDataBaseItemInterface::setIcon ( const QIcon & icon)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setIncludeFile()

virtual void QDesignerWidgetDataBaseItemInterface::setIncludeFile ( const QString & includeFile)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setName()

virtual void QDesignerWidgetDataBaseItemInterface::setName ( const QString & name)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setPluginPath()

virtual void QDesignerWidgetDataBaseItemInterface::setPluginPath ( const QString & path)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setPromoted()

virtual void QDesignerWidgetDataBaseItemInterface::setPromoted ( bool promoted)
pure virtual

If promoted is true, the widget is handled as a promoted widget by \QD and will use a placeholder widget to represent it; otherwise it is handled as a standard widget.

See also
isPromoted()

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setToolTip()

virtual void QDesignerWidgetDataBaseItemInterface::setToolTip ( const QString & toolTip)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ setWhatsThis()

virtual void QDesignerWidgetDataBaseItemInterface::setWhatsThis ( const QString & whatsThis)
pure virtual

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ toolTip()

virtual QString QDesignerWidgetDataBaseItemInterface::toolTip ( ) const
pure virtual

Returns the tool tip to be used by the widget.

Implemented in qdesigner_internal::WidgetDataBaseItem.

◆ whatsThis()

virtual QString QDesignerWidgetDataBaseItemInterface::whatsThis ( ) const
pure virtual

Returns the "What's This?" help for the widget.

Implemented in qdesigner_internal::WidgetDataBaseItem.

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