Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QStyleOptionMenuItem Class Reference

\variable QStyleOptionMenuItemV2::mouseDown More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionMenuItem:
Collaboration diagram for QStyleOptionMenuItem:

Public Types

enum  StyleOptionType { Type = SO_MenuItem }
 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...
enum  MenuItemType {
  Normal , DefaultItem , Separator , SubMenu ,
  Scroller , TearOff , Margin , EmptyArea
}
 This enum indicates the type of menu item that the structure describes. More...
enum  CheckType { NotCheckable , Exclusive , NonExclusive }
 This enum is used to indicate whether or not a check mark should be drawn for the item, or even if it should be drawn at all. 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_DockWidget , SO_ViewItem , SO_TabWidgetFrame ,
  SO_TabBarBase , SO_RubberBand , SO_ToolBar , SO_GraphicsItem ,
  SO_Complex = 0xf0000 , SO_Slider , SO_SpinBox , SO_ToolButton ,
  SO_ComboBox , 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 Member Functions

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

Public Attributes

MenuItemType menuItemType
CheckType checkType
bool checked
bool menuHasCheckableItems
QRect menuRect
QString text
QIcon icon
int maxIconWidth
int reservedShortcutWidth
QFont font
Public Attributes inherited from QStyleOption
int version
int type
QStyle::State state
Qt::LayoutDirection direction
QRect rect
QFontMetrics fontMetrics
QPalette palette
QObjectstyleObject

Protected Member Functions

 QStyleOptionMenuItem (int version)

Additional Inherited Members

Detailed Description

\variable QStyleOptionMenuItemV2::mouseDown

true when the mouse is pressed down.

This is needed because there is no differentation between a pressed and a sunken state when QStyle::State_Sunken is set. QStyle::State_Sunken is also set when the menu is open (i.e. showing the popup menu)

The QStyleOptionMenuItem class is used to describe the parameter necessary for drawing a menu item.

\inmodule QtWidgets

QStyleOptionMenuItem contains all the information that QStyle functions need to draw the menu items from \l QMenu. It is also used for drawing other menu-related widgets.

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

See also
QStyleOption

Definition at line 334 of file qstyleoption.h.

Member Enumeration Documentation

◆ CheckType

This enum is used to indicate whether or not a check mark should be drawn for the item, or even if it should be drawn at all.

\value NotCheckable The item is not checkable. \value Exclusive The item is an exclusive check item (like a radio button). \value NonExclusive The item is a non-exclusive check item (like a check box).

See also
checkType, QAction::checkable, QAction::checked, QActionGroup::exclusionPolicy
Enumerator
NotCheckable 
Exclusive 
NonExclusive 

Definition at line 342 of file qstyleoption.h.

◆ MenuItemType

This enum indicates the type of menu item that the structure describes.

\value Normal A normal menu item. \value DefaultItem A menu item that is the default action as specified with \l QMenu::defaultAction(). \value Separator A menu separator. \value SubMenu Indicates the menu item points to a sub-menu. \value Scroller A popup menu scroller (currently only used on \macos). \value TearOff A tear-off handle for the menu. \value Margin The margin of the menu. \value EmptyArea The empty area of the menu.

See also
menuItemType
Enumerator
Normal 
DefaultItem 
Separator 
SubMenu 
Scroller 
TearOff 
Margin 
EmptyArea 

Definition at line 340 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.

\value Type The type of style option provided (\l{SO_MenuItem} 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 337 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.

\value 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 338 of file qstyleoption.h.

Constructor & Destructor Documentation

◆ QStyleOptionMenuItem() [1/3]

QStyleOptionMenuItem::QStyleOptionMenuItem ( )

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

Definition at line 1664 of file qstyleoption.cpp.

◆ QStyleOptionMenuItem() [2/3]

QStyleOptionMenuItem::QStyleOptionMenuItem ( const QStyleOptionMenuItem & other)
inline

Constructs a copy of the other style option.

Definition at line 356 of file qstyleoption.h.

◆ QStyleOptionMenuItem() [3/3]

QStyleOptionMenuItem::QStyleOptionMenuItem ( int version)
protected

Definition at line 1672 of file qstyleoption.cpp.

Member Function Documentation

◆ operator=()

QStyleOptionMenuItem & QStyleOptionMenuItem::operator= ( const QStyleOptionMenuItem & )
default

Member Data Documentation

◆ checked

bool QStyleOptionMenuItem::checked

Definition at line 346 of file qstyleoption.h.

◆ checkType

CheckType QStyleOptionMenuItem::checkType

Definition at line 345 of file qstyleoption.h.

◆ font

QFont QStyleOptionMenuItem::font

Definition at line 353 of file qstyleoption.h.

◆ icon

QIcon QStyleOptionMenuItem::icon

Definition at line 350 of file qstyleoption.h.

◆ maxIconWidth

int QStyleOptionMenuItem::maxIconWidth

Definition at line 351 of file qstyleoption.h.

◆ menuHasCheckableItems

bool QStyleOptionMenuItem::menuHasCheckableItems

Definition at line 347 of file qstyleoption.h.

◆ menuItemType

MenuItemType QStyleOptionMenuItem::menuItemType

Definition at line 344 of file qstyleoption.h.

◆ menuRect

QRect QStyleOptionMenuItem::menuRect

Definition at line 348 of file qstyleoption.h.

◆ reservedShortcutWidth

int QStyleOptionMenuItem::reservedShortcutWidth

Definition at line 352 of file qstyleoption.h.

◆ text

QString QStyleOptionMenuItem::text

Definition at line 349 of file qstyleoption.h.


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