Kate::ToolViewManager Class Reference

#include <toolviewmanager.h>

List of all members.


Detailed Description

Interface to the toolviewmanager.

Definition at line 32 of file toolviewmanager.h.


Public Types

enum  Position { Left, Right, Top, Bottom }

Public Member Functions

 ToolViewManager (void *toolViewManager)
virtual ~ToolViewManager ()
QWidget * createToolView (const QString &identifier, ToolViewManager::Position pos, const QPixmap &icon, const QString &text)
bool moveToolView (QWidget *widget, ToolViewManager::Position pos)
bool showToolView (QWidget *widget)
bool hideToolView (QWidget *widget)

Friends

class PrivateToolViewManager

Member Enumeration Documentation

positions

Definition at line 53 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.

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

Desctructor.

Definition at line 51 of file toolviewmanager.cpp.


Member Function Documentation

QWidget * Kate::ToolViewManager::createToolView ( const QString &  identifier,
ToolViewManager::Position  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 56 of file toolviewmanager.cpp.

bool Kate::ToolViewManager::moveToolView ( QWidget *  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.

bool Kate::ToolViewManager::showToolView ( QWidget *  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.

bool Kate::ToolViewManager::hideToolView ( QWidget *  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.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys