Kate::ToolViewManager Class Reference

#include <toolviewmanager.h>

Inherits TQObject.

Public Types
enum	Position { Left , Right , Top , Bottom }

Public Member Functions
	ToolViewManager (void *toolViewManager)
virtual	~ToolViewManager ()
TQWidget *	createToolView (const TQString &identifier, ToolViewManager::Position pos, const TQPixmap &icon, const TQString &text)
bool	moveToolView (TQWidget *widget, ToolViewManager::Position pos)
bool	showToolView (TQWidget *widget)
bool	hideToolView (TQWidget *widget)

Friends
class	PrivateToolViewManager

Detailed Description

Interface to the toolviewmanager.

Definition at line 32 of file toolviewmanager.h.

Member Enumeration Documentation

Position

enum Kate::ToolViewManager::Position

positions

Definition at line 53 of file toolviewmanager.h.

Constructor & Destructor Documentation

ToolViewManager()

Kate::ToolViewManager::ToolViewManager

(

void *

toolViewManager

)

Construtor, should not interest, internal usage.

Definition at line 45 of file toolviewmanager.cpp.

~ToolViewManager()

Kate::ToolViewManager::~ToolViewManager ( )

virtual

Desctructor.

Definition at line 51 of file toolviewmanager.cpp.

Member Function Documentation

createToolView()

TQWidget * Kate::ToolViewManager::createToolView	(	const TQString &	identifier,
		ToolViewManager::Position	pos,
		const TQPixmap &	icon,
		const TQString &	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 56 of file toolviewmanager.cpp.

hideToolView()

bool Kate::ToolViewManager::hideToolView

(

TQWidget *

widget

)

Hide the toolview.

Parameters

widget

to hide, widget given must be widget constructed by createToolView

Returns

bool success

Definition at line 77 of file toolviewmanager.cpp.

moveToolView()

bool Kate::ToolViewManager::moveToolView	(	TQWidget *	widget,
		ToolViewManager::Position	pos
	)

Move the toolview.

Parameters

widget	to show, widget given must be widget constructed by createToolView
pos	position to move widget to

Returns

bool success

Definition at line 61 of file toolviewmanager.cpp.

showToolView()

bool Kate::ToolViewManager::showToolView

(

TQWidget *

widget

)

Show the toolview.

Parameters

widget

to show, widget given must be widget constructed by createToolView

Returns

bool success

Definition at line 69 of file toolviewmanager.cpp.

Friends And Related Function Documentation

PrivateToolViewManager

friend class PrivateToolViewManager

friend

Definition at line 34 of file toolviewmanager.h.

---

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

• toolviewmanager.h
• toolviewmanager.cpp