IOutputPane Class

(Core::IOutputPane)

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

Header: #include <IOutputPane>
Inherited By:

Core::SearchResultWindow

Public Types

enum Flag { NoModeSwitch, ModeSwitch, WithFocus, EnsureSizeHint }
flags Flags

Public Functions

IOutputPane(QObject *parent = nullptr)
virtual ~IOutputPane() override
virtual bool canFocus() const = 0
virtual bool canNavigate() const = 0
virtual bool canNext() const = 0
virtual bool canPrevious() const = 0
virtual void clearContents() = 0
virtual QString displayName() const = 0
virtual void goToNext() = 0
virtual void goToPrev() = 0
virtual bool hasFocus() const = 0
virtual QWidget *outputWidget(QWidget *parent) = 0
virtual int priorityInStatusBar() const = 0
virtual void setFocus() = 0
void setFont(const QFont &font)
void setWheelZoomEnabled(bool enabled)
virtual QList<QWidget *> toolBarWidgets() const
virtual void visibilityChanged(bool visible) = 0

Public Slots

void flash()
void hide()
void navigateStateChanged()
void popup(int flags)
void setIconBadgeNumber(int number)
void toggle(int flags)

Signals

void flashButton()
void fontChanged(const QFont &font)
void hidePage()
void navigateStateUpdate()
void resetZoom()
void setBadgeNumber(int number)
void showPage(int flags)
void togglePage(int flags)
void wheelZoomEnabledChanged(bool enabled)
void zoomIn(int range)
void zoomOut(int range)

Protected Functions

Qt::CaseSensitivity filterCaseSensitivity() const
bool filterIsInverted() const
QString filterText() const
bool filterUsesRegexp() const
QWidget *filterWidget() const
void setFilteringEnabled(bool enable)
void setZoomButtonsEnabled(bool enabled)
void setupContext(const char *context, QWidget *widget)
void setupFilterUi(const QString &historyKey)

Detailed Description

The IOutputPane class is an interface for providing Output panes.

Member Type Documentation

enum IOutputPane::Flag
flags IOutputPane::Flags

This enum type controls the behavior of the output pane when it is requested to show itself.

ConstantValueDescription
Core::IOutputPane::NoModeSwitch0Does not switch between the modes.
Core::IOutputPane::ModeSwitch1Does switch between the modes.
Core::IOutputPane::WithFocus2Sets focus if canFocus returns true.
Core::IOutputPane::EnsureSizeHint4Ensures the use of the minimum size.

The Flags type is a typedef for QFlags<Flag>. It stores an OR combination of Flag values.

Member Function Documentation

IOutputPane::IOutputPane(QObject *parent = nullptr)

Default constructs an instance of IOutputPane.

[override virtual] IOutputPane::~IOutputPane()

Destroys the instance of IOutputPane. The destructor is virtual.

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

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

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

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

[pure virtual] void IOutputPane::clearContents()

[pure virtual] QString IOutputPane::displayName() const

[protected] Qt::CaseSensitivity IOutputPane::filterCaseSensitivity() const

[protected] bool IOutputPane::filterIsInverted() const

[protected] QString IOutputPane::filterText() const

[protected] bool IOutputPane::filterUsesRegexp() const

[protected] QWidget *IOutputPane::filterWidget() const

[slot] void IOutputPane::flash()

[signal] void IOutputPane::flashButton()

[signal] void IOutputPane::fontChanged(const QFont &font)

[pure virtual] void IOutputPane::goToNext()

[pure virtual] void IOutputPane::goToPrev()

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

[slot] void IOutputPane::hide()

[signal] void IOutputPane::hidePage()

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

[pure virtual] int IOutputPane::priorityInStatusBar() const

[signal] void IOutputPane::resetZoom()

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

[protected] void IOutputPane::setFilteringEnabled(bool enable)

[pure virtual] void IOutputPane::setFocus()

See also hasFocus().

void IOutputPane::setFont(const QFont &font)

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

void IOutputPane::setWheelZoomEnabled(bool enabled)

[protected] void IOutputPane::setZoomButtonsEnabled(bool enabled)

[protected] void IOutputPane::setupContext(const char *context, QWidget *widget)

[protected] void IOutputPane::setupFilterUi(const QString &historyKey)

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

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

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

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

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

[signal] void IOutputPane::wheelZoomEnabledChanged(bool enabled)

[signal] void IOutputPane::zoomIn(int range)

[signal] void IOutputPane::zoomOut(int range)