.TH "KSelector" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KSelector \- KSelector is the base class for other widgets which provides the ability to choose from a one-dimensional range of values.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kselect.h>\fP
.PP
Inherits \fBQWidget\fP, and \fBQRangeControl\fP.
.PP
Inherited by \fBKGradientSelector\fP, and \fBKValueSelector\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBvalueChanged\fP (int value)"
.br
.RI "\fIThis signal is emitted whenever the user chooses a value, e.g. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKSelector\fP (\fBQWidget\fP *parent=0, const  char *name=0)"
.br
.RI "\fIConstructs a horizontal one-dimensional selection widget. \fP"
.ti -1c
.RI "\fBKSelector\fP (Orientation o, \fBQWidget\fP *parent=0L, const  char *name=0L)"
.br
.RI "\fIConstructs a one-dimensional selection widget with a given orientation. \fP"
.ti -1c
.RI "Orientation \fBorientation\fP () const "
.br
.ti -1c
.RI "\fBQRect\fP \fBcontentsRect\fP () const "
.br
.ti -1c
.RI "void \fBsetIndent\fP (bool i)"
.br
.RI "\fISets the indent option of the widget to i. \fP"
.ti -1c
.RI "bool \fBindent\fP () const "
.br
.ti -1c
.RI "void \fBsetValue\fP (int value)"
.br
.RI "\fISets the value. \fP"
.ti -1c
.RI "int \fBvalue\fP () const "
.br
.ti -1c
.RI "void \fBsetMinValue\fP (int value)"
.br
.RI "\fISets the min value. \fP"
.ti -1c
.RI "int \fBminValue\fP () const "
.br
.ti -1c
.RI "void \fBsetMaxValue\fP (int value)"
.br
.RI "\fISets the max value. \fP"
.ti -1c
.RI "int \fBmaxValue\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBdrawContents\fP (\fBQPainter\fP *)"
.br
.RI "\fIOverride this function to draw the contents of the control. \fP"
.ti -1c
.RI "virtual void \fBdrawArrow\fP (\fBQPainter\fP *painter, bool \fBshow\fP, const  \fBQPoint\fP &\fBpos\fP)"
.br
.RI "\fIOverride this function to draw the cursor which indicates the current value. \fP"
.ti -1c
.RI "virtual void \fBvalueChange\fP ()"
.br
.ti -1c
.RI "virtual void \fBpaintEvent\fP (\fBQPaintEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBmousePressEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBmouseMoveEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
KSelector is the base class for other widgets which provides the ability to choose from a one-dimensional range of values. 

An example is the \fBKGradientSelector\fP which allows to choose from a range of colors.
.PP
A custom drawing routine for the widget surface has to be provided by the subclass. 
.PP
Definition at line 142 of file kselect.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSelector::KSelector (\fBQWidget\fP * parent = 0, const char * name = 0)"
.PP
Constructs a horizontal one-dimensional selection widget. Definition at line 190 of file kselect.cpp.
.PP
References KStdAccel::name().
.SS "KSelector::KSelector (Orientation o, \fBQWidget\fP * parent = 0L, const char * name = 0L)"
.PP
Constructs a one-dimensional selection widget with a given orientation. Definition at line 197 of file kselect.cpp.
.PP
References KStdAccel::name().
.SH "Member Function Documentation"
.PP 
.SS "Orientation KSelector::orientation () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the orientation of the widget. 
.RE
.PP
Definition at line 167 of file kselect.h.
.PP
Referenced by contentsRect(), drawArrow(), and KGradientSelector::drawContents().
.SS "\fBQRect\fP KSelector::contentsRect () const"
.PP
\fBReturns:\fP
.RS 4
the rectangle on which subclasses should draw. 
.RE
.PP
Definition at line 209 of file kselect.cpp.
.PP
References QWidget::height(), orientation(), and QWidget::width().
.PP
Referenced by KGradientSelector::drawContents().
.SS "void KSelector::setIndent (bool i)\fC [inline]\fP"
.PP
Sets the indent option of the widget to i. This determines whether a shaded frame is drawn. Definition at line 179 of file kselect.h.
.SS "bool KSelector::indent () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
whether the indent option is set. 
.RE
.PP
Definition at line 184 of file kselect.h.
.SS "void KSelector::setValue (int value)\fC [inline]\fP"
.PP
Sets the value. Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 190 of file kselect.h.
.PP
References QRangeControl::setValue().
.SS "int KSelector::value () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the value. 
.RE
.PP
Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 196 of file kselect.h.
.PP
References QRangeControl::value().
.SS "void KSelector::setMinValue (int value)\fC [inline]\fP"
.PP
Sets the min value. Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 202 of file kselect.h.
.PP
References QRangeControl::setMinValue().
.SS "int KSelector::minValue () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the min value. 
.RE
.PP
Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 208 of file kselect.h.
.PP
References QRangeControl::minValue().
.SS "void KSelector::setMaxValue (int value)\fC [inline]\fP"
.PP
Sets the max value. Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 214 of file kselect.h.
.PP
References QRangeControl::setMaxValue().
.SS "int KSelector::maxValue () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the max value. 
.RE
.PP
Reimplemented from \fBQRangeControl\fP.
.PP
Definition at line 220 of file kselect.h.
.PP
References QRangeControl::maxValue().
.SS "void KSelector::valueChanged (int value)\fC [signal]\fP"
.PP
This signal is emitted whenever the user chooses a value, e.g. by clicking with the mouse on the widget. 
.SS "void KSelector::drawContents (\fBQPainter\fP *)\fC [protected, virtual]\fP"
.PP
Override this function to draw the contents of the control. The default implementation does nothing.
.PP
Draw only within \fBcontentsRect()\fP. Reimplemented in \fBKValueSelector\fP, and \fBKGradientSelector\fP.
.PP
Definition at line 309 of file kselect.cpp.
.SS "void KSelector::drawArrow (\fBQPainter\fP * painter, bool show, const \fBQPoint\fP & pos)\fC [protected, virtual]\fP"
.PP
Override this function to draw the cursor which indicates the current value. This function is always called twice, once with argument show=false to clear the old cursor, once with argument show=true to draw the new one. Definition at line 312 of file kselect.cpp.
.PP
References QWidget::colorGroup(), QPainter::drawPolygon(), orientation(), QWidget::repaint(), QPainter::setBrush(), QPainter::setPen(), QPointArray::setPoint(), QPoint::x(), and QPoint::y().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
