#include <kjanuswidget.h>

Inherits TQWidget.

Public Types
enum	Face { TreeList = 0 , Tabbed , Plain , Swallow , IconList }

Public Slots
virtual void	setFocus ()

Signals
void	aboutToShowPage (TQWidget *page)

Public Member Functions
	KJanusWidget (TQWidget parent=0, const char name=0, int face=Plain)

	~KJanusWidget ()

virtual bool	showPage (int index)

virtual int	activePageIndex () const

virtual bool	isValid () const

virtual int	face () const

virtual TQSize	minimumSizeHint () const

virtual TQSize	sizeHint () const

virtual TQFrame *	plainPage ()

virtual TQFrame *	addPage (const TQString &item, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQFrame *	addPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQVBox *	addVBoxPage (const TQString &item, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQVBox *	addVBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQHBox *	addHBoxPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQHBox *	addHBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQGrid *	addGridPage (int n, Orientation dir, const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

virtual TQGrid *	addGridPage (int n, Orientation dir, const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())

void	removePage (TQWidget *page)

virtual int	pageIndex (TQWidget *widget) const

virtual bool	setSwallowedWidget (TQWidget *widget)

virtual void	setTreeListAutoResize (bool state)

virtual void	setShowIconsInTreeList (bool state)

virtual void	setRootIsDecorated (bool state)

void	unfoldTreeList (bool persist=false)

void	addWidgetBelowList (TQWidget *widget)

void	addButtonBelowList (const TQString &text, TQObject recv, const char slot)

void	addButtonBelowList (const KGuiItem &guiitem, TQObject recv, const char slot)

virtual void	setIconListAllVisible (bool state)

virtual void	setFolderIcon (const TQStringList &path, const TQPixmap &pixmap)

TQString	pageTitle (int index) const

TQWidget *	pageWidget (int index) const

Protected Member Functions
virtual void	showEvent (TQShowEvent *)

virtual bool	eventFilter (TQObject o, TQEvent e)

bool	showPage (TQWidget *w)

void	addPageWidget (TQFrame *page, const TQStringList &items, const TQString &header, const TQPixmap &pixmap)

void	InsertTreeListItem (const TQStringList &items, const TQPixmap &pixmap, TQFrame *page)

TQWidget *	FindParent ()

virtual void	virtual_hook (int id, void *data)

Detailed Description

Easy to use widget with many layouts.

Provides a number of ready to use layouts (faces). It is used as an internal widget in KDialogBase, but can also used as a widget of its own.

This class provides KJanusWidget::TreeList, KJanusWidget::IconList, KJanusWidget::Tabbed, KJanusWidget::Plain and KJanusWidget::Swallow layouts.

For all modes it is important that you specify the TQWidget::minimumSize() on the page, plain widget or the swallowed widget. If you use a QLayout on the page, plain widget or the swallowed widget this will be taken care of automatically. The size is used when the KJanusWidget determines its own minimum size. You get the minimum size by using the minimumSizeHint() or sizeHint() methods.

Pages that have been added in TreeList, IconList or Tabbed mode can be removed by simply deleting the page. However, it would be preferable to use the TQObject::deleteLater() function on the page as the main event loop may have optimized UI update events of the page by scheduling them for later.

Author: Espen Sand (espen.nosp@m.@kde.nosp@m..org)

Definition at line 67 of file kjanuswidget.h.

Member Enumeration Documentation

◆ Face

enum KJanusWidget::Face

Enumerator
TreeList	The TreeList face provides a list in the left area and pages in the right. The area are separated by a movable splitter. The style is somewhat similar to the layout in the Control Center. A page is raised by selecting the corresponding tree list item.
Tabbed	The Tabbed face is a common tabbed widget. The procedure for creating a page is similar for creating a TreeList. This has the advantage that if your widget contain too many pages it is trivial to convert it into a TreeList. Just change the face in the KJanusWidget constructor to KJanusWidget::TreeList and you have a tree list layout instead.
Plain	The Plain face provides an empty widget (TQFrame) where you can place your widgets. The KJanusWidget makes no assumptions regarding the contents so you are free to add whatever you want.
Swallow	The Swallow face is provided in order to simplify the usage of existing widgets and to allow changing the visible widget. You specify the widget to be displayed by setSwallowedWidget(). Your widget will be reparented inside the widget. You can specify a Null (0) widget. A empty space is then displayed.
IconList	The IconList face provides an icon list in the left area and pages in the right. For each entry the Icon is on top with the text below. The style is somewhat similar to the layout of the Eudora configuation dialog box. A page is raised by selecting the corresponding icon list item. The preferred icon size is 32x32 pixels.

Definition at line 96 of file kjanuswidget.h.

Constructor & Destructor Documentation

◆ KJanusWidget()

KJanusWidget::KJanusWidget	(	TQWidget *	parent = `0`,
		const char *	name = `0`,
		int	face = `Plain`
	)

Constructor where you specify the face.

Parameters

parent	Parent of the widget.
name	Widget name.
face	The kind of dialog, Use TreeList, Tabbed, Plain or Swallow.

Definition at line 90 of file kjanuswidget.cpp.

◆ ~KJanusWidget()

KJanusWidget::~KJanusWidget ( )

Destructor.

Definition at line 207 of file kjanuswidget.cpp.

Member Function Documentation

◆ aboutToShowPage

void KJanusWidget::aboutToShowPage ( TQWidget * page )

signal

This signal is emitted whenever the current page changes.

Parameters

page	the new page.

Since: 3.4

◆ activePageIndex()

int KJanusWidget::activePageIndex ( ) const

virtual

Returns the index of the page that are currently displayed.

Returns: The index or -1 if the face is not Tabbed, TreeList or IconList.

Definition at line 646 of file kjanuswidget.cpp.

◆ addButtonBelowList() [1/2]

void KJanusWidget::addButtonBelowList	(	const KGuiItem &	guiitem,
		TQObject *	recv,
		const char *	slot
	)

The same as the above function, but with a KGuiItem providing the text and icon for the button at the bottom of the TreeList/IconList.

Parameters

guiitem	The text and icon on the PushButton.
recv	The object that is to receive the signal when the button is clicked.
slot	The slot to connect to the clicked signal of the button.

Since: 3.2

Definition at line 885 of file kjanuswidget.cpp.

◆ addButtonBelowList() [2/2]

void KJanusWidget::addButtonBelowList	(	const TQString &	text,
		TQObject *	recv,
		const char *	slot
	)

Add a button at the bottom of the TreeList/IconList.

Parameters

text	The text on the PushButton.
recv	The object that is to receive the signal when the button is clicked.
slot	The slot to connect to the clicked signal of the button.

Since: 3.2

Definition at line 876 of file kjanuswidget.cpp.

◆ addGridPage() [1/2]

TQGrid * KJanusWidget::addGridPage	(	int	n,
		Orientation	dir,
		const TQString &	itemName,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

Add a new page when the class is used in either TreeList or Tabbed mode.

The returned widget is empty and you must add your widgets as children to this widget. The returned widget is a QGrid so it contains a TQGridLayout layout that places up the child widgets in a grid.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Parameters

n	Specifies the number of columns if 'dir' is TQGrid::Horizontal or the number of rows if 'dir' is TQGrid::Vertical.
dir	Can be TQGrid::Horizontal or TQGrid::Vertical.
itemName	String used in the list or Tab item.
header	A longer string used in TreeList and IconList mode to describe the contents of a page. If empty, the item string will be used instead.
pixmap	Used in IconList mode or in TreeList mode. You should prefer a pixmap with size 32x32 pixels.

Returns: The empty page or 0 if the face is not TreeList, IconList or Tabbed.

Definition at line 346 of file kjanuswidget.cpp.

◆ addGridPage() [2/2]

TQGrid * KJanusWidget::addGridPage	(	int	n,
		Orientation	dir,
		const TQStringList &	items,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

This is like addGridPage just above, with the difference that the first element is a list of strings.

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the TreeList face. Later this may be added for the IconList face too. In other faces than the TreeList, all the strings except the last one is ignored.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Definition at line 327 of file kjanuswidget.cpp.

◆ addHBoxPage() [1/2]

TQHBox * KJanusWidget::addHBoxPage	(	const TQString &	itemName,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

Add a new page when the class is used in TreeList, IconList or Tabbed mode.

The returned widget is empty and you must add your widgets as children to this widget. The returned widget is a QHBox so it contains a TQHBoxLayout layout that lines up the child widgets are horizontally.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Parameters

itemName	String used in the list or Tab item.
header	A longer string used in TreeList and IconList mode to describe the contents of a page. If empty, the item string will be used instead.
pixmap	Used in IconList mode or in TreeList mode. You should prefer a pixmap with size 32x32 pixels.

Returns: The empty page or 0 if the face is not TreeList, IconList or Tabbed.

Definition at line 318 of file kjanuswidget.cpp.

◆ addHBoxPage() [2/2]

TQHBox * KJanusWidget::addHBoxPage	(	const TQStringList &	items,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

This is like addHBoxPage just above, with the difference that the first element is a list of strings.

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the TreeList face. Later this may be added for the IconList face too. In other faces than the TreeList, all the strings except the last one is ignored.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Definition at line 302 of file kjanuswidget.cpp.

◆ addPage() [1/2]

TQFrame * KJanusWidget::addPage	(	const TQString &	item,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

Add a new page when the class is used in TreeList, IconList or Tabbed mode.

The returned widget is empty and you must add your widgets as children to this widget. In most cases you must create a layout manager and associate it with this widget as well.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Parameters

item	String used in the list or Tab item.
header	A longer string used in TreeList and IconList mode to describe the contents of a page. If empty, the item string will be used instead.
pixmap	Used in IconList mode or in TreeList mode. You should prefer a pixmap with size 32x32 pixels.

Returns: The empty page or 0 if the face is not TreeList, IconList or Tabbed.

Definition at line 266 of file kjanuswidget.cpp.

◆ addPage() [2/2]

TQFrame * KJanusWidget::addPage	(	const TQStringList &	items,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

This is like addPage just above, with the difference that the first element is a list of strings.

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the TreeList face. Later this may be added for the IconList face too. In other faces than the TreeList, all the strings except the last one is ignored. Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Definition at line 240 of file kjanuswidget.cpp.

◆ addPageWidget()

void KJanusWidget::addPageWidget	(	TQFrame *	page,
		const TQStringList &	items,
		const TQString &	header,
		const TQPixmap &	pixmap
	)

protected

Definition at line 430 of file kjanuswidget.cpp.

◆ addVBoxPage() [1/2]

TQVBox * KJanusWidget::addVBoxPage	(	const TQString &	item,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

Add a new page when the class is used in TreeList, IconList or Tabbed mode.

The returned widget is empty and you must add your widgets as children to this widget. The returned widget is a QVBox so it contains a TQVBoxLayout layout that lines up the child widgets are vertically.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Parameters

item	String used in the list or Tab item.
header	A longer string used in TreeList and IconList mode to describe the contents of a page. If empty, the item string will be used instead.
pixmap	Used in IconList mode or in TreeList mode. You should prefer a pixmap with size 32x32 pixels.

Returns: The empty page or 0 if the face is not TreeList, IconList or Tabbed.

Definition at line 293 of file kjanuswidget.cpp.

◆ addVBoxPage() [2/2]

TQVBox * KJanusWidget::addVBoxPage	(	const TQStringList &	items,
		const TQString &	header = `TQString::null`,
		const TQPixmap &	pixmap = `TQPixmap()`
	)

virtual

This is like addVBoxPage just above, with the difference that the first element is a list of strings.

These strings are used to form a path of folders down to the given page. The initial elements are names for the folders, while the last element is the name of the page. Note: This does yet only work for the TreeList face. Later this may be added for the IconList face too. In other faces than the TreeList, all the strings except the last one is ignored.

Deleting the returned frame will cause the listitem or tab to be removed (you can re-add a page with the same name later.

Definition at line 276 of file kjanuswidget.cpp.

◆ addWidgetBelowList()

void KJanusWidget::addWidgetBelowList ( TQWidget * widget )

Add a widget at the bottom of the TreeList/IconList.

Parameters

widget The widget to be added. It will be reparented into the KJanusWidget, therefor it will be deleted with the KJanusWidget, too. To be on the save side just don't keep the pointer to this widget.

Definition at line 868 of file kjanuswidget.cpp.

◆ eventFilter()

bool KJanusWidget::eventFilter	(	TQObject *	o,
		TQEvent *	e
	)

protectedvirtual

This function is used internally when in IconList mode.

If you reimplement this class a make your own event filter, make sure to call this function from your filter.

Parameters

o	Object that has received an event.
e	The event.

Definition at line 909 of file kjanuswidget.cpp.

◆ face()

int KJanusWidget::face ( ) const

virtual

Returns the face type.

Returns: The face type.

Definition at line 225 of file kjanuswidget.cpp.

◆ FindParent()

TQWidget * KJanusWidget::FindParent ( )

protected

Definition at line 230 of file kjanuswidget.cpp.

◆ InsertTreeListItem()

void KJanusWidget::InsertTreeListItem	(	const TQStringList &	items,
		const TQPixmap &	pixmap,
		TQFrame *	page
	)

protected

Definition at line 356 of file kjanuswidget.cpp.

◆ isValid()

bool KJanusWidget::isValid ( ) const

virtual

Use this to verify that no memory allocation failed.

Returns: true if the widget was properly created.

Definition at line 213 of file kjanuswidget.cpp.

◆ minimumSizeHint()

TQSize KJanusWidget::minimumSizeHint ( ) const

virtual

Returns the minimum size that must be made available for the widget so that UIs can be displayed properly.

Returns: The minimum size.

Definition at line 761 of file kjanuswidget.cpp.

◆ pageIndex()

int KJanusWidget::pageIndex ( TQWidget * widget ) const

virtual

Returns the index of a page created with addPage , addVBoxPage , addHBoxPage or addGridPage .

You can can compare this index with the value returned from activePageIndex if you need to do some page specific actions in your code.

The returned index will never change so you can safely use this function once and save the value.

Parameters

widget The widget returned by addPage , addVBoxPage , addHBoxPage or addGridPage .

Returns: The index or -1 if the face is not Tabbed, TreeList or IconList

Definition at line 670 of file kjanuswidget.cpp.

◆ pageTitle()

TQString KJanusWidget::pageTitle ( int index ) const

Returns the title string associated with a page index in TreeList or IconList mode.

Parameters

index The index of the page or null if there is no such page.

See also: pageIndex()

Since: 3.2

Definition at line 1238 of file kjanuswidget.cpp.

◆ pageWidget()

TQWidget * KJanusWidget::pageWidget ( int index ) const

Returns the page widget associated with a page index or null if there is no such page.

Parameters

index The index of the page.

See also: pageIndex()

Since: 3.2

Definition at line 1247 of file kjanuswidget.cpp.

◆ plainPage()

TQFrame * KJanusWidget::plainPage ( )

virtual

Returns the empty widget that is available in Plain mode.

Returns: The widget or 0 if the face in not Plain.

Definition at line 219 of file kjanuswidget.cpp.

◆ removePage()

void KJanusWidget::removePage ( TQWidget * page )

Removes a page created with addPage, addVBoxPage, addHBoxPage or addGridPage.

If the page has already been deleted or has already been removed, nothing happens. The widget itself is not deleted.

Parameters

page	The widget returned by addPage , addVBoxPage , addHBoxPage or addGridPage .

Definition at line 1192 of file kjanuswidget.cpp.

◆ setFocus

void KJanusWidget::setFocus ( )

virtualslot

Give the keyboard input focus to the widget.

Definition at line 735 of file kjanuswidget.cpp.

◆ setFolderIcon()

void KJanusWidget::setFolderIcon	(	const TQStringList &	path,
		const TQPixmap &	pixmap
	)

virtual

Sets the icon used in TreeList Mode for the given path.

Parameters

path	The path for which this icon should be shown.
pixmap	The icon used.

Definition at line 493 of file kjanuswidget.cpp.

◆ setIconListAllVisible()

void KJanusWidget::setIconListAllVisible ( bool state )

virtual

This function has only effect in IconList mode.

Defines how the icon list widget is displayed. By default it is the widgets in the pages that decide the minimum height of the toplevel widget. A vertical scrollbar can be used in the icon list area.

Parameters

state The visibility mode. If true, the minimum height is adjusted so that every icon in the list is visible at the same time. The vertical scrollbar will never be visible.

Definition at line 834 of file kjanuswidget.cpp.

◆ setRootIsDecorated()

void KJanusWidget::setRootIsDecorated ( bool state )

virtual

This function has only effect in TreeList mode.

This tells the widgets whether the root should be decorated. For details see TQListView::setRootIsDecorated

Parameters

state Root will be decorated if true.

Definition at line 847 of file kjanuswidget.cpp.

◆ setShowIconsInTreeList()

void KJanusWidget::setShowIconsInTreeList ( bool state )

virtual

This function has only effect in TreeList mode.

This tells the widgets whether the icons given in the addPage, addVBoxPage, addHBoxPage, or addGridPage methods should be shown in the TreeList.

Note: This method must be called before calling any of the methods which add icons to the page.

Parameters

state If true the icons are shown.

Definition at line 842 of file kjanuswidget.cpp.

◆ setSwallowedWidget()

bool KJanusWidget::setSwallowedWidget ( TQWidget * widget )

virtual

Defines the widget to be swallowed.

This method can be used several times. Only the latest defined widget will be shown.

Parameters

widget The widget to be swallowed. If 0, then an empty rectangle is displayed.

Definition at line 501 of file kjanuswidget.cpp.

◆ setTreeListAutoResize()

void KJanusWidget::setTreeListAutoResize ( bool state )

virtual

This function has only effect in TreeList mode.

Defines how the tree list is resized when the widget is resized horizontally. By default the tree list keeps its width when the widget becomes wider.

Parameters

state The resize mode. If false (default) the TreeList keeps its current width when the widget becomes wider.

Definition at line 822 of file kjanuswidget.cpp.

◆ showEvent()

void KJanusWidget::showEvent ( TQShowEvent * )

protectedvirtual

Reimplemented to handle the splitter width when the the face is TreeList.

Definition at line 894 of file kjanuswidget.cpp.

◆ showPage() [1/2]

bool KJanusWidget::showPage ( int index )

virtual

Raises the page which was added by addPage().

Parameters

index The index of the page you want to raise.

Definition at line 580 of file kjanuswidget.cpp.

◆ showPage() [2/2]

bool KJanusWidget::showPage ( TQWidget * w )

protected

Definition at line 593 of file kjanuswidget.cpp.

◆ sizeHint()

TQSize KJanusWidget::sizeHint ( void ) const

virtual

Returns the recommended size for the widget in order to be displayed properly.

Returns: The recommended size.

Definition at line 816 of file kjanuswidget.cpp.

◆ unfoldTreeList()

void KJanusWidget::unfoldTreeList ( bool persist = false )

This function has only effect in TreeList mode.

This tells the TreeList to unfold the whole tree so that all entries are visible.

If the list is empty when you call this method newly created entries will not automatically be opened. If the persist flag is set opened entries cannot be closed again, though.

Parameters

persist If true the tree always stays unfolded.

Since: 3.2

Definition at line 854 of file kjanuswidget.cpp.

◆ virtual_hook()

void KJanusWidget::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Definition at line 1186 of file kjanuswidget.cpp.

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

tdeui

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Face

Constructor & Destructor Documentation

◆ KJanusWidget()

◆ ~KJanusWidget()

Member Function Documentation

◆ aboutToShowPage

◆ activePageIndex()

◆ addButtonBelowList() [1/2]

◆ addButtonBelowList() [2/2]

◆ addGridPage() [1/2]

◆ addGridPage() [2/2]

◆ addHBoxPage() [1/2]

◆ addHBoxPage() [2/2]

◆ addPage() [1/2]

◆ addPage() [2/2]

◆ addPageWidget()

◆ addVBoxPage() [1/2]

◆ addVBoxPage() [2/2]

◆ addWidgetBelowList()

◆ eventFilter()

◆ face()

◆ FindParent()

◆ InsertTreeListItem()

◆ isValid()

◆ minimumSizeHint()

◆ pageIndex()

◆ pageTitle()

◆ pageWidget()

◆ plainPage()

◆ removePage()

◆ setFocus

◆ setFolderIcon()

◆ setIconListAllVisible()

◆ setRootIsDecorated()

◆ setShowIconsInTreeList()

◆ setSwallowedWidget()

◆ setTreeListAutoResize()

◆ showEvent()

◆ showPage() [1/2]

◆ showPage() [2/2]

◆ sizeHint()

◆ unfoldTreeList()

◆ virtual_hook()

tdeui

tdeui