|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QDesignerCustomWidgetInterface Class Reference
[QtDesigner module]

The QDesignerCustomWidgetInterface class provides an interface to a custom widget in Qt Designer. More...

    #include <QDesignerCustomWidgetInterface>

- List of all members, including inherited members

### Public Functions

- virtual ~QDesignerCustomWidgetInterface ()
- virtual QString codeTemplate () const
- virtual QWidget * createWidget ( QWidget * parent ) = 0
- virtual QString domXml () const
- virtual QString group () const = 0
- virtual QIcon icon () const = 0
- virtual QString includeFile () const = 0
- virtual void initialize ( QDesignerFormEditorInterface * core )
- virtual bool isContainer () const = 0
- virtual bool isInitialized () const
- virtual QString name () const = 0
- virtual QString toolTip () const = 0
- virtual QString whatsThis () const = 0

## Detailed Description

The QDesignerCustomWidgetInterface class provides an interface to a custom widget in Qt Designer.

See also Creating Custom Widgets for Qt Designer.

## Member Function Documentation

### QDesignerCustomWidgetInterface::~QDesignerCustomWidgetInterface () `[virtual]`

Destroys the custom widget interface.

### QString QDesignerCustomWidgetInterface::codeTemplate () const `[virtual]`

Returns the code template that Qt Designer includes in forms that contain the custom widget when they are saved.

uic uses the code template to provide code for constructing the custom widget.

### QWidget * QDesignerCustomWidgetInterface::createWidget ( QWidget * parent ) `[pure virtual]`

Returns a new widget with the given parent.

### QString QDesignerCustomWidgetInterface::domXml () const `[virtual]`

Returns the XML that is used to describe widget properties to Qt Designer.

### QString QDesignerCustomWidgetInterface::group () const `[pure virtual]`

Returns the name of the group to which the custom widget belongs.

### QIcon QDesignerCustomWidgetInterface::icon () const `[pure virtual]`

Returns the icon used to represent the custom widget in Qt Designer's widget box.

### QString QDesignerCustomWidgetInterface::includeFile () const `[pure virtual]`

Returns the path to the include file that uic uses when creating code for the custom widget.

### void QDesignerCustomWidgetInterface::initialize ( QDesignerFormEditorInterface * core ) `[virtual]`

Initializes the widget for use with the form editor with the specified core interface.

See also isInitialized().

### bool QDesignerCustomWidgetInterface::isContainer () const `[pure virtual]`

Returns true if the custom widget is intended to be used as a container; otherwise returns false.

Most custom widgets are not used to hold other widgets, so their implementations of this function will return false, but custom containers will return true to ensure that they behave correctly in Qt Designer.

### bool QDesignerCustomWidgetInterface::isInitialized () const `[virtual]`

Returns true if the widget has been initialized; otherwise returns false.

See also initialize().

### QString QDesignerCustomWidgetInterface::name () const `[pure virtual]`

Returns the name of the class that implements the custom widget.

### QString QDesignerCustomWidgetInterface::toolTip () const `[pure virtual]`

Returns a short description of the widget that can be used by Qt Designer in a tool tip.

### QString QDesignerCustomWidgetInterface::whatsThis () const `[pure virtual]`

Returns a description of the widget that can be used by Qt Designer in "What's This?" help for the widget.