IOutputPane Class

Member Function Documentation

IOutputPane::IOutputPane(QObject *parent = nullptr)

Constructs an output pane as the child of parent.

[pure virtual] bool IOutputPane::canFocus() const

Returns true when the output pane can be focused right now (for example, the search result window does not want to be focused if there are no results).

[pure virtual] bool IOutputPane::canNavigate() const

Determines whether the output pane's navigation buttons can be enabled. When this returns false, the buttons are disabled and cannot be enabled.

See also IOutputPane::canNext() and IOutputPane::canPrevious().

[pure virtual] bool IOutputPane::canNext() const

Determines whether the Next button in the output pane is enabled. Is overwritten when canNavigate() returns false.

See also IOutputPane::canNavigate(), IOutputPane::canPrevious(), and IOutputPane::goToNext().

[pure virtual] bool IOutputPane::canPrevious() const

Determines whether the Previous button in the output pane is enabled. Is overwritten when canNavigate() returns false.

See also IOutputPane::canNavigate(), IOutputPane::canNext(), and IOutputPane::goToPrev().

[pure virtual] void IOutputPane::clearContents()

Is called on selecting the clear button.

QString IOutputPane::displayName() const

Returns the translated display name of the output pane.

See also setDisplayName().

[slot] void IOutputPane::flash()

Emits the signal flashButton().

See also IOutputPane::flashButton().

[signal] void IOutputPane::flashButton()

Makes the status bar button belonging to the output pane flash.

[pure virtual] void IOutputPane::goToNext()

Is called on selecting the Next button.

See also IOutputPane::canNext().

[pure virtual] void IOutputPane::goToPrev()

Is called on selecting the Previous button.

See also IOutputPane::canPrevious().

[pure virtual] bool IOutputPane::hasFocus() const

Returns true when the output pane has focus.

See also IOutputPane::canFocus().

[slot] void IOutputPane::hide()

Emits the signal hidePage().

See also IOutputPane::hidePage().

[signal] void IOutputPane::hidePage()

Hides the output pane.

Utils::Id IOutputPane::id() const

Returns the ID of the output pane.

See also setId().

[slot] void IOutputPane::navigateStateChanged()

Emits the signal navigateStateUpdate().

See also IOutputPane::navigateStateUpdate().

[signal] void IOutputPane::navigateStateUpdate()

Notifies the output pane manager that the state of canNext, canPrevious, or canNavigate has changed and the buttons need to be updated.

[pure virtual] QWidget *IOutputPane::outputWidget(QWidget *parent)

Returns the output widget (as the child of parent) for the output pane.

[slot] void IOutputPane::popup(int flags)

Emits the signal showPage(int flags) with the given parameter flags.

See also IOutputPane::showPage().

int IOutputPane::priorityInStatusBar() const

Determines the position of the output pane on the status bar and the default visibility.

See also setPriorityInStatusBar().

[signal] void IOutputPane::setBadgeNumber(int number)

Displays number in the status bar button belonging to the output pane (for example, number of issues on building).

[protected] void IOutputPane::setDisplayName(const QString &name)

Sets the translated display name of the output pane to name.

See also displayName().

[pure virtual] void IOutputPane::setFocus()

Gives focus to the output pane window.

See also hasFocus().

[slot] void IOutputPane::setIconBadgeNumber(int number)

Emits the signal setBadgeNumber(int number) with the given parameter number.

See also IOutputPane::setBadgeNumber().

[protected] void IOutputPane::setId(const Utils::Id &id)

Sets the ID of the output pane to id. This is used for persisting the visibility state.

See also id().

[protected] void IOutputPane::setPriorityInStatusBar(int priority)

Sets the position of the output pane on the status bar and the default visibility to priority.

• higher numbers are further to the front
• >= 0 are shown in status bar by default
• < 0 are not shown in status bar by default

See also priorityInStatusBar().

[signal] void IOutputPane::showPage(int flags)

Shows the output pane. The parameter flags controls the behavior.

See also IOutputPane::Flags.

[slot] void IOutputPane::toggle(int flags)

Emits the signal togglePage(int flags) with the given parameter flags.

See also IOutputPane::togglePage().

[signal] void IOutputPane::togglePage(int flags)

Toggles the hide and show states of the output pane. The parameter flags controls the behavior.

See also IOutputPane::hidePage(), IOutputPane::showPage(), and IOutputPane::Flags.

[virtual] QList<QWidget *> IOutputPane::toolBarWidgets() const

Returns the toolbar widgets for the output pane.

[virtual] void IOutputPane::visibilityChanged(bool visible)

Gets called when the visibility is changed. visible is true when the output pane is now visible or false otherwise.