Qt 4.8
Public Types | Public Functions | Public Variables | Protected Functions | List of all members
QStyleOptionViewItem Class Reference

The QStyleOptionViewItem class is used to describe the parameters used to draw an item in a view widget. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionViewItem:
QStyleOption QStyleOptionViewItemV2 QStyleOptionViewItemV3 QStyleOptionViewItemV4

Public Types

enum  Position { Left, Right, Top, Bottom }
 This enum describes the position of the item's decoration. More...
 
enum  StyleOptionType { Type = SO_ViewItem }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOption
enum  OptionType {
  SO_Default, SO_FocusRect, SO_Button, SO_Tab,
  SO_MenuItem, SO_Frame, SO_ProgressBar, SO_ToolBox,
  SO_Header, SO_Q3DockWindow, SO_DockWidget, SO_Q3ListViewItem,
  SO_ViewItem, SO_TabWidgetFrame, SO_TabBarBase, SO_RubberBand,
  SO_ToolBar, SO_GraphicsItem, SO_Complex = 0xf0000, SO_Slider,
  SO_SpinBox, SO_ToolButton, SO_ComboBox, SO_Q3ListView,
  SO_TitleBar, SO_GroupBox, SO_SizeGrip, SO_CustomBase = 0xf00,
  SO_ComplexCustomBase = 0xf000000
}
 This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. More...
 
enum  StyleOptionType { Type = SO_Default }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 

Public Functions

 QStyleOptionViewItem ()
 Constructs a QStyleOptionViewItem, initializing the members variables to their default values. More...
 
 QStyleOptionViewItem (const QStyleOptionViewItem &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOption
void init (const QWidget *w)
 Use initFrom(widget) instead. More...
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption. More...
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type. More...
 
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other. More...
 
 ~QStyleOption ()
 Destroys this style option object. More...
 

Public Variables

Qt::Alignment decorationAlignment
 the alignment of the decoration for the item More...
 
Position decorationPosition
 the position of the decoration for the item More...
 
QSize decorationSize
 the size of the decoration for the item More...
 
Qt::Alignment displayAlignment
 the alignment of the display value for the item More...
 
QFont font
 the font used for the item More...
 
bool showDecorationSelected
 whether the decoration should be highlighted on selected items More...
 
Qt::TextElideMode textElideMode
 where ellipsis should be added for text that is too long to fit into an item More...
 
- Public Variables inherited from QStyleOption
Qt::LayoutDirection direction
 the text layout direction that should be used when drawing text in the control More...
 
QFontMetrics fontMetrics
 the font metrics that should be used when drawing text in the control More...
 
QPalette palette
 the palette that should be used when painting the control More...
 
QRect rect
 the area that should be used for various calculations and painting More...
 
QStyle::State state
 the style flags that are used when drawing the control More...
 
int type
 the option type of the style option More...
 
int version
 the version of the style option More...
 

Protected Functions

 QStyleOptionViewItem (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionViewItem class is used to describe the parameters used to draw an item in a view widget.

QStyleOptionViewItem contains all the information that QStyle functions need to draw the items for Qt's model/view classes.

For performance reasons, 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.

For an example demonstrating how style options can be used, see the widgets/styles{Styles} example.

See also
QStyleOption, {model-view-programming.html}{Model/View Programming}

Definition at line 539 of file qstyleoption.h.

Enumerations

◆ Position

This enum describes the position of the item's decoration.

  • Left On the left of the text.
  • Right On the right of the text.
  • Top Above the text.
  • Bottom Below the text.
See also
decorationPosition
Enumerator
Left 
Right 
Top 
Bottom 

Definition at line 545 of file qstyleoption.h.

◆ StyleOptionType

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

  • Type The type of style option provided (SO_ViewItem 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
Enumerator
Type 

Definition at line 542 of file qstyleoption.h.

◆ StyleOptionVersion

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

  • Version 1

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

See also
StyleOptionType
Enumerator
Version 

Definition at line 543 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionViewItem() [1/3]

QStyleOptionViewItem::QStyleOptionViewItem ( )

Constructs a QStyleOptionViewItem, initializing the members variables to their default values.

Definition at line 5220 of file qstyleoption.cpp.

5224  showDecorationSelected(false)
5225 {
5226 }
Qt::Alignment decorationAlignment
the alignment of the decoration for the item
Definition: qstyleoption.h:548
Position decorationPosition
the position of the decoration for the item
Definition: qstyleoption.h:550
Qt::TextElideMode textElideMode
where ellipsis should be added for text that is too long to fit into an item
Definition: qstyleoption.h:549
bool showDecorationSelected
whether the decoration should be highlighted on selected items
Definition: qstyleoption.h:553
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.
Qt::Alignment displayAlignment
the alignment of the display value for the item
Definition: qstyleoption.h:547

◆ QStyleOptionViewItem() [2/3]

QStyleOptionViewItem::QStyleOptionViewItem ( const QStyleOptionViewItem other)
inline

Constructs a copy of the other style option.

Definition at line 556 of file qstyleoption.h.

556 : QStyleOption(Version, Type) { *this = other; }
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionViewItem() [3/3]

QStyleOptionViewItem::QStyleOptionViewItem ( int  version)
protected
Warning
This function is not part of the public interface.

Definition at line 5231 of file qstyleoption.cpp.

5235  showDecorationSelected(false)
5236 {
5237 }
int version
the version of the style option
Definition: qstyleoption.h:86
Qt::Alignment decorationAlignment
the alignment of the decoration for the item
Definition: qstyleoption.h:548
Position decorationPosition
the position of the decoration for the item
Definition: qstyleoption.h:550
Qt::TextElideMode textElideMode
where ellipsis should be added for text that is too long to fit into an item
Definition: qstyleoption.h:549
bool showDecorationSelected
whether the decoration should be highlighted on selected items
Definition: qstyleoption.h:553
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.
Qt::Alignment displayAlignment
the alignment of the display value for the item
Definition: qstyleoption.h:547

Properties

◆ decorationAlignment

QStyleOptionViewItem::decorationAlignment

◆ decorationPosition

QStyleOptionViewItem::decorationPosition

◆ decorationSize

QStyleOptionViewItem::decorationSize

◆ displayAlignment

QStyleOptionViewItem::displayAlignment

◆ font

QStyleOptionViewItem::font

◆ showDecorationSelected

QStyleOptionViewItem::showDecorationSelected

◆ textElideMode

QStyleOptionViewItem::textElideMode

where ellipsis should be added for text that is too long to fit into an item

The default value is Qt::ElideMiddle, i.e. the ellipsis appears in the middle of the text.

See also
Qt::TextElideMode, QStyle::SH_ItemView_EllipsisLocation

Definition at line 549 of file qstyleoption.h.

Referenced by QItemDelegate::drawDisplay(), QCommonStylePrivate::viewItemDrawText(), and QAbstractItemView::viewOptions().


The documentation for this class was generated from the following files: