Home · All Classes · Modules

QStyleOptionMenuItem Class Reference
^{[QtGui module]}

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

Inherits QStyleOption.

Types

• enum CheckType { NotCheckable, Exclusive, NonExclusive }
• enum MenuItemType { Normal, DefaultItem, Separator, SubMenu, ..., EmptyArea }
• enum StyleOptionType { Type }
• enum StyleOptionVersion { Version }

Methods

• __init__ (self)
• __init__ (self, QStyleOptionMenuItem other)

Members

• bool checked
• CheckType checkType
• QFont font
• QIcon icon
• int maxIconWidth
• bool menuHasCheckableItems
• MenuItemType menuItemType
• QRect menuRect
• int tabWidth
• QString text

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

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 Styles example.

Type Documentation

QStyleOptionMenuItem.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.

See also checkType, QAction.checkable, QAction.checked, and QActionGroup.exclusive.

QStyleOptionMenuItem.MenuItemType

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

See also menuItemType.

QStyleOptionMenuItem.StyleOptionType

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

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.

QStyleOptionMenuItem.StyleOptionVersion

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

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.

Method Documentation

QStyleOptionMenuItem.__init__ (self)

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

QStyleOptionMenuItem.__init__ (self, QStyleOptionMenuItem other)

Constructs a copy of the other style option.

Member Documentation

bool checked

This variable holds whether the menu item is checked or not.

CheckType checkType

This variable holds the type of checkmark of the menu item.

The default value is NotCheckable.

See also CheckType.

QFont font

This variable holds the font used for the menu item text.

This is the font that should be used for drawing the menu text minus the shortcut. The shortcut is usually drawn using the painter's font. By default, the application's default font is used.

QIcon icon

This variable holds the icon for the menu item.

The default value is an empty icon, i.e. an icon with neither a pixmap nor a filename.

int maxIconWidth

This variable holds the maximum icon width for the icon in the menu item.

bool menuHasCheckableItems

This variable holds whether the menu as a whole has checkable items or not.

MenuItemType menuItemType

This variable holds the type of menu item.

The default value is Normal.

See also MenuItemType.

QRect menuRect

This variable holds the rectangle for the entire menu.

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

int tabWidth

This variable holds the tab width for the menu item.

QString text

This variable holds the text for the menu item.