Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2243

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

<class name="QStyleOptionHeader" doc="/**
&lt;p&gt;The &lt;a href=&quot;QStyleOptionHeader.html#QStyleOptionHeader(int)&quot;&gt;&lt;tt&gt;QStyleOptionHeader&lt;/tt&gt;&lt;/a&gt; class is used to describe the parameters for drawing a header.&lt;/p&gt;
&lt;p&gt;&lt;a href=&quot;QStyleOptionHeader.html#QStyleOptionHeader(int)&quot;&gt;&lt;tt&gt;QStyleOptionHeader&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 item views' header pane, header sort arrow, and header label.&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 QStyleOptionHeader(com.trolltech.qt.gui.QStyleOptionHeader 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 QStyleOptionHeader()" doc="/**
&lt;p&gt;Constructs a &lt;a href=&quot;QStyleOptionHeader.html#QStyleOptionHeader(int)&quot;&gt;&lt;tt&gt;QStyleOptionHeader&lt;/tt&gt;&lt;/a&gt;, initializing the members variables to their default values.&lt;/p&gt;
 */"/>
    <method name="protected QStyleOptionHeader(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;QStyleOptionHeader.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="SectionPosition" doc="/**
&lt;p&gt;This enum lets you know where the section's position is in relation to the other sections.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#position()&quot;&gt;position&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="Beginning" doc="/**
&lt;p&gt;At the beginining of the header&lt;/p&gt;
 */"/>
        <enum-value name="Middle" doc="/**
&lt;p&gt;In the middle of the header&lt;/p&gt;
 */"/>
        <enum-value name="End" doc="/**
&lt;p&gt;At the end of the header&lt;/p&gt;
 */"/>
        <enum-value name="OnlyOneSection" doc="/**
&lt;p&gt;Only one header section&lt;/p&gt;
 */"/>
</enum>
    <enum name="SelectedPosition" doc="/**
&lt;p&gt;This enum lets you know where the section's position is in relation to the selected section.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#selectedPosition()&quot;&gt;&lt;tt&gt;selectedPosition&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="NotAdjacent" doc="/**
&lt;p&gt;Not adjacent to the selected section&lt;/p&gt;
 */"/>
        <enum-value name="NextIsSelected" doc="/**
&lt;p&gt;The next section is selected&lt;/p&gt;
 */"/>
        <enum-value name="PreviousIsSelected" doc="/**
&lt;p&gt;The previous section is selected&lt;/p&gt;
 */"/>
        <enum-value name="NextAndPreviousAreSelected" doc="/**
&lt;p&gt;Both the next and previous section are selected&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;QStyleOptionHeader.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_Header&lt;/tt&gt;&lt;/a&gt; for this class).&lt;/p&gt;
 */"/>
</enum>
    <enum name="SortIndicator" doc="/**
&lt;p&gt;Indicates which direction the sort indicator should be drawn&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#sortIndicator()&quot;&gt;&lt;tt&gt;sortIndicator&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="None" doc="/**
&lt;p&gt;No sort indicator is needed&lt;/p&gt;
 */"/>
        <enum-value name="SortUp" doc="/**
&lt;p&gt;Draw an up indicator&lt;/p&gt;
 */"/>
        <enum-value name="SortDown" doc="/**
&lt;p&gt;Draw a down indicator&lt;/p&gt;
 */"/>
</enum>
    <method name="public final int section()" doc="/**
