Qyoto  4.0.5
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Properties
QtGui.QStyleOptionMenuItem Class Reference

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

Inheritance diagram for QtGui.QStyleOptionMenuItem:
Collaboration diagram for QtGui.QStyleOptionMenuItem:

Public Types

enum  CheckType { Exclusive = 1, NonExclusive = 2, NotCheckable = 0 }
  More...
 
enum  MenuItemType {
  DefaultItem = 1, EmptyArea = 7, Margin = 6, Normal = 0,
  Scroller = 4, Separator = 2, SubMenu = 3, TearOff = 5
}
  More...
 
enum  StyleOptionType { Type = 4 }
  More...
 
enum  StyleOptionVersion { Version = 1 }
  More...
 
- Public Types inherited from QtGui.QStyleOption
enum  OptionType {
  SO_Button = 2, SO_ComboBox = 983044, SO_Complex = 983040, SO_ComplexCustomBase = 251658240,
  SO_CustomBase = 3840, SO_Default = 0, SO_DockWidget = 10, SO_FocusRect = 1,
  SO_Frame = 5, SO_GraphicsItem = 17, SO_GroupBox = 983047, SO_Header = 8,
  SO_MenuItem = 4, SO_ProgressBar = 6, SO_Q3DockWindow = 9, SO_Q3ListView = 983045,
  SO_Q3ListViewItem = 11, SO_RubberBand = 15, SO_SizeGrip = 983048, SO_Slider = 983041,
  SO_SpinBox = 983042, SO_Tab = 3, SO_TabBarBase = 14, SO_TabWidgetFrame = 13,
  SO_TitleBar = 983046, SO_ToolBar = 16, SO_ToolBox = 7, SO_ToolButton = 983043,
  SO_ViewItem = 12
}
  More...
 
enum  StyleOptionType { Type = 0 }
  More...
 
enum  StyleOptionVersion { Version = 1 }
  More...
 

Public Member Functions

 QStyleOptionMenuItem ()
 
 
 QStyleOptionMenuItem (QStyleOptionMenuItem other)
 
 
override void CreateProxy ()
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QStyleOption
 QStyleOption (QStyleOption other)
 
 
 QStyleOption (int version=(int) QStyleOption.StyleOptionVersion.Version, int type=(int) QStyleOption.OptionType.SO_Default)
 
 
new void Init (QWidget w)
 
 
new void InitFrom (QWidget w)
 
 
new void Dispose ()
 

Protected Member Functions

 QStyleOptionMenuItem (System.Type dummy)
 
 QStyleOptionMenuItem (int version)
 
 
- Protected Member Functions inherited from QtGui.QStyleOption
 QStyleOption (System.Type dummy)
 

Properties

new QStyleOptionMenuItem.CheckType checkType [get, set]
 
 
new bool Checked [get, set]
 
 
new QFont Font [get, set]
 
 
new QIcon Icon [get, set]
 
 
new int MaxIconWidth [get, set]
 
 
new bool MenuHasCheckableItems [get, set]
 
 
new
QStyleOptionMenuItem.MenuItemType 
menuItemType [get, set]
 
 
new QRect MenuRect [get, set]
 
 
new int TabWidth [get, set]
 
 
new string Text [get, set]
 
 
- Properties inherited from QtGui.QStyleOption
virtual System.IntPtr SmokeObject [get, set]
 
new Qt.LayoutDirection Direction [get, set]
 
 
new QFontMetrics FontMetrics [get, set]
 
 
new QPalette Palette [get, set]
 
 
new QRect Rect [get, set]
 
 
new QStyle.StateFlag State [get, set]
 
 
new int Type [get, set]
 
 
new int Version [get, set]
 
 

Additional Inherited Members

- Protected Attributes inherited from QtGui.QStyleOption
SmokeInvocation interceptor
 

Detailed Description

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

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.

See also QStyleOption.

Member Enumeration Documentation

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.

Enumerator:
Exclusive 

The item is an exclusive check item (like a radio button).

NonExclusive 

The item is a non-exclusive check item (like a check box).

NotCheckable 

The item is not checkable.

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

See also menuItemType.

Enumerator:
DefaultItem 

A menu item that is the default action as specified with QMenu::defaultAction().

EmptyArea 

The empty area of the menu.

Margin 

The margin of the menu.

Normal 

A normal menu item.

Scroller 

A popup menu scroller (currently only used on Mac OS X).

Separator 

A menu separator.

SubMenu 

Indicates the menu item points to a sub-menu.

TearOff 

A tear-off handle for the menu.

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.

Enumerator:
Type 

The type of style option provided (SO_MenuItem for this class).

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.

Enumerator:
Version 

1

Constructor & Destructor Documentation

QtGui.QStyleOptionMenuItem.QStyleOptionMenuItem ( System.Type  dummy)
protected
QtGui.QStyleOptionMenuItem.QStyleOptionMenuItem ( )

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

QtGui.QStyleOptionMenuItem.QStyleOptionMenuItem ( QStyleOptionMenuItem  other)

Constructs a copy of the other style option.

QtGui.QStyleOptionMenuItem.QStyleOptionMenuItem ( int  version)
protected

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

Member Function Documentation

override void QtGui.QStyleOptionMenuItem.CreateProxy ( )
virtual

Reimplemented from QtGui.QStyleOption.

new void QtGui.QStyleOptionMenuItem.Dispose ( )

Property Documentation

new bool QtGui.QStyleOptionMenuItem.Checked
getset

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

The default value is false.

new QStyleOptionMenuItem.CheckType QtGui.QStyleOptionMenuItem.checkType
getset

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

The default value is NotCheckable.

See also CheckType.

new QFont QtGui.QStyleOptionMenuItem.Font
getset

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.

new QIcon QtGui.QStyleOptionMenuItem.Icon
getset

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.

new int QtGui.QStyleOptionMenuItem.MaxIconWidth
getset

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

This can be used for drawing the icon into the correct place or properly aligning items. The variable must be set regardless of whether or not the menu item has an icon. The default value is 0.

new bool QtGui.QStyleOptionMenuItem.MenuHasCheckableItems
getset

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

The default value is true.

If this option is set to false, then the menu has no checkable items. This makes it possible for GUI styles to save some horizontal space that would normally be used for the check column.

new QStyleOptionMenuItem.MenuItemType QtGui.QStyleOptionMenuItem.menuItemType
getset

This variable holds the type of menu item.

The default value is Normal.

See also MenuItemType.

new QRect QtGui.QStyleOptionMenuItem.MenuRect
getset

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.

new int QtGui.QStyleOptionMenuItem.TabWidth
getset

This variable holds the tab width for the menu item.

The tab width is the distance between the text of the menu item and the shortcut. The default value is 0.

new string QtGui.QStyleOptionMenuItem.Text
getset

This variable holds the text for the menu item.

Note that the text format is something like this "Menu text\tShortcut".

If the menu item doesn't have a shortcut, it will just contain the menu item's text. The default value is an empty string.