RibbonPage Class

RibbonPage class implements the Ribbon UI Page. Used to place objects of type - RibbonGroup. More...

Header: #include <RibbonPage>
Inherits: QWidget

Properties

Public Functions

RibbonPage(QWidget *parent = Q_NULL)
virtual ~RibbonPage()
void addGroup(RibbonGroup *group)
RibbonGroup *addGroup(const QString &title)
RibbonGroup *addGroup(const QIcon &icon, const QString &title)
void clearGroups()
const QColor &contextColor() const
const QString &contextGroupName() const
const QString &contextTitle() const
RibbonGroup *group(int index) const
int groupCount() const
int groupIndex(RibbonGroup *group) const
void insertGroup(int index, RibbonGroup *group)
RibbonGroup *insertGroup(int index, const QString &title)
RibbonGroup *insertGroup(int index, const QIcon &icon, const QString &title)
bool isVisible() const
void removeGroup(RibbonGroup *group)
void removeGroupByIndex(int index)
RibbonBar *ribbonBar() const
void setContextColor(Qtitan::ContextColor color)
const QString &title() const

Reimplemented Public Functions

virtual void setVisible(bool visible) override
virtual QSize sizeHint() const override

Public Slots

void setContextColor(const QColor &color)
void setContextGroupName(const QString &groupName)
void setContextTitle(const QString &title)
void setTitle(const QString &title)

Signals

void titleChanged(const QString &title)

Reimplemented Protected Functions

virtual void changeEvent(QEvent *event) override
virtual bool event(QEvent *event) override
virtual void paintEvent(QPaintEvent *event) override
virtual void resizeEvent(QResizeEvent *event) override

Detailed Description

Property Documentation

contextTitle : const QString&

Sets the context title of the page. Context title is located on main window frame if page is contextual.

Access functions:

const QString &contextTitle() const
void setContextTitle(const QString &title)

See also RibbonPage::title.

Member Function Documentation

RibbonPage::RibbonPage(QWidget *parent = Q_NULL)

Constructs RibbonPage with the given parent.

[slot] void RibbonPage::setContextColor(const QColor &color)

Sets the color for the contextual page.

Note: Setter function for property contextColor.

[slot] void RibbonPage::setTitle(const QString &title)

Sets the page title to the specified value.

Note: Setter function for property title.

See also title().

[signal] void RibbonPage::titleChanged(const QString &title)

The signal is emitted after the page title has been changed.

[virtual] RibbonPage::~RibbonPage()

The RibbonPage object's destructor.

void RibbonPage::addGroup(RibbonGroup *group)

Adds existing ribbon group to the ribbon page.

RibbonGroup *RibbonPage::addGroup(const QString &title)

Creates and adds the ribbon group with given title to the ribbon page.

RibbonGroup *RibbonPage::addGroup(const QIcon &icon, const QString &title)

Adds group with given icon and title to the ribbon page.

[override virtual protected] void RibbonPage::changeEvent(QEvent *event)

Reimplements: QWidget::changeEvent(QEvent *event).

void RibbonPage::clearGroups()

Removes all groups from this ribbon page.

const QColor &RibbonPage::contextColor() const

Returns the predefined color for the contextual page.

Note: Getter function for property contextColor.

See also setContextColor().

[override virtual protected] bool RibbonPage::event(QEvent *event)

Reimplements: QWidget::event(QEvent *event).

RibbonGroup *RibbonPage::group(int index) const

Returns ribbon group by index.

int RibbonPage::groupCount() const

Returns ribbon group count in the ribbon page.

Note: Getter function for property groupCount.

int RibbonPage::groupIndex(RibbonGroup *group) const

Returns ribbon group index by RibbonGroup object.

void RibbonPage::insertGroup(int index, RibbonGroup *group)

Inserts an existing ribbon group with to the position index.

RibbonGroup *RibbonPage::insertGroup(int index, const QString &title)

Creates a new ribbon group with the given title and inserts it to the position index. Returns a pointer to the new object RibbonGroup.

RibbonGroup *RibbonPage::insertGroup(int index, const QIcon &icon, const QString &title)

Creates a new ribbon group with the given title, icon and inserts it to the position index. Returns a pointer to the new object RibbonGroup.

bool RibbonPage::isVisible() const

Overloaded method. Returns true if page is visible in the ribbon bar.

[override virtual protected] void RibbonPage::paintEvent(QPaintEvent *event)

Reimplements: QWidget::paintEvent(QPaintEvent *event).

void RibbonPage::removeGroup(RibbonGroup *group)

Removes an existing ribbon group.

void RibbonPage::removeGroupByIndex(int index)

Removes an existing ribbon group in the position index.

[override virtual protected] void RibbonPage::resizeEvent(QResizeEvent *event)

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

RibbonBar *RibbonPage::ribbonBar() const

Returns the ribbon bar that holds this page.

void RibbonPage::setContextColor(Qtitan::ContextColor color)

Sets the predefined color for the contextual page.

Note: Setter function for property contextColor.

See also contextColor().

[override virtual] void RibbonPage::setVisible(bool visible)

See also isVisible().

[override virtual] QSize RibbonPage::sizeHint() const

Reimplements an access function for property: QWidget::sizeHint.

const QString &RibbonPage::title() const

Returns the ribbon page title.

Note: Getter function for property title.

See also setTitle() and RibbonPage::contextTitle.