kate Library API Documentation

Kate::ToolViewManager Class Reference

Interface to the toolviewmanager. More...

#include <toolviewmanager.h>

Inheritance diagram for Kate::ToolViewManager:

QObject List of all members.

Public Member Functions

 ToolViewManager (void *toolViewManager)
virtual ~ToolViewManager ()
KMDI::ToolViewAccessor * addToolView (KDockWidget::DockPosition position, QWidget *widget, const QPixmap &icon, const QString &sname, const QString &tabToolTip=0, const QString &tabCaption=0)
bool removeToolView (QWidget *widget)
bool removeToolView (KMDI::ToolViewAccessor *accessor)
bool showToolView (QWidget *widget)
bool showToolView (KMDI::ToolViewAccessor *accessor)
bool hideToolView (QWidget *widget)
bool hideToolView (KMDI::ToolViewAccessor *accessor)

Friends

class PrivateToolViewManager

Detailed Description

Interface to the toolviewmanager.

Definition at line 36 of file toolviewmanager.h.


Constructor & Destructor Documentation

Kate::ToolViewManager::ToolViewManager void *  toolViewManager  ) 
 

Construtor, should not interest, internal usage.

Definition at line 45 of file toolviewmanager.cpp.

References PrivateToolViewManager.

Kate::ToolViewManager::~ToolViewManager  )  [virtual]
 

Desctructor.

Definition at line 51 of file toolviewmanager.cpp.


Member Function Documentation

KMDI::ToolViewAccessor * Kate::ToolViewManager::addToolView KDockWidget::DockPosition  position,
QWidget widget,
const QPixmap icon,
const QString sname,
const QString tabToolTip = 0,
const QString tabCaption = 0
 

Add a toolview.

Parameters:
position position where to dock
widget widget to add
icon icon for the dock button
sname unique name (used for example for hide/show)
tabToolTip tooltip for the tab
tabCaption caption for the tab
Returns:
KMDI::ToolViewAccessor * generated accessor

Definition at line 56 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::removeToolView QWidget widget  ) 
 

Remove a toolview.

Parameters:
toolview widget to remove
Returns:
bool success

Definition at line 61 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::removeToolView KMDI::ToolViewAccessor *  accessor  ) 
 

Remove a toolview.

Parameters:
toolview to remove
Returns:
bool success

Definition at line 66 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::showToolView QWidget widget  ) 
 

Show the toolview.

Parameters:
widget to show
Returns:
bool success

Definition at line 71 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::showToolView KMDI::ToolViewAccessor *  accessor  ) 
 

Show the toolview.

Parameters:
toolview to show
Returns:
bool success

Definition at line 76 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::hideToolView QWidget widget  ) 
 

Hide the toolview.

Parameters:
widget to hide
Returns:
bool success

Definition at line 81 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::hideToolView KMDI::ToolViewAccessor *  accessor  ) 
 

Hide the toolview.

Parameters:
toolview to hide
Returns:
bool success

Definition at line 86 of file toolviewmanager.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 13 19:27:54 2006 by doxygen 1.4.3 written by Dimitri van Heesch, © 1997-2003