IOutputPane Class

class Core::IOutputPane

The IOutputPane class is an interface for providing Output panes. More...

Header: #include <coreplugin/ioutputpane.h>
Inherited By:

Core::SearchResultWindow

Public Functions

IOutputPane(QObject *parent)
void flashButton()
void hidePage()
void navigateStateUpdate()
void setBadgeNumber(int number)
void togglePage(int flags)

Protected Functions

void setDisplayName(const QString &name)
void setId(const int &id)
void setPriorityInStatusBar(int priority)

Detailed Description

Member Function Documentation

[default] IOutputPane::IOutputPane(QObject *parent)

Constructs an output pane as the child of parent.

void IOutputPane::flashButton()

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

void IOutputPane::hidePage()

Hides the output pane.

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

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.

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

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

[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

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.