Viadeo Twitter Google Bookmarks ! Facebook Digg del.icio.us MySpace Yahoo MyWeb Blinklist Netvouz Reddit Simpy StumbleUpon Bookmarks Windows Live Favorites 
Logo Documentation Qt ·  Page d'accueil  ·  Tous les espaces de nom  ·  Toutes les classes  ·  Classes principales  ·  Annotées  ·  Classes groupées  ·  Modules  ·  Fonctions  · 

QStyleOption Class Reference
[QtGui module]

The QStyleOption class stores the parameters used by QStyle functions. More...

 #include <QStyleOption>

Inherited by QStyleOptionButton, QStyleOptionComplex, QStyleOptionDockWidget, QStyleOptionFocusRect, QStyleOptionFrame, QStyleOptionGraphicsItem, QStyleOptionHeader, QStyleOptionMenuItem, QStyleOptionProgressBar, QStyleOptionQ3DockWindow, QStyleOptionQ3ListViewItem, QStyleOptionRubberBand, QStyleOptionTab, QStyleOptionTabBarBase, QStyleOptionTabWidgetFrame, QStyleOptionToolBar, QStyleOptionToolBox, and QStyleOptionViewItem.

Public Types

Public Functions

Public Variables

Related Non-Members


Detailed Description

The QStyleOption class stores the parameters used by QStyle functions.

QStyleOption and its subclasses contain all the information that QStyle functions need to draw a graphical element.

For performance reasons, there are few member functions and the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

The caller of a QStyle function usually creates QStyleOption objects on the stack. This combined with Qt's extensive use of implicit sharing for types such as QString, QPalette, and QColor ensures that no memory allocation needlessly takes place.

The following code snippet shows how to use a specific QStyleOption subclass to paint a push button:

 void MyPushButton::paintEvent(QPaintEvent *)
 {
     QStyleOptionButton option;
     option.initFrom(this);
     option.state = isDown() ? QStyle::State_Sunken : QStyle::State_Raised;
     if (isDefault())
         option.features |= QStyleOptionButton::DefaultButton;
     option.text = text();
     option.icon = icon();

     QPainter painter(this);
     style()->drawControl(QStyle::CE_PushButton, &option, &painter, this);
 }

In our example, the control is a QStyle::CE_PushButton, and according to the QStyle::drawControl() documentation the corresponding class is QStyleOptionButton.

When reimplementing QStyle functions that take a QStyleOption parameter, you often need to cast the QStyleOption to a subclass. For safety, you can use qstyleoption_cast() to ensure that the pointer type is correct. For example:

 void MyStyle::drawPrimitive(PrimitiveElement element,
                             const QStyleOption *option,
                             QPainter *painter,
                             const QWidget *widget)
 {
     if (element == PE_FrameFocusRect) {
         const QStyleOptionFocusRect *focusRectOption =
                 qstyleoption_cast<const QStyleOptionFocusRect *>(option);
         if (focusRectOption) {
             // ...
         }
     }
     // ...
 }

The qstyleoption_cast() function will return 0 if the object to which option points is not of the correct type.

For an example demonstrating how style options can be used, see the Styles example.

See also QStyle and QStylePainter.


Member Type Documentation

enum QStyleOption::OptionType

This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

