KDE 4.6 API Reference KRatingWidget Class Reference
Displays a rating value as a row of pixmaps. More...
#include <KDE/KRatingWidget>
Public Slots | |
| void | setAlignment (Qt::Alignment align) |
| void | setCustomPixmap (const QPixmap &pixmap) |
| void | setHalfStepsEnabled (bool enabled) |
| void | setIcon (const QIcon &icon) |
| void | setLayoutDirection (Qt::LayoutDirection direction) |
| void | setMaxRating (int max) |
| void | setMaxRating (unsigned int max) |
| void | setOnlyPaintFullSteps (bool) |
| void | setPixmap (const QPixmap &) |
| void | setPixmapSize (int size) |
| void | setRating (unsigned int rating) |
| void | setRating (int rating) |
| void | setSpacing (int) |
Signals | |
| void | ratingChanged (unsigned int rating) |
| void | ratingChanged (int rating) |
Public Member Functions | |
| KRatingWidget (QWidget *parent=0) | |
| ~KRatingWidget () | |
| Qt::Alignment | alignment () const |
| bool | halfStepsEnabled () const |
| QIcon | icon () const |
| Qt::LayoutDirection | layoutDirection () const |
| int | maxRating () const |
| unsigned int | rating () const |
| QSize | sizeHint () const |
| int | spacing () const |
Protected Member Functions | |
| void | leaveEvent (QEvent *e) |
| void | mouseMoveEvent (QMouseEvent *e) |
| void | mousePressEvent (QMouseEvent *e) |
| void | paintEvent (QPaintEvent *e) |
| void | resizeEvent (QResizeEvent *e) |
Properties | |
| Qt::Alignment | alignment |
| bool | halfStepsEnabled |
| QIcon | icon |
| int | maxRating |
| int | rating |
| int | spacing |
Detailed Description
Displays a rating value as a row of pixmaps.
The KRatingWidget displays a range of stars or other arbitrary pixmaps and allows the user to select a certain number by mouse.
- See also:
- KRatingPainter
Definition at line 40 of file kratingwidget.h.
Constructor & Destructor Documentation
| KRatingWidget::KRatingWidget | ( | QWidget * | parent = 0 | ) |
Creates a new rating widget.
Definition at line 53 of file kratingwidget.cpp.
| KRatingWidget::~KRatingWidget | ( | ) |
Destructor.
Definition at line 61 of file kratingwidget.cpp.
Member Function Documentation
| Qt::Alignment KRatingWidget::alignment | ( | ) | const |
The alignment of the stars.
- See also:
- setAlignment
| bool KRatingWidget::halfStepsEnabled | ( | ) | const |
If half steps are enabled one star equals to 2 rating points and uneven rating values result in half-stars being drawn.
- See also:
- setHalfStepsEnabled
| QIcon KRatingWidget::icon | ( | ) | const |
The icon used to draw a star.
In case a custom pixmap has been set this value is ignored.
- See also:
- setIcon, setCustomPixmap
| Qt::LayoutDirection KRatingWidget::layoutDirection | ( | ) | const |
The layout direction.
If RTL the stars representing the rating value will be drawn from the right.
- See also:
- setLayoutDirection
Definition at line 128 of file kratingwidget.cpp.
| void KRatingWidget::leaveEvent | ( | QEvent * | e | ) | [protected] |
Definition at line 232 of file kratingwidget.cpp.
| int KRatingWidget::maxRating | ( | ) | const |
- Returns:
- the maximum possible rating.
| void KRatingWidget::mouseMoveEvent | ( | QMouseEvent * | e | ) | [protected] |
Definition at line 218 of file kratingwidget.cpp.
| void KRatingWidget::mousePressEvent | ( | QMouseEvent * | e | ) | [protected] |
Definition at line 209 of file kratingwidget.cpp.
| void KRatingWidget::paintEvent | ( | QPaintEvent * | e | ) | [protected] |
Definition at line 239 of file kratingwidget.cpp.
| unsigned int KRatingWidget::rating | ( | ) | const |
- Returns:
- The current rating.
| void KRatingWidget::ratingChanged | ( | unsigned int | rating | ) | [signal] |
This signal is emitted when the rating is changed.
| void KRatingWidget::ratingChanged | ( | int | rating | ) | [signal] |
| void KRatingWidget::resizeEvent | ( | QResizeEvent * | e | ) | [protected] |
Definition at line 264 of file kratingwidget.cpp.
| void KRatingWidget::setAlignment | ( | Qt::Alignment | align | ) | [slot] |
The alignment of the stars in the drawing rect.
All alignment flags are supported.
Definition at line 121 of file kratingwidget.cpp.
| void KRatingWidget::setCustomPixmap | ( | const QPixmap & | pixmap | ) | [slot] |
Set a custom pixmap.
Definition at line 75 of file kratingwidget.cpp.
| void KRatingWidget::setHalfStepsEnabled | ( | bool | enabled | ) | [slot] |
If half steps are enabled (the default) then one rating step corresponds to half a star.
Definition at line 194 of file kratingwidget.cpp.
| void KRatingWidget::setIcon | ( | const QIcon & | icon | ) | [slot] |
| void KRatingWidget::setLayoutDirection | ( | Qt::LayoutDirection | direction | ) | [slot] |
LTR or RTL.
Definition at line 134 of file kratingwidget.cpp.
| void KRatingWidget::setMaxRating | ( | unsigned int | max | ) | [slot] |
Definition at line 180 of file kratingwidget.cpp.
| void KRatingWidget::setMaxRating | ( | int | max | ) | [slot] |
Set the maximum allowed rating value.
The default is 10 which means that a rating from 1 to 10 is selectable. If max is uneven steps are automatically only allowed full.
Definition at line 187 of file kratingwidget.cpp.
| void KRatingWidget::setOnlyPaintFullSteps | ( | bool | fs | ) | [slot] |
- Deprecated:
- Use setHalfStepsEnabled
Definition at line 202 of file kratingwidget.cpp.
| void KRatingWidget::setPixmap | ( | const QPixmap & | pix | ) | [slot] |
Set the pixap to be used to display a rating step.
By default the "rating" pixmap is loaded.
- Deprecated:
- use setCustomPixmap
Definition at line 68 of file kratingwidget.cpp.
| void KRatingWidget::setPixmapSize | ( | int | size | ) | [slot] |
Set the recommended size of the pixmaps.
This is only used for the sizeHint. The actual size is always dependent on the size of the widget itself.
Definition at line 89 of file kratingwidget.cpp.
| void KRatingWidget::setRating | ( | unsigned int | rating | ) | [slot] |
Definition at line 160 of file kratingwidget.cpp.
| void KRatingWidget::setRating | ( | int | rating | ) | [slot] |
Set the current rating.
Calling this method will trigger the ratingChanged signal if rating is different from the previous rating.
Definition at line 167 of file kratingwidget.cpp.
| void KRatingWidget::setSpacing | ( | int | s | ) | [slot] |
Set the spacing between the pixmaps.
The default is 0.
Definition at line 108 of file kratingwidget.cpp.
| QSize KRatingWidget::sizeHint | ( | void | ) | const |
Definition at line 248 of file kratingwidget.cpp.
| int KRatingWidget::spacing | ( | ) | const |
The spacing between the rating stars.
- See also:
- setSpacing
Property Documentation
Qt::Alignment KRatingWidget::alignment [read, write] |
Definition at line 45 of file kratingwidget.h.
bool KRatingWidget::halfStepsEnabled [read, write] |
Definition at line 46 of file kratingwidget.h.
QIcon KRatingWidget::icon [read, write] |
Definition at line 48 of file kratingwidget.h.
int KRatingWidget::maxRating [read, write] |
Definition at line 44 of file kratingwidget.h.
unsigned int KRatingWidget::rating [read, write] |
Definition at line 43 of file kratingwidget.h.
int KRatingWidget::spacing [read, write] |
Definition at line 47 of file kratingwidget.h.
The documentation for this class was generated from the following files:
