kdefx Library API Documentation

KStyle Class Reference

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

#include <kstyle.h>

Inheritance diagram for KStyle:

QCommonStyle List of all members.

Public Types

typedef uint KStyleFlags
enum  KStyleOption { Default = 0x00000000, AllowMenuTransparency = 0x00000001, FilledFrameWorkaround = 0x00000002 }
enum  KStyleScrollBarType { WindowsStyleScrollBar = 0x00000000, PlatinumStyleScrollBar = 0x00000001, ThreeButtonScrollBar = 0x00000002, NextStyleScrollBar = 0x00000004 }
enum  KStylePrimitive {
  KPE_DockWindowHandle, KPE_ToolBarHandle, KPE_GeneralHandle, KPE_SliderGroove,
  KPE_SliderHandle, KPE_ListViewExpander, KPE_ListViewBranch
}
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
}

Public Member Functions

 KStyle (KStyleFlags flags=KStyle::Default, KStyleScrollBarType sbtype=KStyle::WindowsStyleScrollBar)
 ~KStyle ()
void setScrollBarType (KStyleScrollBarType sbtype)
KStyleFlags styleFlags () const
virtual void renderMenuBlendPixmap (KPixmap &pix, const QColorGroup &cg, const QPopupMenu *popup) const
virtual void drawKStylePrimitive (KStylePrimitive kpe, QPainter *p, const QWidget *widget, const QRect &r, const QColorGroup &cg, SFlags flags=Style_Default, const QStyleOption &=QStyleOption::Default) const
int kPixelMetric (KStylePixelMetric kpm, const QWidget *widget=0) const
void polish (QWidget *widget)
void unPolish (QWidget *widget)
void polishPopupMenu (QPopupMenu *)
void drawPrimitive (PrimitiveElement pe, QPainter *p, const QRect &r, const QColorGroup &cg, SFlags flags=Style_Default, const QStyleOption &=QStyleOption::Default) const
void drawControl (ControlElement element, QPainter *p, const QWidget *widget, const QRect &r, const QColorGroup &cg, SFlags flags=Style_Default, const QStyleOption &=QStyleOption::Default) 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) const
SubControl querySubControl (ComplexControl control, const QWidget *widget, const QPoint &pos, const QStyleOption &=QStyleOption::Default) const
QRect querySubControlMetrics (ComplexControl control, const QWidget *widget, SubControl sc, const QStyleOption &=QStyleOption::Default) const
int pixelMetric (PixelMetric m, const QWidget *widget=0) const
QRect subRect (SubRect r, const QWidget *widget) const
QPixmap stylePixmap (StylePixmap stylepixmap, const QWidget *widget=0, const QStyleOption &=QStyleOption::Default) const
int styleHint (StyleHint sh, const QWidget *w=0, const QStyleOption &opt=QStyleOption::Default, QStyleHintReturn *shr=0) const

Static Public Member Functions

QString defaultStyle ()

Protected Member Functions

bool eventFilter (QObject *object, QEvent *event)
virtual void virtual_hook (int id, void *data)

Related Functions

(Note that these are not member functions.)

void kDrawNextButton (QPainter *p, const QRect &r, const QColorGroup &g, bool sunken=false, const QBrush *fill=0)
void kDrawNextButton (QPainter *p, int x, int y, int w, int h, const QColorGroup &g, bool sunken=false, const QBrush *fill=0)
void kDrawBeButton (QPainter *p, QRect &r, const QColorGroup &g, bool sunken=false, const QBrush *fill=0)
void kDrawBeButton (QPainter *p, int x, int y, int w, int h, const QColorGroup &g, bool sunken=false, const QBrush *fill=0)
void kDrawRoundButton (QPainter *p, const QRect &r, const QColorGroup &g, bool sunken=false)
void kDrawRoundButton (QPainter *p, int x, int y, int w, int h, const QColorGroup &g, bool sunken=false)
void kRoundMaskRegion (QRegion &r, int x, int y, int w, int h)
void kDrawRoundMask (QPainter *p, int x, int y, int w, int h, bool clear=false)
void kColorBitmaps (QPainter *p, const QColorGroup &g, int x, int y, QBitmap *lightColor=0, QBitmap *midColor=0, QBitmap *midlightColor=0, QBitmap *darkColor=0, QBitmap *blackColor=0, QBitmap *whiteColor=0)
void kColorBitmaps (QPainter *p, const QColorGroup &g, int x, int y, int w, int h, bool isXBitmaps=true, const uchar *lightColor=0, const uchar *midColor=0, const uchar *midlightColor=0, const uchar *darkColor=0, const uchar *blackColor=0, const uchar *whiteColor=0)

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

Author:
Karol Szwed (gallium@kde.org)
Version:
Id
kstyle.h,v 1.15 2003/10/07 22:40:42 mueller Exp

Definition at line 55 of file kstyle.h.


Member Typedef Documentation

typedef uint KStyle::KStyleFlags
 

KStyle Flags:.

  • Default - Default style setting, where menu transparency and the FilledFrameWorkaround are disabled.
  • AllowMenuTransparency - Enable this flag to use KStyle's internal menu transparency engine.
  • FilledFrameWorkaround - Enable this flag to facilitate proper repaints of QMenuBars and QToolBars when the style chooses to paint the interior of a QFrame. The style primitives in question are PE_PanelMenuBar and PE_PanelDockWindow. The HighColor style uses this workaround to enable painting of gradients in menubars and toolbars.

Definition at line 77 of file kstyle.h.

Referenced by KStyle(), and styleFlags().


Member Enumeration Documentation

enum KStyle::KStyleOption
 

Enumeration values:
Default  All options disabled.
AllowMenuTransparency  Internal transparency enabled.
FilledFrameWorkaround  Filled frames enabled.

Definition at line 78 of file kstyle.h.

enum KStyle::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.

  • WindowsStyleScrollBar - Two button scrollbar with the previous button at the top/left, and the next button at the bottom/right.
  • PlatinumStyleScrollBar - Two button scrollbar with both the previous and next buttons at the bottom/right.
  • ThreeButtonScrollBar - KDE style three button scrollbar with two previous buttons, and one next button. The next button is always at the bottom/right, whilst the two previous buttons are on either end of the scrollbar.
  • NextStyleScrollBar - Similar to the PlatinumStyle scroll bar, but with the buttons grouped on the opposite end of the scrollbar.
See also:
KStyle::KStyle()
Enumeration values:
WindowsStyleScrollBar  two button, windows style
PlatinumStyleScrollBar  two button, platinum style
ThreeButtonScrollBar  three buttons, KDE style
NextStyleScrollBar  two button, NeXT style

Definition at line 107 of file kstyle.h.

enum KStyle::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.

  • KPE_DockWindowHandle - This primitive is already implemented in KStyle, and paints a bevelled rect with the DockWindow caption text. Re-implement this primitive to perform other more fancy effects when drawing the dock window handle.
  • KPE_ToolBarHandle - This primitive must be reimplemented. It currently only paints a filled rectangle as default behavior. This primitive is used to render QToolBar handles.
  • KPE_GeneralHandle - This primitive must be reimplemented. It is used to render general handles that are not part of a QToolBar or QDockWindow, such as the applet handles used in Kicker. The default implementation paints a filled rect of arbitrary color.
  • KPE_SliderGroove - This primitive must be reimplemented. It is used to paint the slider groove. The default implementation paints a filled rect of arbitrary color.
  • KPE_SliderHandle - This primitive must be reimplemented. It is used to paint the slider handle. The default implementation paints a filled rect of arbitrary color.
  • KPE_ListViewExpander - This primitive is already implemented in KStyle. It is used to draw the Expand/Collapse element in QListViews. To indicate the expanded state, the style flags are set to Style_Off, while Style_On implies collapsed.
  • KPE_ListViewBranch - This primitive is already implemented in KStyle. It is used to draw the ListView branches where necessary.

Definition at line 225 of file kstyle.h.


Constructor & Destructor Documentation

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

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.

Parameters:
flags the style to be applied
sbtype the scroll bar type
See also:
KStyle::KStyleFlags

KStyle::KStyleScrollBarType

Author:
Karol Szwed (gallium@kde.org)

Definition at line 169 of file kstyle.cpp.

References AllowMenuTransparency, FilledFrameWorkaround, and KStyleFlags.

KStyle::~KStyle  ) 
 

Destructs the KStyle object.

Definition at line 219 of file kstyle.cpp.


Member Function Documentation

QString KStyle::defaultStyle  )  [static]
 

Returns the default widget style depending on color depth.

Definition at line 229 of file kstyle.cpp.

void KStyle::setScrollBarType KStyleScrollBarType  sbtype  ) 
 

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.

Parameters:
sbtype the scroll bar type
See also:
KStyle::KStyleScrollBarType

Definition at line 281 of file kstyle.cpp.

KStyle::KStyleFlags KStyle::styleFlags  )  const
 

Returns the KStyle flags used to initialize the style.

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

Definition at line 286 of file kstyle.cpp.

References KStyleFlags.

void KStyle::renderMenuBlendPixmap KPixmap pix,
const QColorGroup cg,
const QPopupMenu popup
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.

Definition at line 291 of file kstyle.cpp.

void KStyle::drawKStylePrimitive KStylePrimitive  kpe,
QPainter p,
const QWidget widget,
const QRect r,
const QColorGroup cg,
SFlags  flags = Style_Default,
const QStyleOption = QStyleOption::Default
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:
KStyle::KStylePrimitive

QStyle::drawPrimitive

QStyle::drawComplexControl

Definition at line 298 of file kstyle.cpp.

References QFont::pointSize().


Friends And Related Function Documentation

void kDrawNextButton QPainter p,
const QRect r,
const QColorGroup g,
bool  sunken = false,
const QBrush fill = 0
[related]
 

