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

KTextEditor

KTextEditor::View

KTextEditor::View Class Reference

A text widget with KXMLGUIClient that represents a Document. More...

#include <view.h>

Inheritance diagram for KTextEditor::View:

Inheritance graph
[legend]

List of all members.


Public Types

enum  EditMode { EditInsert = 0, EditOverwrite = 1 }

Signals

void contextMenuAboutToShow (KTextEditor::View *view, QMenu *menu)
void cursorPositionChanged (KTextEditor::View *view, const KTextEditor::Cursor &newPosition)
void focusIn (KTextEditor::View *view)
void focusOut (KTextEditor::View *view)
void horizontalScrollPositionChanged (KTextEditor::View *view)
void informationMessage (KTextEditor::View *view, const QString &message)
void mousePositionChanged (KTextEditor::View *view, const KTextEditor::Cursor &newPosition)
void selectionChanged (KTextEditor::View *view)
void textInserted (KTextEditor::View *view, const KTextEditor::Cursor &position, const QString &text)
void verticalScrollPositionChanged (KTextEditor::View *view, const KTextEditor::Cursor &newPos)
void viewEditModeChanged (KTextEditor::View *view, enum KTextEditor::View::EditMode mode)
void viewModeChanged (KTextEditor::View *view)

Public Member Functions

virtual bool blockSelection () const =0
virtual QMenu * contextMenu () const =0
virtual Cursor cursorPosition () const =0
virtual QPoint cursorPositionCoordinates () const =0
virtual Cursor cursorPositionVirtual () const =0
virtual QPoint cursorToCoordinate (const KTextEditor::Cursor &cursor) const =0
virtual QMenu * defaultContextMenu (QMenu *menu=0L) const =0
virtual Document * document () const =0
virtual bool insertText (const QString &text)
bool isActiveView () const
virtual bool mouseTrackingEnabled () const =0
virtual bool removeSelection ()=0
virtual bool removeSelectionText ()=0
virtual bool selection () const =0
virtual const Range & selectionRange () const =0
virtual QString selectionText () const =0
virtual bool setBlockSelection (bool on)=0
virtual void setContextMenu (QMenu *menu)=0
virtual bool setCursorPosition (Cursor position)=0
virtual bool setMouseTrackingEnabled (bool enable)=0
virtual bool setSelection (const Cursor &position, int length, bool wrap=true)
virtual bool setSelection (const Range &range)=0
 View (QWidget *parent)
virtual enum EditMode viewEditMode () const =0
virtual QString viewMode () const =0
virtual ~View ()

Detailed Description

A text widget with KXMLGUIClient that represents a Document.

Topics:

  • Introduction
  • Merging the View's GUI
  • Text Selection
  • Cursor Positions
  • Mouse Tracking
  • Edit Modes
  • View Extension Interfaces

Introduction

The View class represents a single view of a KTextEditor::Document, get the document on which the view operates with document(). A view provides both the graphical representation of the text and the KXMLGUIClient for the actions. The view itself does not provide text manipulation, use the methods from the Document instead. The only method to insert text is insertText(), which inserts the given text at the current cursor position and emits the signal textInserted().

Usually a view is created by using Document::createView(). Furthermore a view can have a context menu. Set it with setContextMenu() and get it with contextMenu().

Merging the View's GUI

A View is derived from the class KXMLGUIClient, so its GUI elements (like menu entries and toolbar items) can be merged into the application's GUI (or into a KXMLGUIFactory) by calling
 // view is of type KTextEditor::View*
 mainWindow()->guiFactory()->addClient( view );
You can add only one view as client, so if you have several views, you first have to remove the current view, and then add the new one, like this
 mainWindow()->guiFactory()->removeClient( currentView );
 mainWindow()->guiFactory()->addClient( newView );

Text Selection

As the view is a graphical text editor it provides normal and block text selection. You can check with selection() whether a selection exists. removeSelection() will remove the selection without removing the text, whereas removeSelectionText() also removes both, the selection and the selected text. Use selectionText() to get the selected text and setSelection() to specify the selected textrange. The signal selectionChanged() is emitted whenever the selecteion changed.

Cursor Positions