ConstantValueDescription
QStyleOption::SO_Button2QStyleOptionButton
QStyleOption::SO_ComboBox?QStyleOptionComboBox
QStyleOption::SO_Complex0xf0000QStyleOptionComplex
QStyleOption::SO_Default0QStyleOption
QStyleOption::SO_DockWidget10QStyleOptionDockWidget
QStyleOption::SO_FocusRect1QStyleOptionFocusRect
QStyleOption::SO_Frame5QStyleOptionFrame QStyleOptionFrameV2
QStyleOption::SO_GraphicsItem17QStyleOptionGraphicsItem
QStyleOption::SO_GroupBox?QStyleOptionGroupBox
QStyleOption::SO_Header8QStyleOptionHeader
QStyleOption::SO_MenuItem4QStyleOptionMenuItem
QStyleOption::SO_ProgressBar6QStyleOptionProgressBar QStyleOptionProgressBarV2
QStyleOption::SO_RubberBand15QStyleOptionRubberBand
QStyleOption::SO_SizeGrip?QStyleOptionSizeGrip
QStyleOption::SO_Slider?QStyleOptionSlider
QStyleOption::SO_SpinBox?QStyleOptionSpinBox
QStyleOption::SO_Tab3QStyleOptionTab
QStyleOption::SO_TabBarBase14QStyleOptionTabBarBase
QStyleOption::SO_TabWidgetFrame13QStyleOptionTabWidgetFrame
QStyleOption::SO_TitleBar?QStyleOptionTitleBar
QStyleOption::SO_ToolBar16QStyleOptionToolBar
QStyleOption::SO_ToolBox7QStyleOptionToolBox
QStyleOption::SO_ToolButton?QStyleOptionToolButton
QStyleOption::SO_ViewItem12QStyleOptionViewItem (used in Interviews)

The following values are used for custom controls:

ConstantValueDescription
QStyleOption::SO_CustomBase0xf00Reserved for custom QStyleOptions; all custom controls values must be above this value
QStyleOption::SO_ComplexCustomBase0xf000000Reserved for custom QStyleOptions; all custom complex controls values must be above this value

Some style options are defined for various Qt3Support controls:

ConstantValueDescription
QStyleOption::SO_Q3DockWindow9QStyleOptionQ3DockWindow
QStyleOption::SO_Q3ListView?QStyleOptionQ3ListView
QStyleOption::SO_Q3ListViewItem11QStyleOptionQ3ListViewItem

See also type.

enum QStyleOption::StyleOptionType

This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass.

ConstantValueDescription
QStyleOption::TypeSO_DefaultThe type of style option provided (SO_Default for this class).

The type is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

See also StyleOptionVersion.

enum QStyleOption::StyleOptionVersion

This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass.

ConstantValueDescription
QStyleOption::Version11

The version is used by QStyleOption subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast(), you normally don't need to check it.

See also StyleOptionType.


Member Function Documentation

QStyleOption::QStyleOption ( int version = QStyleOption::Version, int type = SO_Default )

Constructs a QStyleOption with the specified version and type.

The version has no special meaning for QStyleOption; it can be used by subclasses to distinguish between different version of the same option type.

The state member variable is initialized to QStyle::State_None.

See also version and type.

QStyleOption::QStyleOption ( const QStyleOption & other )

Constructs a copy of other.

QStyleOption::~QStyleOption ()

Destroys this style option object.

void QStyleOption::initFrom ( const QWidget * widget )

Initializes the state, direction, rect, palette, and fontMetrics member variables based on the specified widget.

This is a convenience function; the member variables can also be initialized manually.

This function was introduced in Qt 4.1.

See also QWidget::layoutDirection(), QWidget::rect(), QWidget::palette(), and QWidget::fontMetrics().

QStyleOption & QStyleOption::operator= ( const QStyleOption & other )

Assign other to this QStyleOption.


Member Variable Documentation

Qt::LayoutDirection QStyleOption::direction

This variable holds the text layout direction that should be used when drawing text in the control.

By default, the layout direction is Qt::LeftToRight.

See also initFrom().

QFontMetrics QStyleOption::fontMetrics

This variable holds the font metrics that should be used when drawing text in the control.

By default, the application's default font is used.

See also initFrom().

QPalette QStyleOption::palette

This variable holds the palette that should be used when painting the control.

By default, the application's default palette is used.

See also initFrom().

QRect QStyleOption::rect

This variable holds the area that should be used for various calculations and painting.

