RibbonGallery Class Reference

(Qtitan::RibbonGallery)

RibbonGallery class represents the gallery control. More...

    #include <Qtitan>

Inherits QWidget.

Properties

  • 58 properties inherited from QWidget
  • 1 property inherited from QObject

Public Functions

RibbonGallery ( QWidget * parent = Q_NULL )
virtual ~RibbonGallery ()
int checkedIndex () const
RibbonGalleryItem * checkedItem () const
void ensureVisible ( int index )
RibbonGalleryGroup * galleryGroup () const
virtual QRect getBorders () const
QRect getDrawItemRect ( int index )
RibbonGalleryItem * getItem ( int index ) const
int getItemCount () const
QRect getItemsRect () const
int getSelectedItem () const
void hideSelection ()
int hitTestItem ( QPoint point, QRect * rect = Q_NULL ) const
bool isBorderVisible () const
bool isItemSelected () const
bool isLabelsVisible () const
bool isResizable () const
bool isShowAsButton () const
OfficePopupMenu * popupMenu () const
Qt::ScrollBarPolicy scrollBarPolicy () const
virtual void selectedItemChanged ()
void setBorderVisible ( bool visible )
void setCheckedIndex ( int index )
void setCheckedItem ( const RibbonGalleryItem * item )
void setGalleryGroup ( RibbonGalleryGroup * items )
void setLabelsVisible ( bool showLabels )
void setPopupMenu ( OfficePopupMenu * popupMenu )
void setScrollBarPolicy ( Qt::ScrollBarPolicy policy )
void setSelectedItem ( int selected )

Reimplemented Public Functions

virtual QSize minimumSizeHint () const
virtual QSize sizeHint () const
  • 217 public functions inherited from QWidget
  • 13 public functions inherited from QPaintDevice
  • 29 public functions inherited from QObject

Signals

void currentItemChanged ( RibbonGalleryItem * current, RibbonGalleryItem * previous )
void itemClicked ( RibbonGalleryItem * item )
void itemClicking ( RibbonGalleryItem * item, bool & handled )
void itemPressed ( RibbonGalleryItem * item )
void itemSelectionChanged ()

Reimplemented Protected Functions

virtual bool event ( QEvent * event )
virtual void focusOutEvent ( QFocusEvent * event )
virtual void leaveEvent ( QEvent * event )
virtual void mouseMoveEvent ( QMouseEvent * event )
virtual void mousePressEvent ( QMouseEvent * event )
virtual void mouseReleaseEvent ( QMouseEvent * event )
virtual void paintEvent ( QPaintEvent * )
virtual void resizeEvent ( QResizeEvent * event )
  • 37 protected functions inherited from QWidget
  • 1 protected function inherited from QPaintDevice
  • 7 protected functions inherited from QObject

Additional Inherited Members

  • 19 public slots inherited from QWidget
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 4 static public members inherited from QWidget
  • 4 static public members inherited from QObject
  • 37 protected functions inherited from QWidget
  • 1 protected function inherited from QPaintDevice
  • 7 protected functions inherited from QObject
  • 1 protected slot inherited from QWidget
  • 1 protected type inherited from QPaintDevice
  • 2 protected variables inherited from QObject

Detailed Description

RibbonGallery class represents the gallery control.

Property Documentation

isBorderVisible : bool

Access functions:

bool isBorderVisible () const
void setBorderVisible ( bool visible )

isResizable : const bool

Access functions:

bool isResizable () const

scrollBarPolicy : Qt::ScrollBarPolicy

Access functions:

Qt::ScrollBarPolicy scrollBarPolicy () const
void setScrollBarPolicy ( Qt::ScrollBarPolicy policy )

Member Function Documentation

RibbonGallery::RibbonGallery ( QWidget * parent = Q_NULL )

Constructs RibbonGallery object with the given parent.

RibbonGallery::~RibbonGallery () [virtual]

Destructor of the RibbonGallery object.

int RibbonGallery::checkedIndex () const

Returns chcked item index in the gallery.

See also setCheckedIndex().

RibbonGalleryItem * RibbonGallery::checkedItem () const

Returs the reference to the RibbonGalleryItem object of the chcked item in the gallery. See int getCheckedIndex();

See also setCheckedItem().

void RibbonGallery::currentItemChanged ( RibbonGalleryItem * current, RibbonGalleryItem * previous ) [signal]