A view has one Cursor which represents a line/column tuple. Two different kinds of cursor positions are supported: first is the real cursor position where a tab character only counts one character. Second is the virtual cursor position, where a tab character counts as many spaces as defined. Get the real position with cursorPosition() and the virtual position with cursorPositionVirtual(). Set the real cursor position with setCursorPosition(). You can even get the screen coordinates of the current cursor position in pixel by using cursorPositionCoordinates(). The signal cursorPositionChanged() is emitted whenever the cursor position changed.

Mouse Tracking

It is possible to get notified via the signal mousePositionChanged() for mouse move events, if mouseTrackingEnabled() returns true. Mouse tracking can be turned on/off by calling setMouseTrackingEnabled(). If an editor implementation does not support mouse tracking, mouseTrackingEnabled() will always return false.

Edit Modes

A view supports several edit modes (EditMode). Common edit modes are insert-mode (INS) and overwrite-mode (OVR). Which edit modes the editor supports depends on the implementation, another well-known mode is the command-mode for example in vim and yzis. The getter viewMode() returns a string like INS or OVR and is represented in the user interface for example in the status bar. Further you can get the edit mode as enum by using viewEditMode(). Whenever the edit mode changed the signals viewModeChanged() and viewEditModeChanged() are emitted.

View Extension Interfaces

A simple view represents the text of a Document and provides a text cursor, text selection, edit modes etc. Advanced concepts like code completion and text hints are defined in the extension interfaces. An KTextEditor implementation does not need to support all the extensions. To implement the interfaces multiple inheritance is used.

More information about interfaces for the view can be found in View Extension Interfaces.

See also:
KTextEditor::Document, KTextEditor::TemplateInterface, KTextEditor::CodeCompletionInterface, KTextEditor::SessionConfigInterface, KTextEditor::TemplateInterface, KXMLGUIClient
Author:
Christoph Cullmann <cullmann@kde.org>

Definition at line 141 of file view.h.


Member Enumeration Documentation

enum KTextEditor::View::EditMode

Possible edit modes.

These correspond to various modes the text editor might be in.

Enumerator:
EditInsert  Insert mode.

Characters will be added.

EditOverwrite  Overwrite mode.

Characters will be replaced.

Definition at line 200 of file view.h.


Constructor & Destructor Documentation

View::View ( QWidget *  parent  ) 

Constructor.

Create a view attached to the widget parent.

Parameters:
parent parent widget
See also:
Document::createView()

Definition at line 260 of file ktexteditor.cpp.

View::~View (  )  [virtual]

Virtual destructor.

Definition at line 265 of file ktexteditor.cpp.


Member Function Documentation

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

Get the status of the selection mode.

true indicates that block selection mode is on. If this is true, selections applied via the SelectionInterface are handled as block selections and the Copy&Paste functions work on rectangular blocks of text rather than normal.

Returns:
true, if block selection mode is enabled, otherwise false
See also:
setBlockSelection()

virtual QMenu* KTextEditor::View::contextMenu (  )  const [pure virtual]

Get the context menu for this view.

The return value can be NULL if no context menu object was set.

Returns:
context menu object
See also:
setContextMenu()

void KTextEditor::View::contextMenuAboutToShow ( KTextEditor::View *  view,
QMenu *  menu 
) [signal]

Signal which is emitted immediately prior to showing the current context menu.

virtual Cursor KTextEditor::View::cursorPosition (  )  const [pure virtual]

Get the view's current cursor position.

A TAB character is handeled as only one character.

Returns:
current cursor position
See also:
setCursorPosition()

void KTextEditor::View::cursorPositionChanged ( KTextEditor::View *  view,
const KTextEditor::Cursor &  newPosition 
) [signal]

This signal is emitted whenever the view's cursor position changed.

Parameters:
view view which emitted the signal
newPosition new position of the cursor (Kate will pass the real cursor potition, not the virtual)
See also:
cursorPosition(), cursorPositionVirtual()

virtual QPoint KTextEditor::View::cursorPositionCoordinates (  )  const [pure virtual]

Get the screen coordinates (x/y) of the cursor position in pixels.

Returns:
cursor screen coordinates

virtual Cursor KTextEditor::View::cursorPositionVirtual (  )  const [pure virtual]

Get the current virtual cursor position, virtual means the tabulator character (TAB) counts multiple characters, as configured by the user (e.g.

one TAB is 8 spaces). The virtual cursor position provides access to the user visible values of the current cursor position.

Returns:
virtual cursor position
See also:
cursorPosition()

