Sophie

Sophie

distrib > * > 2009.0 > i586 > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2244

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QStyleOptionMenuItem" doc="/**
&lt;p&gt;The &lt;a href=&quot;QStyleOptionMenuItem.html#QStyleOptionMenuItem(int)&quot;&gt;&lt;tt&gt;QStyleOptionMenuItem&lt;/tt&gt;&lt;/a&gt; class is used to describe the parameter necessary for drawing a menu item.&lt;/p&gt;
&lt;p&gt;&lt;a href=&quot;QStyleOptionMenuItem.html#QStyleOptionMenuItem(int)&quot;&gt;&lt;tt&gt;QStyleOptionMenuItem&lt;/tt&gt;&lt;/a&gt; contains all the information that &lt;a href=&quot;QStyle.html&quot;&gt;&lt;tt&gt;QStyle&lt;/tt&gt;&lt;/a&gt; functions need to draw the menu items from &lt;a href=&quot;QMenu.html&quot;&gt;&lt;tt&gt;QMenu&lt;/tt&gt;&lt;/a&gt;. It is also used for drawing other menu-related widgets.&lt;/p&gt;
&lt;p&gt;For performance reasons, the access to the member variables is direct (i.e&amp;#x2e;, using the &lt;tt&gt;.&lt;/tt&gt; or &lt;tt&gt;-&amp;gt;&lt;/tt&gt; operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.&lt;/p&gt;
&lt;p&gt;For an example demonstrating how style options can be used, see the Styles&lt;/tt&gt; example.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QStyleOptionMenuItem(com.trolltech.qt.gui.QStyleOptionMenuItem other)" doc="/**
&lt;p&gt;Constructs a copy of the &lt;tt&gt;other&lt;/tt&gt; style option.&lt;/p&gt;
 */"/>
    <method name="public QStyleOptionMenuItem()" doc="/**
&lt;p&gt;Constructs a &lt;a href=&quot;QStyleOptionMenuItem.html#QStyleOptionMenuItem(int)&quot;&gt;&lt;tt&gt;QStyleOptionMenuItem&lt;/tt&gt;&lt;/a&gt;, initializing the members variables to their default values.&lt;/p&gt;
 */"/>
    <method name="protected QStyleOptionMenuItem(int version)" doc="/**
&lt;p&gt;This method is used internally by Qt Jambi.
Do not use it in your applications.&lt;/p&gt;
 */"/>
    <enum name="StyleOptionVersion" doc="/**
&lt;p&gt;This enum is used to hold information about the version of the style option, and is defined for each &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt; subclass.&lt;/p&gt;
&lt;p&gt;The version is used by &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt; subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast(), you normally don't need to check it.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#StyleOptionType-enum&quot;&gt;&lt;tt&gt;StyleOptionType&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="Version" doc="/**
&lt;p&gt;1&lt;/p&gt;
 */"/>
</enum>
    <enum name="StyleOptionType" doc="/**
