1
0
mirror of https://github.com/tomahawk-player/tomahawk.git synced 2025-03-19 23:39:42 +01:00

Add some documentation to the new classes

This commit is contained in:
Casey Link 2011-08-29 19:25:42 -05:00
parent 3e12072dd9
commit 57dea3061b
5 changed files with 42 additions and 3 deletions

View File

@ -27,20 +27,42 @@
class QPalette;
class QPainter;
/**
* \class StyleHelper
* \brief A static class that contains Tomahawk's styling details (colors, etc).
*/
class StyleHelper
{
public:
/**
* Our header BG is a two color gradient. This is the upper color.
*/
static QColor headerUpperColor();
/**
* Our header BG is a two color gradient. This is the lower color.
*/
static QColor headerLowerColor();
/**
* The color of text on a Header.
*/
static QColor headerTextColor();
/**
* The widget highlight color for headers
*/
static QColor headerHighlightColor();
/**
* Draws a header background on a painter with the specified rectangle
*/
static void horizontalHeader(QPainter *painter, const QRect &rect);
/**
* Draws a styled arrow that looks good on a Header (from qwindowstyle.cpp)
* \copyright { Licensed under the GPL v3+
* Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
* Contact: Nokia Corporation (qt-info@nokia.com) }
*/
static void drawArrow(QStyle::PrimitiveElement, QPainter *painter, const QStyleOption *opt);
private:
static QColor m_baseColor;
static QColor m_requestedBaseColor;
};
#endif // STYLEHELPER_H

View File

@ -23,6 +23,10 @@
#include "dllmacro.h"
/**
* \class HeaderLabel
* \brief A styled label for use in headers.
*/
class DLLEXPORT HeaderLabel : public QLabel
{
Q_OBJECT

View File

@ -25,6 +25,11 @@
#include "dllmacro.h"
/**
* \class HeaderWidget
* \brief A QWidget subclass with a background for use in headers.
*/
class DLLEXPORT HeaderWidget : public QWidget
{
Q_OBJECT

View File

@ -24,6 +24,10 @@
#include "dllmacro.h"
/**
* \class ComboBox
* \brief A styled combo box that has a header background.
*/
class DLLEXPORT ComboBox : public QComboBox
{
Q_OBJECT

View File

@ -43,6 +43,10 @@ namespace Ui
class WhatsHotWidget;
}
/**
* \class
* \brief The tomahawk page that shows music charts.
*/
class DLLEXPORT WhatsHotWidget : public QWidget, public Tomahawk::ViewPage
{
Q_OBJECT