KPageWidget Class Reference

Page widget with many layouts (faces). More...

#include <kpagewidget.h>

Inheritance diagram for KPageWidget:

List of all members.

Signals
void	currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before)
void	pageRemoved (KPageWidgetItem *page)
void	pageToggled (KPageWidgetItem *page, bool checked)
Public Member Functions
	KPageWidget (QWidget *parent=0)
	~KPageWidget ()
void	addPage (KPageWidgetItem *item)
KPageWidgetItem *	addPage (QWidget *widget, const QString &name)
void	addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item)
KPageWidgetItem *	addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name)
KPageWidgetItem *	currentPage () const
KPageWidgetItem *	insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name)
void	insertPage (KPageWidgetItem *before, KPageWidgetItem *item)
void	removePage (KPageWidgetItem *item)
void	setCurrentPage (KPageWidgetItem *item)
Protected Member Functions
	KPageWidget (KPageWidgetPrivate &dd, QWidget *parent)

---

Detailed Description

Page widget with many layouts (faces).

See also:

KPageView with hierarchical page model.

Author:

Tobias Koenig (tokoe@kde.org)

Definition at line 36 of file kpagewidget.h.

---

Constructor & Destructor Documentation

KPageWidget::KPageWidget

(

QWidget *

parent = 0

)

[explicit]

Creates a new page widget.

Parameters:

parent

The parent widget.

Definition at line 63 of file kpagewidget.cpp.

KPageWidget::~KPageWidget

(

)

Destroys the page widget.

Definition at line 76 of file kpagewidget.cpp.

KPageWidget::KPageWidget	(	KPageWidgetPrivate &	dd,
		QWidget *	parent
	)		[protected]

Definition at line 46 of file kpagewidget.cpp.

---

Member Function Documentation

KPageWidgetItem * KPageWidget::addPage	(	QWidget *	widget,
		const QString &	name
	)

Adds a new top level page to the widget.

Parameters:

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns:

The associated

See also:

KPageWidgetItem.

Definition at line 80 of file kpagewidget.cpp.

void KPageWidget::addPage

(

KPageWidgetItem *

item

)

Adds a new top level page to the widget.

Parameters:

item

The

See also:

KPageWidgetItem which describes the page.

Definition at line 85 of file kpagewidget.cpp.

KPageWidgetItem * KPageWidget::addSubPage	(	KPageWidgetItem *	parent,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new sub page in the widget.

Parameters:

parent

The new page will be insert as child of this

See also:

KPageWidgetItem.

Parameters:

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns:

The associated

See also:

KPageWidgetItem.

Definition at line 100 of file kpagewidget.cpp.

void KPageWidget::addSubPage	(	KPageWidgetItem *	parent,
		KPageWidgetItem *	item
	)

Inserts a new sub page in the widget.

Parameters:

parent

The new page will be insert as child of this

See also:

KPageWidgetItem.

Parameters:

item

The

See also:

KPageWidgetItem which describes the page.

Definition at line 105 of file kpagewidget.cpp.

KPageWidgetItem * KPageWidget::currentPage

(

)

const

Returns the.

See also:

KPageWidgetItem for the current page or 0 if there is no current page.

Reimplemented from KPageView.

Definition at line 125 of file kpagewidget.cpp.

void KPageWidget::currentPageChanged	(	KPageWidgetItem *	current,
		KPageWidgetItem *	before
	)		[signal]

This signal is emitted whenever the current page has changed.

Parameters:

item	The new current page or 0 if no current page is available.

void KPageWidget::insertPage	(	KPageWidgetItem *	before,
		KPageWidgetItem *	item
	)

Inserts a new page in the widget.

Parameters:

before

The new page will be insert before this

See also:

KPageWidgetItem on the same level in hierarchy.

Parameters:

item

The

See also:

KPageWidgetItem which describes the page.

Definition at line 95 of file kpagewidget.cpp.

KPageWidgetItem * KPageWidget::insertPage	(	KPageWidgetItem *	before,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new page in the widget.

Parameters:

before

The new page will be insert before this

See also:

KPageWidgetItem on the same level in hierarchy.

Parameters:

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns:

The associated

See also:

KPageWidgetItem.

Definition at line 90 of file kpagewidget.cpp.

void KPageWidget::pageRemoved

(

KPageWidgetItem *

page

)

[signal]

This signal is emitted when a page is removed.

Parameters:

page	The page which is removed

void KPageWidget::pageToggled	(	KPageWidgetItem *	page,
		bool	checked
	)		[signal]

This signal is emitted whenever a checkable page changes its state.

Parameters:

checked	is true when the
page	is checked, or false if the
page	is unchecked.

void KPageWidget::removePage

(

KPageWidgetItem *

item

)

Removes the page associated with the given.

See also:

KPageWidgetItem.

Definition at line 110 of file kpagewidget.cpp.

void KPageWidget::setCurrentPage

(

KPageWidgetItem *

item

)

Sets the page which is associated with the given.

See also:

KPageWidgetItem to be the current page and emits the currentPageChanged() signal.

Definition at line 116 of file kpagewidget.cpp.

---

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

• kpagewidget.h
• kpagewidget.cpp