KateViewBar Class Reference

#include <kateviewhelpers.h>

Inheritance diagram for KateViewBar:

List of all members.

Public Slots
void	hideCurrentBarWidget ()
Public Member Functions
	KateViewBar (bool external, KTextEditor::ViewBarContainer::Position pos, QWidget *parent, KateView *view)
void	addBarWidget (KateViewBarWidget *newBarWidget)
void	addPermanentBarWidget (KateViewBarWidget *barWidget)
bool	hasBarWidget (KateViewBarWidget *barWidget) const
bool	hasPermanentWidget (KateViewBarWidget *barWidget) const
void	removeBarWidget (KateViewBarWidget *barWidget)
void	removePermanentBarWidget (KateViewBarWidget *barWidget)
void	showBarWidget (KateViewBarWidget *barWidget)
Protected Member Functions
virtual void	hideEvent (QHideEvent *event)
virtual void	keyPressEvent (QKeyEvent *event)

---

Detailed Description

Definition at line 267 of file kateviewhelpers.h.

---

Constructor & Destructor Documentation

KateViewBar::KateViewBar	(	bool	external,
		KTextEditor::ViewBarContainer::Position	pos,
		QWidget *	parent,
		KateView *	view
	)

Definition at line 1863 of file kateviewhelpers.cpp.

---

Member Function Documentation

void KateViewBar::addBarWidget

(

KateViewBarWidget *

newBarWidget

)

Adds a widget to this viewbar.

Widget is initially invisible, you should call showBarWidget, to show it. Several widgets can be added to the bar, but only one can be visible

Definition at line 1876 of file kateviewhelpers.cpp.

void KateViewBar::addPermanentBarWidget

(

KateViewBarWidget *

barWidget

)

Adds widget that will be always shown in the viewbar.

After adding permanent widget viewbar is immediately shown. ViewBar with permanent widget won't hide itself until permanent widget is removed. OTOH showing/hiding regular barWidgets will work as usual (they will be shown above permanent widget)

If permanent widget already exists, new one replaces old one Old widget is not deleted, caller can do it if it wishes

Definition at line 1895 of file kateviewhelpers.cpp.

bool KateViewBar::hasBarWidget

(

KateViewBarWidget *

barWidget

)

const

Returns:

if viewbar has widget barWidget

Definition at line 1951 of file kateviewhelpers.cpp.

bool KateViewBar::hasPermanentWidget

(

KateViewBarWidget *

barWidget

)

const

Returns:

if viewbar has permanent widget barWidget

Definition at line 1929 of file kateviewhelpers.cpp.

void KateViewBar::hideCurrentBarWidget

(

)

[slot]

Hides currently shown bar widget.

Definition at line 1956 of file kateviewhelpers.cpp.

void KateViewBar::hideEvent

(

QHideEvent *

event

)

[protected, virtual]

Definition at line 2000 of file kateviewhelpers.cpp.

void KateViewBar::keyPressEvent

(

QKeyEvent *

event

)

[protected, virtual]

Definition at line 1990 of file kateviewhelpers.cpp.

void KateViewBar::removeBarWidget

(

KateViewBarWidget *

barWidget

)

Removes a widget from this viewbar.

Removing a widget makes sense if it takes a lot of space vertically, because we use a QStackedWidget to maintain the same height for all widgets in the viewbar.

Definition at line 1890 of file kateviewhelpers.cpp.

void KateViewBar::removePermanentBarWidget

(

KateViewBarWidget *

barWidget

)

Removes permanent bar widget from viewbar.

If no other viewbar widgets are shown, viewbar gets hidden.

barWidget is not deleted, caller must do it if it wishes

Definition at line 1910 of file kateviewhelpers.cpp.

void KateViewBar::showBarWidget

(

KateViewBarWidget *

barWidget

)

Shows barWidget that was previously added with addBarWidget.

See also:

hideCurrentBarWidget

Definition at line 1934 of file kateviewhelpers.cpp.

---

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

• kateviewhelpers.h
• kateviewhelpers.cpp