#include <KoRuler.h>

Inherits TQFrame.

Signals
void	newPageLayout (const KoPageLayout &)

void	newLeftIndent (double)

void	newFirstIndent (double)

void	newRightIndent (double)

void	openPageLayoutDia ()

void	doubleClicked ()

void	doubleClicked (double ptPos)

void	tabListChanged (const KoTabulatorList &)

void	unitChanged (KoUnit::Unit)

void	addGuide (const TQPoint &, bool, int)

void	moveGuide (const TQPoint &, bool, int)

void	addHelpline (const TQPoint &, bool)

void	moveHelpLines (const TQPoint &, bool)

Public Member Functions
	KoRuler (TQWidget _parent, TQWidget _canvas, TQt::Orientation _orientation, const KoPageLayout &_layout, int _flags, KoUnit::Unit _unit, KoTabChooser *_tabChooser=0L)

void	setUnit (const TQString &unit) TDE_DEPRECATED

void	setUnit (KoUnit::Unit unit)

void	setZoom (const double &zoom=1.0)

const double &	zoom () const

void	setPageLayout (const KoPageLayout &_layout)

void	showMousePos (bool _showMPos)

void	setMousePos (int mx, int my)

void	setOffset (int _diffx, int _diffy)

void	setLeftIndent (double _left)

void	setFirstIndent (double _first)

void	setRightIndent (double _right)

void	setDirection (bool rtl)

void	setTabList (const KoTabulatorList &tabList)

void	setFrameStartEnd (int _frameStart, int _frameEnd)

void	setReadWrite (bool _readWrite)

void	changeFlags (int _flags)

void	setGridSize (double newGridSize)

int	flags () const

bool	doubleClickedIndent () const

void	setPageLayoutMenuItemEnabled (bool b)

virtual TQSize	minimumSizeHint () const

virtual TQSize	sizeHint () const

Static Public Attributes
static const int	F_TABS = 1

static const int	F_INDENTS = 2

static const int	F_HELPLINES = 4

static const int	F_NORESIZE = 8

Protected Types
enum	Action { A_NONE , A_BR_LEFT , A_BR_RIGHT , A_BR_TOP , A_BR_BOTTOM , A_LEFT_INDENT , A_FIRST_INDENT , A_TAB , A_RIGHT_INDENT , A_HELPLINES }

Protected Slots
void	slotMenuActivated (int i)

void	pageLayoutDia ()

void	rbRemoveTab ()

Protected Member Functions
void	drawContents (TQPainter *_painter)

void	drawHorizontal (TQPainter *_painter)

void	drawVertical (TQPainter *_painter)

void	drawTabs (TQPainter &_painter)

void	mousePressEvent (TQMouseEvent *e)

void	mouseReleaseEvent (TQMouseEvent *e)

void	mouseMoveEvent (TQMouseEvent *e)

void	mouseDoubleClickEvent (TQMouseEvent *)

void	resizeEvent (TQResizeEvent *e)

void	handleDoubleClick ()

double	makeIntern (double _v)

double	zoomIt (const double &value) const

int	zoomIt (const int &value) const

unsigned int	zoomIt (const unsigned int &value) const

double	unZoomIt (const double &value) const

int	unZoomIt (const int &value) const

unsigned int	unZoomIt (const unsigned int &value) const

void	setupMenu ()

void	uncheckMenu ()

void	searchTab (int mx)

void	drawLine (int oldX, int newX)

Friends
class	KoRulerPrivate

Detailed Description

KoRuler is the horizontal or vertical ruler, to be used around the drawing area of most KOffice programs.

It shows the graduated ruler with numbering, in any of the base units (like mm/pt/inch), and supports zooming, tabulators, paragraph indents, showing the mouse position, etc.

It also offers a popupmenu upon right-clicking, for changing the unit, the page layout, or removing a tab.

Definition at line 101 of file KoRuler.h.

Member Enumeration Documentation

◆ Action

enum KoRuler::Action

protected

Definition at line 277 of file KoRuler.h.

Constructor & Destructor Documentation

◆ KoRuler()

KoRuler::KoRuler	(	TQWidget *	_parent,
		TQWidget *	_canvas,
		TQt::Orientation	_orientation,
		const KoPageLayout &	_layout,
		int	_flags,
		KoUnit::Unit	_unit,
		KoTabChooser *	_tabChooser = `0L`
	)