virtual QPoint KTextEditor::View::cursorToCoordinate ( const KTextEditor::Cursor &  cursor  )  const [pure virtual]

Get the screen coordinates (x, y) of the supplied cursor relative to the view widget in pixels.

Thus, 0,0 represents the top left hand of the view widget.

Parameters:
cursor cursor to determine coordinate for.
Returns:
cursor screen coordinates relative to the view widget

virtual QMenu* KTextEditor::View::defaultContextMenu ( QMenu *  menu = 0L  )  const [pure virtual]

Populate menu with default text editor actions.

If menu is null, a menu will be created with the view as its parent.

Note:
to use this menu, you will next need to call setContextMenu(), as this does not assign the new context menu.
Parameters:
menu the menu to be populated, or null to create a new menu
Returns:
the menu, whether created or passed initially

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

Get the view's document, that means the view is a view of the returned document.

Returns:
the view's document

void KTextEditor::View::focusIn ( KTextEditor::View *  view  )  [signal]

This signal is emitted whenever the view gets the focus.

Parameters:
view view which gets focus
See also:
focusOut()

void KTextEditor::View::focusOut ( KTextEditor::View *  view  )  [signal]

This signal is emitted whenever the view looses the focus.

Parameters:
view view which looses focus
See also:
focusIn()

void KTextEditor::View::horizontalScrollPositionChanged ( KTextEditor::View *  view  )  [signal]

This signal should be emitted whenever the view is scrolled horizontally.

Parameters:
view view which emitted the signal

void KTextEditor::View::informationMessage ( KTextEditor::View *  view,
const QString &  message 
) [signal]

This signal is emitted whenever the view wants to display a information message.

The message can be displayed in the status bar for example.

Parameters:
view view which sends out information
message information message

bool View::insertText ( const QString &  text  )  [virtual]

This is a convenience function which inserts text at the view's current cursor position.

You do not necessarily need to reimplement it, except you want to do some special things.

Parameters:
text Text to be inserted
Returns:
true on success of insertion, otherwise false
See also:
textInserted()

Definition at line 203 of file ktexteditor.cpp.

bool View::isActiveView (  )  const

Check whether this view is the document's active view.

This is equal to the code:

 document()->activeView() == view

Definition at line 180 of file ktexteditor.cpp.

void KTextEditor::View::mousePositionChanged ( KTextEditor::View *  view,
const KTextEditor::Cursor &  newPosition 
) [signal]

This signal is emitted whenever the position of the mouse changes over this view.

If the mouse moves off the view, an invalid cursor position should be emitted, i.e. Cursor::invalid().

Note:
If mouseTrackingEnabled() returns false, this signal is never emitted.
Parameters:
view view which emitted the signal
newPosition new position of the mouse or Cursor::invalid(), if the mouse moved out of the view.
See also:
mouseTrackingEnabled()

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

Check, whether mouse tracking is enabled.

Mouse tracking is required to have the signal mousePositionChanged() emitted.

Returns:
true, if mouse tracking is enabled, otherwise false
See also:
setMouseTrackingEnabled(), mousePositionChanged()

virtual bool KTextEditor::View::removeSelection (  )  [pure virtual]

Remove the view's current selection, without deleting the selected text.

Returns:
true on success, otherwise false
See also:
removeSelectionText()

virtual bool KTextEditor::View::removeSelectionText (  )  [pure virtual]

Remove the view's current selection including the selected text.

Returns:
true on success, otherwise false
See also:
removeSelection()

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

Query the view whether it has selected text, i.e.

whether a selection exists.

Returns:
true if a text selection exists, otherwise false
See also:
setSelection(), selectionRange()

void KTextEditor::View::selectionChanged ( KTextEditor::View *  view  )  [signal]

This signal is emitted whenever the view's selection changes.

Note:
If the mode switches from block selection to normal selection or vice versa this signal should also be emitted.
Parameters:
view view in which the selection changed
See also:
selection(), selectionRange(), selectionText()

virtual const Range& KTextEditor::View::selectionRange (  )  const [pure virtual]

Get the range occupied by the current selection.

Returns:
selection range, valid only if a selection currently exists.
See also:
setSelection()

virtual QString KTextEditor::View::selectionText (  )  const [pure virtual]

Get the view's selected text.

Returns:
the selected text
See also:
setSelection()

