KRatingPainter Class

Member Function Documentation

KRatingPainter::KRatingPainter()

Create a new KRatingPainter. For most cases the static methods paintRating and getRatingFromPosition should be sufficient.

Qt::Alignment KRatingPainter::alignment() const

The alignment of the stars.

See also setAlignment.

QPixmap KRatingPainter::customPixmap() const

The custom pixmap set to draw a star. If no custom pixmap has been set, an invalid pixmap is returned.

See also setCustomPixmap.

[static] int KRatingPainter::getRatingFromPosition(const QRect &rect, Qt::Alignment align, Qt::LayoutDirection direction, const QPoint &pos)

Get the rating that would be selected if the user clicked position pos within rect if the rating has been drawn with paintRating() using the same rect and align values.

Returns The new rating or -1 if pos is outside of the rating area.

bool KRatingPainter::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 KRatingPainter::icon() const

The icon used to draw a star. In case a custom pixmap has been set this value is ignored.

See also setIcon and setCustomPixmap.

bool KRatingPainter::isEnabled() const

The rating can be painted in a disabled state where no color is used and hover ratings are ignored.

See also setEnabled.

Qt::LayoutDirection KRatingPainter::layoutDirection() const

The layout direction. If RTL the stars representing the rating value will be drawn from the right.

See also setLayoutDirection.

int KRatingPainter::maxRating() const

The maximum rating, i.e. how many stars are drawn in total.

See also setMaxRating.

void KRatingPainter::paint(QPainter *painter, const QRect &rect, int rating, int hoverRating = -1) const

Draw the rating.

painter The painter to draw the rating to.

rect The geometry of the rating. The alignment of the rating is used relative to this value.

rating The actual rating value to draw.

hoverRating The hover rating indicates the position the user hovers the mouse pointer at. This will provide visual feedback about the new rating if the user would actually click as well as the difference to the current rating.

[static] void KRatingPainter::paintRating(QPainter *p, const QRect &rect, Qt::Alignment align, int rating, int hoverRating = -1)

Convenience method that paints a rating into the given rect.

LayoutDirection is read from QPainter.

align can be aligned vertically and horizontally. Using Qt::AlignJustify will insert spacing between the stars.

int KRatingPainter::ratingFromPosition(const QRect &rect, const QPoint &pos) const

Calculate the rating value from mouse position pos.

Returns the rating corresponding to pos or -1 if pos is outside of the configured rect.

void KRatingPainter::setAlignment(Qt::Alignment align)

The alignment of the stars in the drawing rect. All alignment flags are supported.

See also alignment().

void KRatingPainter::setCustomPixmap(const QPixmap &pixmap)

Set a custom pixmap.

See also customPixmap().

void KRatingPainter::setEnabled(bool enabled)

Enable or disable the rating. Default is enabled.

See also isEnabled().

void KRatingPainter::setHalfStepsEnabled(bool enabled)

If half steps are enabled (the default) then one rating step corresponds to half a star.

See also halfStepsEnabled().

void KRatingPainter::setIcon(const QIcon &icon)

Set a custom icon. Defaults to "rating".

See also icon().

void KRatingPainter::setLayoutDirection(Qt::LayoutDirection direction)

LTR or RTL

See also layoutDirection().

void KRatingPainter::setMaxRating(int max)

The maximum rating. Defaults to 10.

See also maxRating().

void KRatingPainter::setSpacing(int spacing)

Set the spacing between rating pixmaps. Be aware that for justified horizontal alignment this values may be ignored.

See also spacing().

int KRatingPainter::spacing() const

The spacing between rating pixmaps.

See also setSpacing.