&lt;p&gt;This enum is used to hold information about the type of the style option, and is defined for each &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt; subclass.&lt;/p&gt;
&lt;p&gt;The type is used internally by &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt;, 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 &lt;a href=&quot;QStyleOption.html#QStyleOption(int, int)&quot;&gt;&lt;tt&gt;QStyleOption&lt;/tt&gt;&lt;/a&gt; subclass and your own styles.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#StyleOptionVersion-enum&quot;&gt;&lt;tt&gt;StyleOptionVersion&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="Type" doc="/**
&lt;p&gt;The type of style option provided (&lt;a href=&quot;QStyleOption.html#OptionType-enum&quot;&gt;&lt;tt&gt;SO_MenuItem&lt;/tt&gt;&lt;/a&gt; for this class).&lt;/p&gt;
 */"/>
</enum>
    <enum name="CheckType" doc="/**
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#checkType()&quot;&gt;&lt;tt&gt;checkType&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QAction::checkable&lt;/tt&gt;
@see &lt;tt&gt;QAction::checked&lt;/tt&gt;
@see &lt;tt&gt;QActionGroup::exclusive&lt;/tt&gt; */">
        <enum-value name="NotCheckable" doc="/**
&lt;p&gt;The item is not checkable.&lt;/p&gt;
 */"/>
        <enum-value name="Exclusive" doc="/**
&lt;p&gt;The item is an exclusive check item (like a radio button).&lt;/p&gt;
 */"/>
        <enum-value name="NonExclusive" doc="/**
&lt;p&gt;The item is a non-exclusive check item (like a check box).&lt;/p&gt;
 */"/>
</enum>
    <enum name="MenuItemType" doc="/**
&lt;p&gt;This enum indicates the type of menu item that the structure describes.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#menuItemType()&quot;&gt;&lt;tt&gt;menuItemType&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="Normal" doc="/**
&lt;p&gt;A normal menu item.&lt;/p&gt;
 */"/>
        <enum-value name="DefaultItem" doc="/**
&lt;p&gt;A menu item that is the default action as specified with &lt;tt&gt;QMenu::defaultAction&lt;/tt&gt;.&lt;/p&gt;
 */"/>
        <enum-value name="Separator" doc="/**
&lt;p&gt;A menu separator.&lt;/p&gt;
 */"/>
        <enum-value name="SubMenu" doc="/**
&lt;p&gt;Indicates the menu item points to a sub-menu.&lt;/p&gt;
 */"/>
        <enum-value name="Scroller" doc="/**
&lt;p&gt;A popup menu scroller (currently only used on Mac OS X).&lt;/p&gt;
 */"/>
        <enum-value name="TearOff" doc="/**
&lt;p&gt;A tear-off handle for the menu.&lt;/p&gt;
 */"/>
        <enum-value name="Margin" doc="/**
&lt;p&gt;The margin of the menu.&lt;/p&gt;
 */"/>
        <enum-value name="EmptyArea" doc="/**
&lt;p&gt;The empty area of the menu.&lt;/p&gt;
 */"/>
</enum>
    <method name="public final boolean menuHasCheckableItems()" doc="/**
&lt;p&gt;Returns whether the menu as a whole has checkable items or not.&lt;/p&gt;
&lt;p&gt;The default value is true.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setMenuHasCheckableItems(boolean)&quot;&gt;&lt;tt&gt;setMenuHasCheckableItems&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setMenuHasCheckableItems(boolean menuHasCheckableItems)" doc="/**
&lt;p&gt;Sets whether the menu as a whole has checkable items or not to &lt;tt&gt;menuHasCheckableItems&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is true.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#menuHasCheckableItems()&quot;&gt;&lt;tt&gt;menuHasCheckableItems&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QRect menuRect()" doc="/**
&lt;p&gt;Returns the rectangle for the entire menu.&lt;/p&gt;
&lt;p&gt;The default value is a null rectangle, i.e&amp;#x2e; a rectangle with both the width and the height set to 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setMenuRect(com.trolltech.qt.core.QRect)&quot;&gt;&lt;tt&gt;setMenuRect&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setMenuRect(com.trolltech.qt.core.QRect menuRect)" doc="/**
&lt;p&gt;Sets the rectangle for the entire menu to &lt;tt&gt;menuRect&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is a null rectangle, i.e&amp;#x2e; a rectangle with both the width and the height set to 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#menuRect()&quot;&gt;&lt;tt&gt;menuRect&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QStyleOptionMenuItem.CheckType checkType()" doc="/**
&lt;p&gt;Returns the type of checkmark of the menu item.&lt;/p&gt;
&lt;p&gt;The default value is &lt;a href=&quot;QStyleOptionMenuItem.html#CheckType-enum&quot;&gt;&lt;tt&gt;NotCheckable&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setCheckType(com.trolltech.qt.gui.QStyleOptionMenuItem.CheckType)&quot;&gt;&lt;tt&gt;setCheckType&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QStyleOptionMenuItem.html#CheckType-enum&quot;&gt;&lt;tt&gt;CheckType&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setCheckType(com.trolltech.qt.gui.QStyleOptionMenuItem.CheckType checkType)" doc="/**
&lt;p&gt;Sets the type of checkmark of the menu item to &lt;tt&gt;checkType&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is &lt;a href=&quot;QStyleOptionMenuItem.html#CheckType-enum&quot;&gt;&lt;tt&gt;NotCheckable&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#checkType()&quot;&gt;&lt;tt&gt;checkType&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QStyleOptionMenuItem.html#CheckType-enum&quot;&gt;&lt;tt&gt;CheckType&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QIcon icon()" doc="/**
&lt;p&gt;Returns the icon for the menu item.&lt;/p&gt;
&lt;p&gt;The default value is an empty icon, i.e&amp;#x2e; an icon with neither a pixmap nor a filename.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setIcon(com.trolltech.qt.gui.QIcon)&quot;&gt;&lt;tt&gt;setIcon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setIcon(com.trolltech.qt.gui.QIcon icon)" doc="/**
&lt;p&gt;Sets the icon for the menu item to &lt;tt&gt;icon&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is an empty icon, i.e&amp;#x2e; an icon with neither a pixmap nor a filename.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#icon()&quot;&gt;&lt;tt&gt;icon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean checked()" doc="/**
&lt;p&gt;Returns whether the menu item is checked or not.&lt;/p&gt;
&lt;p&gt;The default value is false.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setChecked(boolean)&quot;&gt;&lt;tt&gt;setChecked&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setChecked(boolean checked)" doc="/**
&lt;p&gt;Sets whether the menu item is checked or not to &lt;tt&gt;checked&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is false.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#checked()&quot;&gt;&lt;tt&gt;checked&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int maxIconWidth()" doc="/**
&lt;p&gt;Returns the maximum icon width for the icon in the menu item.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setMaxIconWidth(int)&quot;&gt;&lt;tt&gt;setMaxIconWidth&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setMaxIconWidth(int maxIconWidth)" doc="/**
&lt;p&gt;Sets the maximum icon width for the icon in the menu item to &lt;tt&gt;maxIconWidth&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#maxIconWidth()&quot;&gt;&lt;tt&gt;maxIconWidth&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int tabWidth()" doc="/**
&lt;p&gt;Returns the tab width for the menu item.&lt;/p&gt;
&lt;p&gt;The tab width is the distance between the text of the menu item and the shortcut. The default value is 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setTabWidth(int)&quot;&gt;&lt;tt&gt;setTabWidth&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setTabWidth(int tabWidth)" doc="/**
&lt;p&gt;Sets the tab width for the menu item to &lt;tt&gt;tabWidth&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The tab width is the distance between the text of the menu item and the shortcut. The default value is 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#tabWidth()&quot;&gt;&lt;tt&gt;tabWidth&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final java.lang.String text()" doc="/**
&lt;p&gt;Returns the text for the menu item.&lt;/p&gt;
&lt;p&gt;Note that the text format is something like this &amp;quot;Menu text&lt;b&gt;\t&lt;/b&gt;Shortcut&amp;quot;.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setText(java.lang.String)&quot;&gt;&lt;tt&gt;setText&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setText(java.lang.String text)" doc="/**
&lt;p&gt;Sets the text for the menu item to &lt;tt&gt;text&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;Note that the text format is something like this &amp;quot;Menu text&lt;b&gt;\t&lt;/b&gt;Shortcut&amp;quot;.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#text()&quot;&gt;&lt;tt&gt;text&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QFont font()" doc="/**
&lt;p&gt;Returns the font used for the menu item text.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setFont(com.trolltech.qt.gui.QFont)&quot;&gt;&lt;tt&gt;setFont&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setFont(com.trolltech.qt.gui.QFont font)" doc="/**
&lt;p&gt;Sets the font used for the menu item text to &lt;tt&gt;font&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;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.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#font()&quot;&gt;&lt;tt&gt;font&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QStyleOptionMenuItem.MenuItemType menuItemType()" doc="/**
&lt;p&gt;Returns the type of menu item.&lt;/p&gt;
&lt;p&gt;The default value is &lt;a href=&quot;QStyleOptionMenuItem.html#MenuItemType-enum&quot;&gt;Normal&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#setMenuItemType(com.trolltech.qt.gui.QStyleOptionMenuItem.MenuItemType)&quot;&gt;&lt;tt&gt;setMenuItemType&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QStyleOptionMenuItem.html#MenuItemType-enum&quot;&gt;&lt;tt&gt;MenuItemType&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setMenuItemType(com.trolltech.qt.gui.QStyleOptionMenuItem.MenuItemType menuItemType)" doc="/**
&lt;p&gt;Sets the type of menu item to &lt;tt&gt;menuItemType&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is &lt;a href=&quot;QStyleOptionMenuItem.html#MenuItemType-enum&quot;&gt;Normal&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionMenuItem.html#menuItemType()&quot;&gt;&lt;tt&gt;menuItemType&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QStyleOptionMenuItem.html#MenuItemType-enum&quot;&gt;&lt;tt&gt;MenuItemType&lt;/tt&gt;&lt;/a&gt; */"/>
</class>