This can have different meanings for different types of elements. For example, for a QStyle::CE_PushButton element it would be the rectangle for the entire button, while for a QStyle::CE_PushButtonLabel element it would be just the area for the push button label.

The default value is a null rectangle, i.e. a rectangle with both the width and the height set to 0.

See also initFrom().

QStyle::State QStyleOption::state

This variable holds the style flags that are used when drawing the control.

The default value is QStyle::State_None.

See also initFrom(), QStyle::drawPrimitive(), QStyle::drawControl(), QStyle::drawComplexControl(), and QStyle::State.

int QStyleOption::type

This variable holds the option type of the style option.

The default value is SO_Default.

See also OptionType.

int QStyleOption::version

This variable holds the version of the style option.

This value can be used by subclasses to implement extensions without breaking compatibility. If you use the qstyleoption_cast() function, you normally don't need to check it.

The default value is 1.


Related Non-Members

T qstyleoption_cast ( const QStyleOption * option )

Returns a T or 0 depending on the type and version of the given option.

Example:

 void MyStyle::drawPrimitive(PrimitiveElement element,
                             const QStyleOption *option,
                             QPainter *painter,
                             const QWidget *widget)
 {
     if (element == PE_FrameFocusRect) {
         const QStyleOptionFocusRect *focusRectOption =
                 qstyleoption_cast<const QStyleOptionFocusRect *>(option);
         if (focusRectOption) {
             // ...
         }
     }
     // ...
 }

See also QStyleOption::type and QStyleOption::version.

T qstyleoption_cast ( QStyleOption * option )

This is an overloaded member function, provided for convenience.

Returns a T or 0 depending on the type of the given option.

Publicité

Best Of

Actualités les plus lues

Semaine
Mois
Année
  1. « Quelque chose ne va vraiment pas avec les développeurs "modernes" », un développeur à "l'ancienne" critique la multiplication des bibliothèques 53
  2. Les développeurs ignorent-ils trop les failles découvertes dans leur code ? Prenez-vous en compte les remarques des autres ? 17
  3. BlackBerry 10 : premières images du prochain OS de RIM qui devrait intégrer des widgets et des tuiles inspirées de Windows Phone 0
  4. Quelles nouveautés de C++11 Visual C++ doit-il rapidement intégrer ? Donnez-nous votre avis 10
  5. Adieu qmake, bienvenue qbs : Qt Building Suite, un outil déclaratif et extensible pour la compilation de projets Qt 17
  6. Apercevoir la troisième dimension ou l'utilisation multithreadée d'OpenGL dans Qt, un article des Qt Quarterly traduit par Guillaume Belz 0
  7. La rubrique Qt a besoin de vous ! 1
Page suivante

Le blog Digia au hasard

Logo

Déploiement d'applications Qt Commercial sur les tablettes Windows 8

Le blog Digia est l'endroit privilégié pour la communication sur l'édition commerciale de Qt, où des réponses publiques sont apportées aux questions les plus posées au support. Lire l'article.

Communauté

Ressources

Liens utiles

Contact

  • Vous souhaitez rejoindre la rédaction ou proposer un tutoriel, une traduction, une question... ? Postez dans le forum Contribuez ou contactez-nous par MP ou par email (voir en bas de page).

Qt dans le magazine

Cette page est une traduction d'une page de la documentation de Qt, écrite par Nokia Corporation and/or its subsidiary(-ies). Les éventuels problèmes résultant d'une mauvaise traduction ne sont pas imputables à Nokia. Qt 4.4
Copyright © 2012 Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon, vous encourez selon la loi jusqu'à 3 ans de prison et jusqu'à 300 000 E de dommages et intérêts. Cette page est déposée à la SACD.
Vous avez déniché une erreur ? Un bug ? Une redirection cassée ? Ou tout autre problème, quel qu'il soit ? Ou bien vous désirez participer à ce projet de traduction ? N'hésitez pas à nous contacter ou par MP !
 
 
 
 
Partenaires

Hébergement Web