• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KTextEditor

KTextEditor::ViewBarContainer

KTextEditor::ViewBarContainer Class Reference

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

#include <containerinterface.h>

List of all members.


Public Types

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

Public Member Functions

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
 ViewBarContainer ()
virtual ~ViewBarContainer ()

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 302 of file ktexteditor.cpp.

ViewBarContainer::~ViewBarContainer (  )  [virtual]

Virtual destructor.

Definition at line 305 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 it's 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

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal