kdeui Library API Documentation

KRuler Class Reference

A ruler widget. A ruler widget. More...

#include <kruler.h>

Inheritance diagram for KRuler:

QFrame List of all members.

Public Types

enum  MetricStyle {
  Custom = 0, Pixel, Inch, Millimetres,
  Centimetres, Metres
}

Public Slots

void slotNewValue (int)
void slotNewOffset (int)
void slotEndOffset (int)

Public Member Functions

 KRuler (QWidget *parent=0, const char *name=0)
 KRuler (Orientation orient, QWidget *parent=0, const char *name=0, WFlags f=0)
 KRuler (Orientation orient, int widgetWidth, QWidget *parent=0, const char *name=0, WFlags f=0)
 ~KRuler ()
void setMinValue (int)
int minValue () const
void setMaxValue (int)
int maxValue () const
void setRange (int min, int max)
void setValue (int)
int value () const
void setTinyMarkDistance (int)
int tinyMarkDistance () const
void setLittleMarkDistance (int)
int littleMarkDistance () const
void setMediumMarkDistance (int)
int mediumMarkDistance () const
void setBigMarkDistance (int)
int bigMarkDistance () const
void setShowTinyMarks (bool)
bool showTinyMarks () const
void setShowLittleMarks (bool)
bool showLittleMarks () const
void setShowMediumMarks (bool)
bool showMediumMarks () const
void setShowBigMarks (bool)
bool showBigMarks () const
void setShowEndMarks (bool)
bool showEndMarks () const
void setShowPointer (bool)
bool showPointer () const
void setValuePerLittleMark (int) KDE_DEPRECATED
void setValuePerMediumMark (int) KDE_DEPRECATED
void setValuePerBigMark (int) KDE_DEPRECATED
void setShowEndLabel (bool)
bool showEndLabel () const
void setEndLabel (const QString &)
QString endLabel () const
void setRulerMetricStyle (KRuler::MetricStyle)
void setPixelPerMark (double rate)
double pixelPerMark () const
void setLength (int)
int length () const
void setLengthFixed (bool fix)
bool lengthFixed () const
void slideUp (int count=1)
void slideDown (int count=1)
void setOffset (int offset)
int offset () const
int endOffset () const

Protected Member Functions

virtual void drawContents (QPainter *)
virtual void virtual_hook (int id, void *data)

Detailed Description

A ruler widget. A ruler widget.

The vertical ruler looks similar to this:

meters inches ------ <--- end mark ---> ------ -- - -- <---little mark---> -- -- - -- --- --- <---medium mark - -- -- -- tiny mark----> - -- ---- -- - ---- <-----big mark -- -- - |>-- <--ruler pointer--> |>--

There are tiny marks, little marks, medium marks, and big marks along the ruler.

To receive mouse clicks or mouse moves, the class has to be overloaded.

For performance reasons, the public methods don't call QWidget::repaint(). (Slots do, see documentation below.) All the changed settings will be painted once after leaving to the main event loop. For performance painting the slot methods should be used, they do a fast QWidget::repaint() call after changing the values. For setting multiple values like minValue(), maxValue(), offset() etc. using the public methods is recommended so the widget will be painted only once when entering the main event loop.

Author:
Jörg Habenicht

Definition at line 71 of file kruler.h.


Member Enumeration Documentation

enum KRuler::MetricStyle
 

The types of units used.

Definition at line 104 of file kruler.h.


Constructor & Destructor Documentation

KRuler::KRuler QWidget parent = 0,
const char *  name = 0
 

Constructs a horizontal ruler.

Definition at line 99 of file kruler.cpp.

KRuler::KRuler Orientation  orient,
QWidget parent = 0,
const char *  name = 0,
WFlags  f = 0
 

Constructs a ruler with orientation orient.

parent, name and f are passed to QFrame. The default look is a raised widget but may be changed with the inherited QFrame methods.

Parameters:
orient Orientation of the ruler.
parent Will be handed over to QFrame.
name Will be handed over to QFrame.
f Will be handed over to QFrame.

Definition at line 109 of file kruler.cpp.

KRuler::KRuler Orientation  orient,
int  widgetWidth,
QWidget parent = 0,
const char *  name = 0,
WFlags  f = 0
 

Constructs a ruler with orientation orient and initial width widgetWidth.

The width sets the fixed width of the widget. This is useful if you want to draw the ruler bigger or smaller than the default size. Note: The size of the marks doesn't change. parent, name and f are passed to QFrame.

Parameters:
orient Orientation of the ruler.
widgetWidth Fixed width of the widget.
parent Will be handed over to QFrame.
name Will be handed over to QFrame.
f Will be handed over to QFrame.

Definition at line 123 of file kruler.cpp.

KRuler::~KRuler  ) 
 

Destructor.

Definition at line 162 of file kruler.cpp.


Member Function Documentation

void KRuler::setMinValue int   ) 
 

Sets the minimal value of the ruler pointer (default is 0).

This method calls update() so that the widget is painted after leaving to the main event loop.

Definition at line 168 of file kruler.cpp.

int KRuler::minValue  )  const [inline]
 

Returns the minimal value of the ruler pointer.

Definition at line 486 of file kruler.h.

void KRuler::setMaxValue int   ) 
 

Sets the maximum value of the ruler pointer (default is 100).

This method calls update() so that the widget is painted after leaving to the main event loop.

Definition at line 177 of file kruler.cpp.

int KRuler::maxValue  )  const [inline]
 

Returns the maximal value of the ruler pointer.

Definition at line 490 of file kruler.h.

void KRuler::setRange int  min,
int  max
 

Sets minimum and maximum values of the ruler pointer.

This method calls update() so that the widget is painted after leaving to the main event loop.

Definition at line 186 of file kruler.cpp.

void KRuler::setValue int   ) 
 

Sets the value of the ruler pointer.

The value is indicated by painting the ruler pointer at the corresponding position. This method calls update() so that the widget is painted after leaving to the main event loop.

Definition at line 195 of file kruler.cpp.

void KRuler::setTinyMarkDistance int   ) 
 

Sets the distance between tiny marks.

This is mostly used in the English system (inches) with distance of 1.

Definition at line 202 of file kruler.cpp.

Referenced by setRulerMetricStyle().

int KRuler::tinyMarkDistance  )  const [inline]
 

Returns the distance between tiny marks.

Definition at line 498 of file kruler.h.

void KRuler::setLittleMarkDistance int   ) 
 

Sets the distance between little marks.

The default value is 1 in the metric system and 2 in the English (inches) system.

Definition at line 211 of file kruler.cpp.

Referenced by setRulerMetricStyle().

int KRuler::littleMarkDistance  )  const [inline]
 

Returns the distance between little marks.

Definition at line 502 of file kruler.h.

void KRuler::setMediumMarkDistance int   ) 
 

Sets the distance between medium marks.

For English (inches) styles it defaults to twice the little mark distance. For metric styles it defaults to five times the little mark distance.

Definition at line 220 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setBigMarkDistance int   ) 
 

Sets distance between big marks.

For English (inches) or metric styles it is twice the medium mark distance.

Definition at line 229 of file kruler.cpp.

Referenced by setRulerMetricStyle().

int KRuler::bigMarkDistance  )  const [inline]
 

Returns the distance between big marks.

Definition at line 510 of file kruler.h.

void KRuler::setShowTinyMarks bool   ) 
 

Shows/hides tiny marks.

Definition at line 238 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowLittleMarks bool   ) 
 

Shows/hides little marks.

Definition at line 253 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowMediumMarks bool   ) 
 

Shows/hides medium marks.

Definition at line 268 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowBigMarks bool   ) 
 

Shows/hides big marks.

Definition at line 283 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowEndMarks bool   ) 
 

Shows/hides end marks.

Definition at line 299 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowPointer bool   ) 
 

Shows/hides the pointer.

Definition at line 314 of file kruler.cpp.

void KRuler::setValuePerLittleMark int   ) 
 

Deprecated:
This method has no effect other than an update. Do not use.

Definition at line 330 of file kruler.cpp.

void KRuler::setValuePerMediumMark int   ) 
 

Deprecated:
This method has no effect other than an update. Do not use.

Definition at line 336 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setValuePerBigMark int   ) 
 