Signal throws when the current item was changed. previous - reference to the previous selected item. current the reference to the current selected item.

void RibbonGallery::ensureVisible ( int index )

bool RibbonGallery::event ( QEvent * event ) [virtual protected]

Reimplemented from QObject::event().

void RibbonGallery::focusOutEvent ( QFocusEvent * event ) [virtual protected]

Reimplemented from QWidget::focusOutEvent().

RibbonGalleryGroup * RibbonGallery::galleryGroup () const

Returns reference to the RibbonGalleryGroup object.

See also setGalleryGroup().

QRect RibbonGallery::getBorders () const [virtual]

Returns the bounds of gallery in the rectangle form.

QRect RibbonGallery::getDrawItemRect ( int index )

Returns the bounded rectangle of the item by the given index.

RibbonGalleryItem * RibbonGallery::getItem ( int index ) const

Returns reference to the RibbonGalleryItem by the given index.

int RibbonGallery::getItemCount () const

Returns count of the items in the gallery.

QRect RibbonGallery::getItemsRect () const

Returns the united boundary of all elements within the galleries.

int RibbonGallery::getSelectedItem () const

Returns the index of the selected element in the gallery.

void RibbonGallery::hideSelection ()

Hide selection of the gallery's item.

int RibbonGallery::hitTestItem ( QPoint point, QRect * rect = Q_NULL ) const

Returns the index of the item by given mouse point. If rect is not Q_NULL it will contain the rectangle the gallery's item.

bool RibbonGallery::isItemSelected () const

Returns whether selected items in the gallery.

bool RibbonGallery::isLabelsVisible () const

bool RibbonGallery::isShowAsButton () const

Returns if the gallery needs to draw a normal button. Function is reserved.

void RibbonGallery::itemClicked ( RibbonGalleryItem * item ) [signal]

Signal throws when you click on the item in the gallery.

void RibbonGallery::itemClicking ( RibbonGalleryItem * item, bool & handled ) [signal]

Signal throws when user is clicking on the item in the gallery. item - the reference to teh clicking element. handled - the flag to prevent of closing the gallery popup. If handled is false then the gallery popup will not be closed.

void RibbonGallery::itemPressed ( RibbonGalleryItem * item ) [signal]

Signal throws when you press mouse button on the item in the gallery.

void RibbonGallery::itemSelectionChanged () [signal]

Signal throws when selected was changed.

void RibbonGallery::leaveEvent ( QEvent * event ) [virtual protected]

Reimplemented from QWidget::leaveEvent().

QSize RibbonGallery::minimumSizeHint () const [virtual]

Reimplemented from QWidget::minimumSizeHint().

void RibbonGallery::mouseMoveEvent ( QMouseEvent * event ) [virtual protected]

Reimplemented from QWidget::mouseMoveEvent().

void RibbonGallery::mousePressEvent ( QMouseEvent * event ) [virtual protected]

Reimplemented from QWidget::mousePressEvent().

void RibbonGallery::mouseReleaseEvent ( QMouseEvent * event ) [virtual protected]

Reimplemented from QWidget::mouseReleaseEvent().

void RibbonGallery::paintEvent ( QPaintEvent * ) [virtual protected]

Reimplemented from QWidget::paintEvent().

OfficePopupMenu * RibbonGallery::popupMenu () const

Returns gallery's popup menu.

See also setPopupMenu().

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

Reimplemented from QWidget::resizeEvent().

void RibbonGallery::selectedItemChanged () [virtual]

void RibbonGallery::setCheckedIndex ( int index )

Sets checked item with the given index.

See also checkedIndex().

void RibbonGallery::setCheckedItem ( const RibbonGalleryItem * item )

Sets checked item with the given reference to the RibbonGalleryItem object. See setCheckedIndex(int index).

See also checkedItem().

void RibbonGallery::setGalleryGroup ( RibbonGalleryGroup * items )

Sets group for the gallery. group - is a pointer to the elements group.

See also galleryGroup().

void RibbonGallery::setLabelsVisible ( bool showLabels )

See also isLabelsVisible().

void RibbonGallery::setPopupMenu ( OfficePopupMenu * popupMenu )

Sets popup menu for the gallery.

See also popupMenu().

void RibbonGallery::setSelectedItem ( int selected )

Sets the selected element in the gallery. selected is the index of the selected element.

QSize RibbonGallery::sizeHint () const [virtual]

Reimplemented from QWidget::sizeHint().