Create a ruler TODO document params.

Definition at line 82 of file KoRuler.cpp.

◆ ~KoRuler()

KoRuler::~KoRuler ( )

Definition at line 143 of file KoRuler.cpp.

Member Function Documentation

◆ changeFlags()

void KoRuler::changeFlags ( int _flags )

Change the flag (i.e.

activate or deactivate certain features of KoRuler)

Definition at line 1142 of file KoRuler.cpp.

◆ doubleClicked [1/2]

void KoRuler::doubleClicked ( )

signal

This signal is emitted when double-clicking the ruler (or an indent)

◆ doubleClicked [2/2]

void KoRuler::doubleClicked ( double ptPos )

signal

This signal is emitted when double-clicking a tab.

◆ doubleClickedIndent()

bool KoRuler::doubleClickedIndent ( ) const

Returns: whether the current doubleClicked() signal was triggered by the user double-clicking on an indent (BCI). It returns false if the user just double-clicked on an "empty" part of the ruler.

This method is strictly provided for use in a slot connected to the doubleClicked() signal; calling it at any other time results in undefined behavior.

Definition at line 1152 of file KoRuler.cpp.

◆ drawContents()

void KoRuler::drawContents ( TQPainter * _painter )

inlineprotected

Definition at line 281 of file KoRuler.h.

◆ drawHorizontal()

void KoRuler::drawHorizontal ( TQPainter * _painter )

protected

Definition at line 204 of file KoRuler.cpp.

◆ drawLine()

void KoRuler::drawLine	(	int	oldX,
		int	newX
	)

protected

Definition at line 1090 of file KoRuler.cpp.

◆ drawTabs()

void KoRuler::drawTabs ( TQPainter & _painter )

protected

Definition at line 324 of file KoRuler.cpp.

◆ drawVertical()

void KoRuler::drawVertical ( TQPainter * _painter )

protected

Definition at line 367 of file KoRuler.cpp.

◆ flags()

int KoRuler::flags ( ) const

Returns: the current flags

Definition at line 1147 of file KoRuler.cpp.

◆ handleDoubleClick()

void KoRuler::handleDoubleClick ( )

protected

Definition at line 948 of file KoRuler.cpp.

◆ makeIntern()

double KoRuler::makeIntern ( double _v )

protected

Definition at line 1001 of file KoRuler.cpp.

◆ minimumSizeHint()

TQSize KoRuler::minimumSizeHint ( ) const

virtual

Reimplemented from TQWidget.

Definition at line 1179 of file KoRuler.cpp.

◆ mouseDoubleClickEvent()

void KoRuler::mouseDoubleClickEvent ( TQMouseEvent * )

protected

Definition at line 943 of file KoRuler.cpp.

◆ mouseMoveEvent()

void KoRuler::mouseMoveEvent ( TQMouseEvent * e )

protected

Definition at line 665 of file KoRuler.cpp.

◆ mousePressEvent()

void KoRuler::mousePressEvent ( TQMouseEvent * e )

protected

Definition at line 478 of file KoRuler.cpp.

◆ mouseReleaseEvent()

void KoRuler::mouseReleaseEvent ( TQMouseEvent * e )

protected

Definition at line 583 of file KoRuler.cpp.

◆ openPageLayoutDia

void KoRuler::openPageLayoutDia ( )

signal

Old signal, kept for compatibility.

Use doubleClicked instead.

◆ pageLayoutDia

void KoRuler::pageLayoutDia ( )

inlineprotectedslot

Definition at line 332 of file KoRuler.h.

◆ rbRemoveTab

void KoRuler::rbRemoveTab ( )

protectedslot

Definition at line 1061 of file KoRuler.cpp.

◆ resizeEvent()

void KoRuler::resizeEvent ( TQResizeEvent * e )

protected

Definition at line 937 of file KoRuler.cpp.

◆ searchTab()

void KoRuler::searchTab ( int mx )

protected

Definition at line 1074 of file KoRuler.cpp.

◆ setDirection()

void KoRuler::setDirection ( bool rtl )

Set the [paragraph] direction.

