KTextEditor::ViewBarContainer Class Reference

#include <containerinterface.h>

Public Types
enum	Position { LeftBar =0, TopBar =1, RightBar =2, BottomBar =3 }

Public Member Functions
	ViewBarContainer ()
virtual	~ViewBarContainer ()
virtual void	addViewBarToLayout (View *view, QWidget *bar, enum Position position)=0
virtual void	deleteViewBarForView (View *view, enum Position position)=0
virtual QWidget *	getViewBarParent (View *view, enum Position position)=0
virtual void	hideViewBarForView (View *view, enum Position position)=0
virtual void	showViewBarForView (View *view, enum Position position)=0

Detailed Description

An application providing a centralized place for horizontal view bar containers (eg search bars) has to implement this.

Since

4.2

Definition at line 269 of file containerinterface.h.

Member Enumeration Documentation

enum KTextEditor::ViewBarContainer::Position

Enumerator
LeftBar
TopBar
RightBar
BottomBar

Definition at line 272 of file containerinterface.h.

Constructor & Destructor Documentation

ViewBarContainer::ViewBarContainer

(

)

Constructor.

Definition at line 240 of file ktexteditor.cpp.

ViewBarContainer::~ViewBarContainer ( )

virtual

Virtual destructor.

Definition at line 243 of file ktexteditor.cpp.

Member Function Documentation

virtual void KTextEditor::ViewBarContainer::addViewBarToLayout ( View *  view, QWidget *  bar, enum Position  position  )

pure virtual

It is advisable to store only QPointers to the bar and its children in the caller after this point.

The container may at any point delete the bar, eg if the container is destroyed The caller has to ensure that bar->parentWidget() is the widget returned by the previous function

virtual void KTextEditor::ViewBarContainer::deleteViewBarForView ( View *  view, enum Position  position  )

pure virtual

The view should not delete the bar by itself, but tell the container to delete the bar.

This is for instance useful, in the destructor of the view. The bar must not life longer than the view.

virtual QWidget* KTextEditor::ViewBarContainer::getViewBarParent ( View *  view, enum Position  position  )

pure virtual

At this point the views parent window has to be already set, so this has to be called after any reparentings eg.

: The implementation in Kate uses view->window() to determine where to place of the container if 0 is returned, the view has to handle the bar internally

virtual void KTextEditor::ViewBarContainer::hideViewBarForView ( View *  view, enum Position  position  )

pure virtual

virtual void KTextEditor::ViewBarContainer::showViewBarForView ( View *  view, enum Position  position  )

pure virtual

show hide a view bar.

The implementor of this interface has to take care for not showing the bars of unfocused views, if needed

---

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

• containerinterface.h
• ktexteditor.cpp