KTextEditor::View Class Reference

#include </home/clem/local/src/opie/noncore/apps/tinykate/libkate/ktexteditor/ktexteditor.h>

Inheritance diagram for KTextEditor::View:

[legend]List of all members.

Public Slots
virtual void	setOverwriteMode (bool b)=0
Signals
void	contextPopupMenu (const QPoint &p)
void	scrollValueChanged (int value)
Public Member Functions
	View (Document *doc, QWidget *parent, const char *name=0)
virtual	~View ()
virtual Document *	document () const
virtual void	setCursorPosition (int line, int col, bool mark=false)=0
virtual void	getCursorPosition (int *line, int *col)=0
virtual void	insertText (const QString &text, bool mark=false)
virtual bool	isOverwriteMode () const =0
virtual void	setInternalContextMenuEnabled (bool b)
virtual bool	internalContextMenuEnabled () const
Private Attributes
ViewPrivate *	d

---

Detailed Description

The View class encapsulates a single view into the document.

Definition at line 68 of file ktexteditor.h.

---

Constructor & Destructor Documentation

KTextEditor::View::View (  Document *  doc, QWidget *  parent, const char *  name = 0 )

Create a new view to the given document. The document must be non-null.

virtual KTextEditor::View::~View (   )  [virtual]

Reimplemented in Kate::View.

---

Member Function Documentation

void KTextEditor::View::contextPopupMenu (  const QPoint &  p  )  [signal]

Connect here when you want to implement a custom popup menu.

virtual Document* KTextEditor::View::document (   )  const [virtual]

Acessor to the parent Document. Referenced by TinyKate::slotClose(), TinyKate::slotSave(), TinyKate::slotSaveAs(), and View::insertText().

virtual void KTextEditor::View::getCursorPosition (  int *  line, int *  col )  [pure virtual]

Implemented in KateView. Referenced by View::insertText().

virtual void KTextEditor::View::insertText (  const QString &  text, bool  mark = false )  [virtual]

Inserts text at the current cursor position into the document Reimplemented in KateView.

virtual bool KTextEditor::View::internalContextMenuEnabled (   )  const [virtual]

virtual bool KTextEditor::View::isOverwriteMode (   )  const [pure virtual]

Overwrite mode is where the char under the cursor is replaced with the char typed by the user Implemented in KateView.

void KTextEditor::View::scrollValueChanged (  int  value  )  [signal]

Connect here if you want to track the scrolling within the editor. This allows you to add specialised borders that displays extra data about particular lines such as breakpoints etc.

virtual void KTextEditor::View::setCursorPosition (  int  line, int  col, bool  mark = false )  [pure virtual]

Implemented in KateView.

virtual void KTextEditor::View::setInternalContextMenuEnabled (  bool  b  )  [virtual]

You should reimplement this method. If the internal popupmenu property is enabled, then the implementation is free to handle/use/implement/show a context popupmenu ( see also KContextMenuManager class in kdeui ). If disabled, then the implementation should emit the contextPopupMenu signal.

virtual void KTextEditor::View::setOverwriteMode (  bool  b  )  [pure virtual, slot]

Implemented in KateView.

---

Member Data Documentation

ViewPrivate* KTextEditor::View::d [private]

Definition at line 125 of file ktexteditor.h. Referenced by View::document(), View::internalContextMenuEnabled(), View::setInternalContextMenuEnabled(), and View::~View().

---

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

• noncore/apps/tinykate/libkate/ktexteditor/ktexteditor.h

---