KateMDI::MainWindow Class Reference

#include <katemdi.h>

Inheritance diagram for KateMDI::MainWindow:

[legend]

List of all members.

Public Slots
void	setSidebarsVisible (bool visible)
Public Member Functions
QWidget *	centralWidget () const
ToolView *	createToolView (const QString &identifier, KMultiTabBar::KMultiTabBarPosition pos, const QPixmap &icon, const QString &text)
void	finishRestore ()
bool	hideToolView (ToolView *widget)
	MainWindow (QWidget *parentWidget=0, const char *name=0)
bool	moveToolView (ToolView *widget, KMultiTabBar::KMultiTabBarPosition pos)
void	saveSession (KConfig *config, const QString &group)
void	setToolViewStyle (KMultiTabBar::KMultiTabBarStyle style)
bool	showToolView (ToolView *widget)
bool	sidebarsVisible () const
void	startRestore (KConfig *config, const QString &group)
ToolView *	toolView (const QString &identifier) const
KMultiTabBar::KMultiTabBarStyle	toolViewStyle () const
virtual	~MainWindow ()
Protected Member Functions
void	toolViewDeleted (ToolView *widget)

---

Detailed Description

Definition at line 248 of file katemdi.h.

---

Constructor & Destructor Documentation

KateMDI::MainWindow::MainWindow	(	QWidget *	parentWidget = 0,
		const char *	name = 0
	)

Constructor.

Definition at line 662 of file katemdi.cpp.

KateMDI::MainWindow::~MainWindow

(

)

[virtual]

Destructor.

Definition at line 699 of file katemdi.cpp.

---

Member Function Documentation

QWidget * KateMDI::MainWindow::centralWidget

(

)

const

central widget ;) use this as parent for your content this widget will get focus if a toolview is hidden

Returns:

central widget

Definition at line 712 of file katemdi.cpp.

ToolView * KateMDI::MainWindow::createToolView	(	const QString &	identifier,
		KMultiTabBar::KMultiTabBarPosition	pos,
		const QPixmap &	icon,
		const QString &	text
	)

add a given widget to the given sidebar if possible, name is very important

Parameters:

	identifier	unique identifier for this toolview
	pos	position for the toolview, if we are in session restore, this is only a preference
	icon	icon to use for the toolview
	text	text to use in addition to icon

Returns:

created toolview on success or 0

Definition at line 717 of file katemdi.cpp.

void KateMDI::MainWindow::finishRestore

(

)

finish the restore

Definition at line 898 of file katemdi.cpp.

bool KateMDI::MainWindow::hideToolView

(

ToolView *

widget

)

hide given toolview, discarded while session restore

Parameters:

widget

toolview to hide

Returns:

success

Definition at line 837 of file katemdi.cpp.

bool KateMDI::MainWindow::moveToolView	(	ToolView *	widget,
		KMultiTabBar::KMultiTabBarPosition	pos
	)

modifiers for existing toolviews

move a toolview around

Parameters:

	widget	toolview to move
	pos	position to move too, during session restore, only preference

Returns:

success

Definition at line 808 of file katemdi.cpp.

void KateMDI::MainWindow::saveSession	(	KConfig *	config,
		const QString &	group
	)

save the current session config to given object and group

Parameters:

	config	config object to use
	group	config group to use

Definition at line 931 of file katemdi.cpp.

void KateMDI::MainWindow::setSidebarsVisible

(

bool

visible

)

[slot]

set the sidebars' visibility to visible.

If false, the sidebars are always hidden. Usually you do not have to call this because the user can set this in the menu.

Parameters:

visible

sidebars visibility

Definition at line 763 of file katemdi.cpp.

void KateMDI::MainWindow::setToolViewStyle

(

KMultiTabBar::KMultiTabBarStyle

style

)

set the toolview's tabbar style.

Parameters:

style

the tabbar style.

Definition at line 794 of file katemdi.cpp.

bool KateMDI::MainWindow::showToolView

(

ToolView *

widget

)

show given toolview, discarded while session restore

Parameters:

widget

toolview to show

Returns:

success

Definition at line 825 of file katemdi.cpp.

bool KateMDI::MainWindow::sidebarsVisible

(

)

const

get the sidebars' visibility.

Returns:

false, if the sidebars' visibility is forced hidden, otherwise true

Definition at line 789 of file katemdi.cpp.

void KateMDI::MainWindow::startRestore	(	KConfig *	config,
		const QString &	group
	)

session saving and restore stuff

start the restore

Parameters:

	config	config object to use
	group	config group to use

Definition at line 849 of file katemdi.cpp.

ToolView * KateMDI::MainWindow::toolView

(

const QString &

identifier

)

const

give you handle to toolview for the given name, 0 if no toolview around

Parameters:

identifier

toolview name

Returns:

toolview if existing, else 0

Definition at line 741 of file katemdi.cpp.

void KateMDI::MainWindow::toolViewDeleted

(

ToolView *

widget

)

[protected]

called by toolview destructor

Parameters:

widget

toolview which is destroyed

Definition at line 746 of file katemdi.cpp.

KMultiTabBar::KMultiTabBarStyle KateMDI::MainWindow::toolViewStyle

(

)

const

get the toolview's tabbar style.

Call this before startRestore(), otherwise you overwrite the usersettings.

Returns:

toolview's tabbar style

Definition at line 802 of file katemdi.cpp.

---

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

• katemdi.h
• katemdi.cpp