Deprecated:
This method has no effect other than an update. Do not use.

Definition at line 342 of file kruler.cpp.

Referenced by setRulerMetricStyle().

void KRuler::setShowEndLabel bool   ) 
 

Show/hide number values of the end marks.

Default is false.

Definition at line 348 of file kruler.cpp.

void KRuler::setEndLabel const QString  ) 
 

Sets the label this is drawn at the beginning of the visible part of the ruler to label.

Definition at line 365 of file kruler.cpp.

void KRuler::setRulerMetricStyle KRuler::MetricStyle   ) 
 

Sets up the necessary tasks for the provided styles.

A convenience method.

Definition at line 385 of file kruler.cpp.

References setBigMarkDistance(), setLittleMarkDistance(), setMediumMarkDistance(), setPixelPerMark(), setShowBigMarks(), setShowEndMarks(), setShowLittleMarks(), setShowMediumMarks(), setShowTinyMarks(), setTinyMarkDistance(), setValuePerBigMark(), and setValuePerMediumMark().

void KRuler::setPixelPerMark double  rate  ) 
 

Sets the number of pixels between two base marks.

Calling this method stretches or shrinks your ruler.

For pixel display ( MetricStyle) the value is 10.0 marks per pixel ;-) For English (inches) it is 9.0, and for centimetres ~2.835 -> 3.0 . If you want to magnify your part of display, you have to adjust the mark distance here. Notice: The double type is only supported to give the possibility of having some double values. It should be used with care. Using values below 10.0 shows visible jumps of markpositions (e.g. 2.345). Using whole numbers is highly recommended. To use int values use setPixelPerMark((int)your_int_value); default: 1 mark per 10 pixels

Definition at line 462 of file kruler.cpp.

Referenced by setRulerMetricStyle().

double KRuler::pixelPerMark  )  const [inline]
 

Returns the number of pixels between two base marks.

Definition at line 514 of file kruler.h.

void KRuler::setLength int   ) 
 

Sets the length of the ruler, i.e.

the difference between the begin mark and the end mark of the ruler.

Same as (width() - offset())

when the length is not locked, it gets adjusted with the length of the widget.

Definition at line 470 of file kruler.cpp.

void KRuler::setLengthFixed bool  fix  ) 
 

Locks the length of the ruler, i.e.

the difference between the two end marks doesn't change when the widget is resized.

Parameters:
fix fixes the length, if true

Definition at line 496 of file kruler.cpp.

void KRuler::slideUp int  count = 1  ) 
 

Sets the number of pixels by which the ruler may slide up or left.

The number of pixels moved is realive to the previous position. The Method makes sense for updating a ruler, which is working with a scrollbar.

This doesn't affect the position of the ruler pointer. Only the visible part of the ruler is moved.

Parameters:
count Number of pixel moving up or left relative to the previous position

Definition at line 527 of file kruler.cpp.

void KRuler::slideDown int  count = 1  ) 
 

Sets the number of pixels by which the ruler may slide down or right.

The number of pixels moved is realive to the previous position. The Method makes sense for updating a ruler, which is working with a scrollbar.

This doesn't affect the position of the ruler pointer. Only the visible part of the ruler is moved.

Parameters:
count Number of pixel moving up or left relative to the previous position

Definition at line 536 of file kruler.cpp.

void KRuler::setOffset int  offset  ) 
 

Sets the ruler slide offset.

This is like slideup() or slidedown() with an absolute offset from the start of the ruler.

Parameters:
offset Number of pixel to move the ruler up or left from the beginning

Definition at line 508 of file kruler.cpp.

int KRuler::offset  )  const [inline]
 

Returns the current ruler offset.

Definition at line 518 of file kruler.h.

void KRuler::slotNewValue int   )  [slot]
 

Sets the pointer to a new position.

The offset is NOT updated. QWidget::repaint() is called afterwards.

Definition at line 546 of file kruler.cpp.

void KRuler::slotNewOffset int   )  [slot]
 

Sets the ruler marks to a new position.

The pointer is NOT updated. QWidget::repaint() is called afterwards.

Definition at line 572 of file kruler.cpp.


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