&lt;p&gt;Returns which section of the header is being painted.&lt;/p&gt;
&lt;p&gt;The default value is 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setSection(int)&quot;&gt;&lt;tt&gt;setSection&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setSection(int section)" doc="/**
&lt;p&gt;Sets which section of the header is being painted to &lt;tt&gt;section&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is 0.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#section()&quot;&gt;&lt;tt&gt;section&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QStyleOptionHeader.SortIndicator sortIndicator()" doc="/**
&lt;p&gt;Returns the direction the sort indicator should be drawn.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::None.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setSortIndicator(com.trolltech.qt.gui.QStyleOptionHeader.SortIndicator)&quot;&gt;&lt;tt&gt;setSortIndicator&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setSortIndicator(com.trolltech.qt.gui.QStyleOptionHeader.SortIndicator sortIndicator)" doc="/**
&lt;p&gt;Sets the direction the sort indicator should be drawn to &lt;tt&gt;sortIndicator&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::None.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#sortIndicator()&quot;&gt;&lt;tt&gt;sortIndicator&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QStyleOptionHeader.SectionPosition position()" doc="/**
&lt;p&gt;Returns the section's position in relation to the other sections.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::Beginning.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setPosition(com.trolltech.qt.gui.QStyleOptionHeader.SectionPosition)&quot;&gt;&lt;tt&gt;setPosition&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setPosition(com.trolltech.qt.gui.QStyleOptionHeader.SectionPosition position)" doc="/**
&lt;p&gt;Sets the section's position in relation to the other sections to &lt;tt&gt;position&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::Beginning.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#position()&quot;&gt;&lt;tt&gt;position&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QIcon icon()" doc="/**
&lt;p&gt;Returns the icon of the header.&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;QStyleOptionHeader.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 of the header 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;QStyleOptionHeader.html#icon()&quot;&gt;&lt;tt&gt;icon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.Qt.Alignment textAlignment()" doc="/**
&lt;p&gt;Returns the alignment flags for the text of the header.&lt;/p&gt;
&lt;p&gt;The default value is Qt::AlignLeft.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setTextAlignment(com.trolltech.qt.core.Qt.Alignment)&quot;&gt;&lt;tt&gt;setTextAlignment&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setTextAlignment(com.trolltech.qt.core.Qt.Alignment textAlignment)" doc="/**
&lt;p&gt;Sets the alignment flags for the text of the header to &lt;tt&gt;textAlignment&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is Qt::AlignLeft.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#textAlignment()&quot;&gt;&lt;tt&gt;textAlignment&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final java.lang.String text()" doc="/**
&lt;p&gt;Returns the text of the header.&lt;/p&gt;
&lt;p&gt;The default value is an empty string.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.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 of the header to &lt;tt&gt;text&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is an empty string.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#text()&quot;&gt;&lt;tt&gt;text&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QStyleOptionHeader.SelectedPosition selectedPosition()" doc="/**
&lt;p&gt;Returns the section's position in relation to the selected section.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::NotAdjacent&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setSelectedPosition(com.trolltech.qt.gui.QStyleOptionHeader.SelectedPosition)&quot;&gt;&lt;tt&gt;setSelectedPosition&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setSelectedPosition(com.trolltech.qt.gui.QStyleOptionHeader.SelectedPosition selectedPosition)" doc="/**
&lt;p&gt;Sets the section's position in relation to the selected section to &lt;tt&gt;selectedPosition&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is QStyleOptionHeader::NotAdjacent&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#selectedPosition()&quot;&gt;&lt;tt&gt;selectedPosition&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.Qt.Alignment iconAlignment()" doc="/**
&lt;p&gt;Returns the alignment flags for the icon of the header.&lt;/p&gt;
&lt;p&gt;The default value is Qt::AlignLeft.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setIconAlignment(com.trolltech.qt.core.Qt.Alignment)&quot;&gt;&lt;tt&gt;setIconAlignment&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setIconAlignment(com.trolltech.qt.core.Qt.Alignment iconAlignment)" doc="/**
&lt;p&gt;Sets the alignment flags for the icon of the header to &lt;tt&gt;iconAlignment&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default value is Qt::AlignLeft.&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#iconAlignment()&quot;&gt;&lt;tt&gt;iconAlignment&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.Qt.Orientation orientation()" doc="/**
&lt;p&gt;Returns the header's orientation (horizontal or vertical).&lt;/p&gt;
&lt;p&gt;The default orientation is Qt::Horizontal&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#setOrientation(com.trolltech.qt.core.Qt.Orientation)&quot;&gt;&lt;tt&gt;setOrientation&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setOrientation(com.trolltech.qt.core.Qt.Orientation orientation)" doc="/**
&lt;p&gt;Sets the header's orientation (horizontal or vertical) to &lt;tt&gt;orientation&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The default orientation is Qt::Horizontal&lt;/p&gt;

@see &lt;a href=&quot;QStyleOptionHeader.html#orientation()&quot;&gt;&lt;tt&gt;orientation&lt;/tt&gt;&lt;/a&gt; */"/>
</class>