/usr/include/nepomuk/kratingpainter.h is in kdelibs5-dev 4:4.8.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | /*
This file is part of the Nepomuk KDE project.
Copyright (C) 2007-2008 Sebastian Trueg <trueg@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _NEPOMUK_RATING_PAINTER_H_
#define _NEPOMUK_RATING_PAINTER_H_
#include <kdeui_export.h>
#include <QtCore/Qt>
class QIcon;
class QPixmap;
class QPainter;
class QPoint;
class QRect;
/**
* \class KRatingPainter kratingpainter.h Nepomuk/KRatingPainter
*
* \brief Utility class that draws a row of stars for a rating value.
*
* The KRatingPainter also allows to determine a rating value from
* a position in the draw area. it supports all different alignments
* and custom icons.
*
* For showing a rating in a widget see KRatingWidget.
*
* \author Sebastian Trueg <trueg@kde.org>
*
* \since 4.1
*/
class KDEUI_EXPORT KRatingPainter
{
public:
/**
* Create a new KRatingPainter.
* For most cases the static methods paintRating and getRatingFromPosition
* should be sufficient.
*/
KRatingPainter();
/**
* Destructor
*/
~KRatingPainter();
/**
* The maximum rating, i.e. how many stars are drawn
* in total.
*
* \sa setMaxRating
*/
int maxRating() const;
/**
* If half steps are enabled one star equals to 2 rating
* points and uneven rating values result in half-stars being
* drawn.
*
* \sa setHalfStepsEnabled
*/
bool halfStepsEnabled() const;
/**
* The alignment of the stars.
*
* \sa setAlignment
*/
Qt::Alignment alignment() const;
/**
* The layout direction. If RTL the stars
* representing the rating value will be drawn from the
* right.
*
* \sa setLayoutDirection
*/
Qt::LayoutDirection layoutDirection() const;
/**
* The icon used to draw a star. In case a custom pixmap has been set
* this value is ignored.
*
* \sa setIcon, setCustomPixmap
*/
QIcon icon() const;
/**
* The rating can be painted in a disabled state where no color
* is used and hover ratings are ignored.
*
* \sa setEnabled
*/
bool isEnabled() const;
/**
* The custom pixmap set to draw a star. If no custom
* pixmap has been set, an invalid pixmap is returned.
*
* \sa setCustomPixmap
*/
QPixmap customPixmap() const;
/**
* The spacing between rating pixmaps.
*
* \sa setSpacing
*/
int spacing() const;
/**
* The maximum rating. Defaults to 10.
*/
void setMaxRating( int max );
/**
* If half steps are enabled (the default) then
* one rating step corresponds to half a star.
*/
void setHalfStepsEnabled( bool enabled );
/**
* The alignment of the stars in the drawing rect.
* All alignment flags are supported.
*/
void setAlignment( Qt::Alignment align );
/**
* LTR or RTL
*/
void setLayoutDirection( Qt::LayoutDirection direction );
/**
* Set a custom icon. Defaults to "rating".
*/
void setIcon( const QIcon& icon );
/**
* Enable or disable the rating. Default is enabled.
*/
void setEnabled( bool enabled );
/**
* Set a custom pixmap.
*/
void setCustomPixmap( const QPixmap& pixmap );
/**
* Set the spacing between rating pixmaps. Be aware that
* for justified horizontal alignment this values may be
* ignored.
*/
void setSpacing( int spacing );
/**
* Draw the rating.
*
* \param painter The painter to draw the rating to.
* \param rect The geometry of the rating. The alignment of the rating is used relative
* to this value.
* \param rating The actual rating value to draw.
* \param 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.
*/
void paint( QPainter* painter, const QRect& rect, int rating, int hoverRating = -1 ) const;
/**
* Calculate the rating value from mouse position pos.
*
* \return The rating corresponding to pos or -1 if pos is
* outside of the configured rect.
*/
int ratingFromPosition( const QRect& rect, const QPoint& pos ) const;
/**
* Convenience method that paints a rating into the given rect.
*
* LayoutDirection is read from QPainter.
*
* \param align can be aligned vertically and horizontally. Using Qt::AlignJustify will insert spacing
* between the stars.
*/
static void paintRating( QPainter* p, const QRect& rect, Qt::Alignment align, int rating, int hoverRating = -1 );
/**
* 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.
*
* \return The new rating or -1 if pos is outside of the rating area.
*/
static int getRatingFromPosition( const QRect& rect, Qt::Alignment align, Qt::LayoutDirection direction, const QPoint& pos );
private:
class Private;
Private* const d;
};
#endif
|