By default (rtl=false), the left indent is on the left, and the right indent is on the right ;) If rtl=true, it's the opposite.

Definition at line 1136 of file KoRuler.cpp.

◆ setFirstIndent()

void KoRuler::setFirstIndent ( double _first )

inline

Set the [paragraph] first-line left indent to the specified position (in the current unit) This indent is cumulated with the left or right margin, depending on the [paragraph] direction.

Definition at line 178 of file KoRuler.h.

◆ setFrameStartEnd()

void KoRuler::setFrameStartEnd	(	int	_frameStart,
		int	_frameEnd
	)

Set the start and the end of the current 'frame', i.e.

the part of the page in which we are currently working. See KWord frames for an example where this is used. The tab positions and paragraph indents then become relative to the beginning of the frame, and the ruler goes from frameStart to frameEnd instead of using the page margins. _frameStart et _frameEnd are in pixel coordinates.

Definition at line 1117 of file KoRuler.cpp.

◆ setGridSize()

void KoRuler::setGridSize ( double newGridSize )

inline

Set the size of the grid used for tabs positioning, size in pt.

default value is 0. 0 means no grid.

Definition at line 223 of file KoRuler.h.

◆ setLeftIndent()

void KoRuler::setLeftIndent ( double _left )

inline

Set the [paragraph] left indent to the specified position (in the current unit)

Definition at line 171 of file KoRuler.h.

◆ setMousePos()

void KoRuler::setMousePos	(	int	mx,
		int	my
	)

Set the position of the mouse, to update the indication in the ruler.

This is only effective if showMousePos(true) was called previously. The position to give is not zoomed, it's in real pixel coordinates!

Definition at line 155 of file KoRuler.cpp.

◆ setOffset()

void KoRuler::setOffset	(	int	_diffx,
		int	_diffy
	)

Set a global offset to the X and Y coordinates.

Usually the main drawing area is a TQScrollView, and this is called with contentsX() and contentsY(), each time those values change.

Definition at line 1109 of file KoRuler.cpp.

◆ setPageLayout()

void KoRuler::setPageLayout ( const KoPageLayout & _layout )

Set the page layout, see KoPageLayout.

This defines the size of the page and the margins, from which the size of the ruler is deducted.

Definition at line 1196 of file KoRuler.cpp.

◆ setPageLayoutMenuItemEnabled()

void KoRuler::setPageLayoutMenuItemEnabled ( bool b )

Enable or disable the "Page Layout" menu item.

Definition at line 149 of file KoRuler.cpp.

◆ setReadWrite()

void KoRuler::setReadWrite ( bool _readWrite )

KoRuler is in "read write" mode by default.

Use setReadWrite(false) to use it in read-only mode.

Definition at line 1069 of file KoRuler.cpp.

◆ setRightIndent()

void KoRuler::setRightIndent ( double _right )

Set the [paragraph] right indent to the specified position (in the current unit)

Definition at line 1130 of file KoRuler.cpp.

◆ setTabList()

void KoRuler::setTabList ( const KoTabulatorList & tabList )

Set the list of tabulators to show in the ruler.

Definition at line 990 of file KoRuler.cpp.

◆ setUnit() [1/2]

void KoRuler::setUnit ( const TQString & unit )

Set the unit to be used.

The unit is specified using text as defined in KoUnit, for example "mm", "pt" or "inch".

Deprecated:: You should use the KoUnit::Unit variant instead.

Definition at line 1032 of file KoRuler.cpp.

◆ setUnit() [2/2]

void KoRuler::setUnit ( KoUnit::Unit unit )

Set the unit to be used.

Definition at line 1037 of file KoRuler.cpp.

◆ setupMenu()

void KoRuler::setupMenu ( )

protected

Definition at line 1006 of file KoRuler.cpp.

◆ setZoom()

void KoRuler::setZoom ( const double & zoom = 1.0 )

Set the zoom of the ruler (default value of 1.0 is 100%)

Definition at line 1045 of file KoRuler.cpp.

◆ showMousePos()

void KoRuler::showMousePos ( bool _showMPos )

Call showMousePos(true) if the ruler should indicate the position of the mouse.

This is usually only the case for drawing applications, so it is not enabled by default.