virtual bool KTextEditor::View::setBlockSelection ( bool  on  )  [pure virtual]

Set block selection mode to state on.

Parameters:
on if true, block selection mode is turned on, otherwise off
Returns:
true on success, otherwise false
See also:
blockSelection()

virtual void KTextEditor::View::setContextMenu ( QMenu *  menu  )  [pure virtual]

Set a context menu for this view to menu.

Note:
any previously assigned menu is not deleted. If you are finished with the previous menu, you may delete it.
Parameters:
menu new context menu object for this view
See also:
contextMenu()

virtual bool KTextEditor::View::setCursorPosition ( Cursor  position  )  [pure virtual]

Set the view's new cursor to position.

A TAB character is handeled as only on character.

Parameters:
position new cursor position
Returns:
true on success, otherwise false
See also:
cursorPosition()

virtual bool KTextEditor::View::setMouseTrackingEnabled ( bool  enable  )  [pure virtual]

Try to enable or disable mouse tracking according to enable.

The return value contains the state of mouse tracking after the request. Mouse tracking is required to have the mousePositionChanged() signal emitted.

Note:
Implementation Notes: An implementation is not forced to support this, and should always return false if it does not have support.
Parameters:
enable if true, try to enable mouse tracking, otherwise disable it.
Returns:
the current state of mouse tracking
See also:
mouseTrackingEnabled(), mousePositionChanged()

bool View::setSelection ( const Cursor &  position,
int  length,
bool  wrap = true 
) [virtual]

This is an overloaded member function, provided for convenience, it differs from the above function only in what argument(s) it accepts.

An existing old selection will be discarded. If possible you should reimplement the default implementation with a more efficient one.

Parameters:
position start or end position of the selection, depending on the length parameter
length if >0 position defines the start of the selection, if <0 position specifies the end
wrap if false the selection does not wrap lines and reaches only to start/end of the cursors line. Default: true
See also:
selectionRange(), selection()
Todo:
rodda - is this really needed? it can now be accomplished with SmartCursor::advance()

Definition at line 185 of file ktexteditor.cpp.

virtual bool KTextEditor::View::setSelection ( const Range &  range  )  [pure virtual]

Set the view's selection to the range selection.

The old selection will be discarded.

Parameters:
range the range of the new selection
Returns:
true on success, otherwise false (e.g. when the cursor range is invalid)
See also:
selectionRange(), selection()

void KTextEditor::View::textInserted ( KTextEditor::View *  view,
const KTextEditor::Cursor &  position,
const QString &  text 
) [signal]

This signal is emitted from view whenever the users inserts text at position, that means the user typed/pasted text.

Parameters:
view view in which the text was inserted
position position where the text was inserted
text the text the user has typed into the editor
See also:
insertText()

void KTextEditor::View::verticalScrollPositionChanged ( KTextEditor::View *  view,
const KTextEditor::Cursor &  newPos 
) [signal]

This signal should be emitted whenever the view is scrolled vertically.

Parameters:
view view which emitted the signal
newPos the new scroll position

virtual enum EditMode KTextEditor::View::viewEditMode (  )  const [pure virtual]

Get the view's current edit mode.

The current mode can be insert mode, replace mode or any other the editor supports, e.g. a vim like command mode. If in doubt return EditInsert.

Returns:
the current edit mode of this view
See also:
viewEditModeChanged()

void KTextEditor::View::viewEditModeChanged ( KTextEditor::View *  view,
enum KTextEditor::View::EditMode  mode 
) [signal]

This signal is emitted whenever the view's edit mode changed from either EditInsert to EditOverwrite or vice versa.

Parameters:
view view which changed its edit mode
mode new edit mode
See also:
viewEditMode()

virtual QString KTextEditor::View::viewMode (  )  const [pure virtual]

Get the current view mode/state.

This can be used to visually indicate the view's current mode, for example INSERT mode, OVERWRITE mode or COMMAND mode - or whatever other edit modes are supported. The string should be translated (i18n), as this is a user aimed representation of the view state, which should be shown in the GUI, for example in the status bar.

Returns:
See also:
viewModeChanged()

void KTextEditor::View::viewModeChanged ( KTextEditor::View *  view  )  [signal]

This signal is emitted whenever the view mode of view changes.

Parameters:
view the view which changed its mode
See also:
viewMode()


The documentation for this class was generated from the following files:
  • view.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