class KStyle

Simplifies and extends the QStyle API to make style coding easier. More...

Definition#include <kstyle.h>
InheritsQCommonStyle (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods


Detailed Description

Simplifies and extends the QStyle API to make style coding easier.

The KStyle class provides a simple internal menu transparency engine which attempts to use XRender for accelerated blending where requested, or falls back to fast internal software tinting/blending routines. It also simplifies more complex portions of the QStyle API, such as the PopupMenuItems, ScrollBars and Sliders by providing extra "primitive elements" which are simple to implement by the style writer.

See also: QStyle::QStyle, QCommonStyle::QCommonStyle

typedef uint KStyleFlags

KStyleFlags

KStyle Flags:

enum KStyleOption { Default = 0x00000000, AllowMenuTransparency = 0x00000001, FilledFrameWorkaround = 0x00000002 }

KStyleOption

enum KStyleScrollBarType { WindowsStyleScrollBar = 0x00000000, PlatinumStyleScrollBar = 0x00000001, ThreeButtonScrollBar = 0x00000002, NextStyleScrollBar = 0x00000004 }

KStyleScrollBarType

KStyle ScrollBarType:

Allows the style writer to easily select what type of scrollbar should be used without having to duplicate large amounts of source code by implementing the complex control CC_ScrollBar.

 KStyle ( KStyleFlags flags = KStyle::Default, KStyleScrollBarType sbtype = KStyle::WindowsStyleScrollBar )

KStyle

Constructs a KStyle object.

Select the appropriate KStyle flags and scrollbar type for your style. The user's style preferences selected in KControl are read by using QSettings and are automatically applied to the style. As a fallback, KStyle paints progressbars and tabbars. It inherits from QCommonStyle for speed, so don't expect much to be implemented.

It is advisable to use a currently implemented style such as the HighColor style as a foundation for any new KStyle, so the limited number of drawing fallbacks should not prove problematic.

See also: KStyleFlags, KStyleScrollBarType

 ~KStyle ()

~KStyle

Destructs the KStyle object.

void  setScrollBarType (KStyleScrollBarType sbtype)

setScrollBarType

Modifies the scrollbar type used by the style.

This function is only provided for convenience. It allows you to make a late decision about what scrollbar type to use for the style after performing some processing in your style's constructor. In most situations however, setting the scrollbar type via the KStyle constructor should suffice.

KStyleFlags  styleFlags ()

styleFlags

[const]

Returns the KStyle flags used to initialise the style.

This is used solely for the kcmstyle module, and hence is internal.

void  renderMenuBlendPixmap ( KPixmap& pix, const QColorGroup& cg, const QPopupMenu* popup )

renderMenuBlendPixmap

[const virtual]

This virtual function defines the pixmap used to blend between the popup menu and the background to create different menu transparency effects. For example, you can fill the pixmap "pix" with a gradient based on the popup's colorGroup, a texture, or some other fancy painting routine. KStyle will then internally blend this pixmap with a snapshot of the background behind the popupMenu to create the illusion of transparency.

This virtual is never called if XRender/Software blending is disabled by the user in KDE's style control module.

enum KStylePrimitive { KPE_DockWindowHandle, KPE_ToolBarHandle, KPE_GeneralHandle, KPE_SliderGroove, KPE_SliderHandle, KPE_ListViewExpander, KPE_ListViewBranch }

KStylePrimitive

KStyle Primitive Elements:

The KStyle class extends the Qt's Style API by providing certain simplifications for parts of QStyle. To do this, the KStylePrimitive elements were defined, which are very similar to Qt's PrimitiveElement.

The first three Handle primitives simplify and extend PE_DockWindowHandle, so do not reimplement PE_DockWindowHandle if you want the KStyle handle simplifications to be operable. Similarly do not reimplement CC_Slider, SC_SliderGroove and SC_SliderHandle when using the KStyle slider primitives. KStyle automatically double-buffers slider painting when they are drawn via these KStyle primitives to avoid flicker.

void  drawKStylePrimitive ( KStylePrimitive kpe, QPainter* p, const QWidget* widget, const QRect &r, const QColorGroup &cg, SFlags flags = Style_Default, const QStyleOption& = QStyleOption::Default )

drawKStylePrimitive

[const virtual]

This function is identical to Qt's QStyle::drawPrimitive(), except that it adds one further parameter, 'widget', that can be used to determine the widget state of the KStylePrimitive in question.

See also: KStylePrimitive, QStyle::drawPrimitive, QStyle::drawComplexControl

enum KStylePixelMetric { KPM_MenuItemSeparatorHeight = 0x00000001, KPM_MenuItemHMargin = 0x00000002, KPM_MenuItemVMargin = 0x00000004, KPM_MenuItemHFrame = 0x00000008, KPM_MenuItemVFrame = 0x00000010, KPM_MenuItemCheckMarkHMargin = 0x00000020, KPM_MenuItemArrowHMargin = 0x00000040, KPM_MenuItemTabSpacing = 0x00000080, KPM_ListViewBranchThickness = 0x00000100 }

KStylePixelMetric

int  kPixelMetric ( KStylePixelMetric kpm, const QWidget* widget = 0 )

kPixelMetric

[const]

void  polish ( QWidget* widget )

polish

void  unPolish ( QWidget* widget )

unPolish

void  polishPopupMenu ( QPopupMenu* )

polishPopupMenu

void  drawPrimitive ( PrimitiveElement pe, QPainter* p, const QRect &r, const QColorGroup &cg, SFlags flags = Style_Default, const QStyleOption& = QStyleOption::Default )

drawPrimitive

[const]

void  drawControl ( ControlElement element, QPainter* p, const QWidget* widget, const QRect &r, const QColorGroup &cg, SFlags flags = Style_Default, const QStyleOption& = QStyleOption::Default )

drawControl

[const]

void  drawComplexControl ( ComplexControl control, QPainter *p, const QWidget* widget, const QRect &r, const QColorGroup &cg, SFlags flags = Style_Default, SCFlags controls = SC_All, SCFlags active = SC_None, const QStyleOption& = QStyleOption::Default )

drawComplexControl

[const]

SubControl  querySubControl ( ComplexControl control, const QWidget* widget, const QPoint &pos, const QStyleOption& = QStyleOption::Default )

querySubControl

[const]

QRect  querySubControlMetrics ( ComplexControl control, const QWidget* widget, SubControl sc, const QStyleOption& = QStyleOption::Default )

querySubControlMetrics

[const]

int  pixelMetric ( PixelMetric m, const QWidget* widget = 0 )

pixelMetric

[const]

QRect  subRect ( SubRect r, const QWidget* widget )

subRect

[const]

QPixmap  stylePixmap ( StylePixmap stylepixmap, const QWidget* widget = 0, const QStyleOption& = QStyleOption::Default )

stylePixmap

[const]

int  styleHint ( StyleHint sh, const QWidget* w = 0, const QStyleOption &opt = QStyleOption::Default, QStyleHintReturn* shr = 0 )

styleHint

[const]

bool  eventFilter ( QObject* object, QEvent* event )

eventFilter

[protected]

void  virtual_hook ( int id, void* data )

virtual_hook

[protected virtual]