Definition at line 1100 of file KoRuler.cpp.

◆ sizeHint()

TQSize KoRuler::sizeHint ( ) const

virtual

Reimplemented from TQWidget.

Definition at line 1191 of file KoRuler.cpp.

◆ slotMenuActivated

void KoRuler::slotMenuActivated ( int i )

protectedslot

Definition at line 1169 of file KoRuler.cpp.

◆ uncheckMenu()

void KoRuler::uncheckMenu ( )

protected

Definition at line 1026 of file KoRuler.cpp.

◆ unZoomIt() [1/3]

double KoRuler::unZoomIt ( const double & value ) const

inlineprotected

Definition at line 355 of file KoRuler.h.

◆ unZoomIt() [2/3]

int KoRuler::unZoomIt ( const int & value ) const

inlineprotected

Definition at line 361 of file KoRuler.h.

◆ unZoomIt() [3/3]

unsigned int KoRuler::unZoomIt ( const unsigned int & value ) const

inlineprotected

Definition at line 367 of file KoRuler.h.

◆ zoom()

const double & KoRuler::zoom ( ) const

inline

Returns: the current zoom level

Definition at line 139 of file KoRuler.h.

◆ zoomIt() [1/3]

double KoRuler::zoomIt ( const double & value ) const

inlineprotected

Definition at line 337 of file KoRuler.h.

◆ zoomIt() [2/3]

int KoRuler::zoomIt ( const int & value ) const

inlineprotected

Definition at line 343 of file KoRuler.h.

◆ zoomIt() [3/3]

unsigned int KoRuler::zoomIt ( const unsigned int & value ) const

inlineprotected

Definition at line 349 of file KoRuler.h.

Friends And Related Symbol Documentation

◆ KoRulerPrivate

friend class KoRulerPrivate

friend

Definition at line 105 of file KoRuler.h.

Member Data Documentation

◆ F_HELPLINES

const int KoRuler::F_HELPLINES = 4

static

Definition at line 109 of file KoRuler.h.

◆ F_INDENTS

const int KoRuler::F_INDENTS = 2

static

Definition at line 108 of file KoRuler.h.

◆ F_NORESIZE

const int KoRuler::F_NORESIZE = 8

static

Definition at line 110 of file KoRuler.h.

◆ F_TABS

const int KoRuler::F_TABS = 1

static

Definition at line 107 of file KoRuler.h.

The documentation for this class was generated from the following files:

lib

Signals

Public Member Functions

Static Public Attributes

Protected Types

Protected Slots

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ Action

Constructor & Destructor Documentation

◆ KoRuler()

◆ ~KoRuler()

Member Function Documentation

◆ changeFlags()

◆ doubleClicked [1/2]

◆ doubleClicked [2/2]

◆ doubleClickedIndent()

◆ drawContents()

◆ drawHorizontal()

◆ drawLine()

◆ drawTabs()

◆ drawVertical()

◆ flags()

◆ handleDoubleClick()

◆ makeIntern()

◆ minimumSizeHint()

◆ mouseDoubleClickEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ openPageLayoutDia

◆ pageLayoutDia

◆ rbRemoveTab

◆ resizeEvent()

◆ searchTab()

◆ setDirection()

◆ setFirstIndent()

◆ setFrameStartEnd()

◆ setGridSize()

◆ setLeftIndent()

◆ setMousePos()

◆ setOffset()

◆ setPageLayout()

◆ setPageLayoutMenuItemEnabled()

◆ setReadWrite()

◆ setRightIndent()

◆ setTabList()

◆ setUnit() [1/2]

◆ setUnit() [2/2]

◆ setupMenu()

◆ setZoom()

◆ showMousePos()

◆ sizeHint()

◆ slotMenuActivated

◆ uncheckMenu()

◆ unZoomIt() [1/3]

◆ unZoomIt() [2/3]

◆ unZoomIt() [3/3]

◆ zoom()

◆ zoomIt() [1/3]

◆ zoomIt() [2/3]

◆ zoomIt() [3/3]

Friends And Related Symbol Documentation

◆ KoRulerPrivate

Member Data Documentation

◆ F_HELPLINES

◆ F_INDENTS

◆ F_NORESIZE

◆ F_TABS

lib

lib