DetailsWidget Class | Extending Qt Creator Manual

Extending Qt Creator Manual | DetailsWidget

Extending Qt Creator Manual 4.6.0

# DetailsWidget Class

(Utils::DetailsWidget)

The DetailsWidget class implements a button to expand a Details area. More...

Header: | #include <DetailsWidget>

- List of all members, including inherited members

## Public Types

enum | State { Expanded, Collapsed, NoSummary, OnlySummary }

## Properties

additionalSummaryText : QString checked : bool state : State | summaryText : QString useCheckBox : bool

## Public Functions

| DetailsWidget(QWidget *parent = 0)
virtual | ~DetailsWidget()
QString | additionalSummaryText() const
bool | isChecked() const
void | setAdditionalSummaryText(const QString &text)
void | setChecked(bool b)
void | setIcon(const QIcon &icon)
void | setState(State state)
void | setSummaryFontBold(bool b)
void | setSummaryText(const QString &text)
void | setToolWidget(FadingPanel *widget)
void | setUseCheckBox(bool b)
void | setWidget(QWidget *widget)
State | state() const
QString | summaryText() const
QWidget * | takeWidget()
QWidget * | toolWidget() const
bool | useCheckBox()
QWidget * | widget() const

## Signals

void | checked(bool)
void | expanded(bool)
void | linkActivated(const QString &link)

## Static Public Members

QPixmap | createBackground(const QSize &size, int topHeight, QWidget *widget)

## Protected Functions

virtual void | enterEvent(QEvent *event)
virtual void | leaveEvent(QEvent *event)
virtual void | paintEvent(QPaintEvent *paintEvent)

## Detailed Description

The DetailsWidget class implements a button to expand a Details area.

This widget is using a grid layout and places the items in the following way:

      +------------+-------------------------+---------------+
      +summaryLabel|              toolwidget | detailsButton |
      +------------+-------------------------+---------------+
      +                additional summary                    |
      +------------+-------------------------+---------------+
      |                  widget                              |
      +------------+-------------------------+---------------+

## Member Type Documentation

### enum DetailsWidget::State

## Property Documentation

### additionalSummaryText : QString

Access functions:

QString | additionalSummaryText() const
void | setAdditionalSummaryText(const QString &text)

### checked : bool

Access functions:

bool | isChecked() const
void | setChecked(bool b)

### state : State

Access functions:

State | state() const
void | setState(State state)

### summaryText : QString

Access functions:

QString | summaryText() const
void | setSummaryText(const QString &text)

### useCheckBox : bool

Access functions:

bool | useCheckBox()
void | setUseCheckBox(bool b)

## Member Function Documentation

### DetailsWidget::DetailsWidget(QWidget *parent = 0)

Default constructs an instance of DetailsWidget.

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

Destroys the instance of DetailsWidget. The destructor is virtual.

### `[signal]` void DetailsWidget::checked(bool)

See also setChecked().

### `[static]` QPixmap DetailsWidget::createBackground(const QSize &size, int topHeight, QWidget *widget)

### `[virtual protected]` void DetailsWidget::enterEvent(QEvent *event)

### `[signal]` void DetailsWidget::expanded(bool)

### `[virtual protected]` void DetailsWidget::leaveEvent(QEvent *event)

### `[signal]` void DetailsWidget::linkActivated(const QString &link)

### `[virtual protected]` void DetailsWidget::paintEvent(QPaintEvent *paintEvent)

### void DetailsWidget::setIcon(const QIcon &icon)

### void DetailsWidget::setSummaryFontBold(bool b)

### void DetailsWidget::setToolWidget(FadingPanel *widget)

See also toolWidget().

### void DetailsWidget::setWidget(QWidget *widget)

See also widget().

### QWidget *DetailsWidget::takeWidget()

### QWidget *DetailsWidget::toolWidget() const

See also setToolWidget().

### QWidget *DetailsWidget::widget() const

See also setWidget().