Kate::DockViewBase Class Reference

Base class for dockwidget views This class creates a widget meant to be set as the main widget for a KDockWidget. More...

#include <dockviewbase.h>

Inheritance diagram for Kate::DockViewBase:

[legend]

List of all members.

Public Member Functions
	DockViewBase (const QString &prefix, const QString &title, QWidget *parent=0, const char *name=0)
	DockViewBase (QWidget *parent=0, const char *name=0)
void	setTitle (const QString &prefix, const QString &title)
void	setTitle (const QString &title)
void	setTitlePrefix (const QString &prefix)
QString	title () const
QString	titlePrefix () const
	~DockViewBase ()

---

Detailed Description

Base class for dockwidget views This class creates a widget meant to be set as the main widget for a KDockWidget.

This class provides a title in two parts, titlePrefix and title. The size policies are set so that neither will prevent resizing the view to a width smaller than the texts, the titlePrefix (on the left) will remain fully visible for as long as possible.

Use the titlePrefix to describe the nature of the view contents, for example "Messages".

Use the title to inform the user what is currently in the view, for example the name of a related file, a command or similar.

To add widgets, just create them with this as the parent.

Author:

Anders Lund <anders@alweb.dk>

Definition at line 53 of file dockviewbase.h.

---

Constructor & Destructor Documentation

Kate::DockViewBase::DockViewBase	(	QWidget *	parent = 0,
		const char *	name = 0
	)

Create a KateDockViewBase.

Definition at line 39 of file dockviewbase.cpp.

Kate::DockViewBase::DockViewBase	(	const QString &	prefix,
		const QString &	title,
		QWidget *	parent = 0,
		const char *	name = 0
	)

Create a KateDockViewBase with the title prefix prefix and the title title.

Definition at line 46 of file dockviewbase.cpp.

Kate::DockViewBase::~DockViewBase

(

)

Definition at line 53 of file dockviewbase.cpp.

---

Member Function Documentation

void Kate::DockViewBase::setTitle	(	const QString &	prefix,
		const QString &	title
	)

Convenience method, sets both the prefix and title.

Definition at line 80 of file dockviewbase.cpp.

void Kate::DockViewBase::setTitle

(

const QString &

title

)

Set the title to title.

Definition at line 69 of file dockviewbase.cpp.

void Kate::DockViewBase::setTitlePrefix

(

const QString &

prefix

)

Set the title prefix to prefix.

Definition at line 58 of file dockviewbase.cpp.

QString Kate::DockViewBase::title

(

)

const

Returns:

the title of the KateDockViewBase

Definition at line 75 of file dockviewbase.cpp.

QString Kate::DockViewBase::titlePrefix

(

)

const

Returns:

The title prefix.

Definition at line 64 of file dockviewbase.cpp.

---

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

• dockviewbase.h
• dockviewbase.cpp