#include <kdrawutil.h>

Draws a Next-style button (solid black shadow with light and midlight highlight).

Parameters:
p The painter to use for drawing the button.
r Specifies the rect in which to draw the button.
g Specifies the shading colors.
sunken Whether to draw the button as sunken (pressed) or not.
fill The brush to use for filling the interior of the button. Pass null to prevent the button from being filled.

Definition at line 43 of file kdrawutil.cpp.

void kDrawNextButton QPainter p,
int  x,
int  y,
int  w,
int  h,
const QColorGroup g,
bool  sunken = false,
const QBrush fill = 0
[related]
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 21 of file kdrawutil.cpp.

void kDrawBeButton QPainter p,
QRect r,
const QColorGroup g,
bool  sunken = false,
const QBrush fill = 0
[related]
 

#include <kdrawutil.h>

Draws a Be-style button.

Parameters:
p The painter to use for drawing the button.
r Specifies the rect in which to draw the button.
g Specifies the shading colors.
sunken Whether to draw the button as sunken (pressed) or not.
fill The brush to use for filling the interior of the button. Pass null to prevent the button from being filled.

Definition at line 93 of file kdrawutil.cpp.

void kDrawBeButton QPainter p,
int  x,
int  y,
int  w,
int  h,
const QColorGroup g,
bool  sunken = false,
const QBrush fill = 0
[related]
 

#include <kdrawutil.h>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 49 of file kdrawutil.cpp.

void kDrawRoundButton QPainter p,
const QRect r,
const QColorGroup g,
bool  sunken = false
[related]
 

#include <kdrawutil.h>

Draws a rounded oval button. This function doesn't fill the button. See kRoundMaskRegion() for setting masks for fills.

Parameters:
p The painter to use for drawing the button.
r Specifies the rect in which to draw the button.
g Specifies the shading colors.
sunken Whether to draw the button as sunken (pressed) or not.

Definition at line 99 of file kdrawutil.cpp.

void kDrawRoundButton QPainter p,
int  x,
int  y,
int  w,
int  h,
const QColorGroup g,
bool  sunken = false
[related]
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 139 of file kdrawutil.cpp.

void kRoundMaskRegion QRegion r,
int  x,
int  y,
int  w,
int  h
[related]
 

#include <kdrawutil.h>

Sets a region to the pixels covered by a round button of the given size. You can use this to set clipping regions.

Parameters:
r Reference to the region to set.
x The X coordinate of the button.
y The Y coordinate of the button.
w The width of the button.
h The height of the button.
See also:
kDrawRoundButton() and kDrawRoundMask()

Definition at line 197 of file kdrawutil.cpp.

void kDrawRoundMask QPainter p,
int  x,
int  y,
int  w,
int  h,
bool  clear = false
[related]
 

#include <kdrawutil.h>

Paints the pixels covered by a round button of the given size with Qt::color1. This function is useful in QStyle::drawControlMask().

Parameters:
p The painter to use for drawing the button.
x The X coordinate of the button.
y The Y coordinate of the button.
w The width of the button.
h The height of the button.
clear Whether to clear the rectangle specified by (x, y, w, h) to Qt::color0 before drawing the mask.

Definition at line 148 of file kdrawutil.cpp.

void kColorBitmaps QPainter p,
const QColorGroup g,
int  x,
int  y,
QBitmap lightColor = 0,
QBitmap midColor = 0,
QBitmap midlightColor = 0,
QBitmap darkColor = 0,
QBitmap blackColor = 0,
QBitmap whiteColor = 0
[related]
 

#include <kdrawutil.h>

Paints the provided bitmaps in the painter, using the supplied colorgroup for the foreground colors. There's one bitmap for each color. If you want to skip a color, pass null for the corresponding bitmap.

Note:
The bitmaps will be self-masked automatically if not masked prior to calling this routine.
Parameters:
p The painter to use for drawing the bitmaps.
g Specifies the shading colors.
x The X coordinate at which to draw the bitmaps.
y The Y coordinate at which to draw the bitmaps.
lightColor The bitmap to use for the light part.
midColor The bitmap to use for the mid part.
midlightColor The bitmap to use for the midlight part.
darkColor The bitmap to use for the dark part.
blackColor The bitmap to use for the black part.
whiteColor The bitmap to use for the white part.
See also:
QColorGroup

Definition at line 217 of file kdrawutil.cpp.

void kColorBitmaps QPainter p,
const QColorGroup g,
int  x,
int  y,
int  w,
int  h,
bool  isXBitmaps = true,
const uchar *  lightColor = 0,
const uchar *  midColor = 0,
const uchar *  midlightColor = 0,
const uchar *  darkColor = 0,
const uchar *  blackColor = 0,
const uchar *  whiteColor = 0
[related]
 

#include <kdrawutil.h>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 239 of file kdrawutil.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdefx Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 14 09:15:55 2006 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003