• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • interfaces
 

interfaces

  • KTextEditor
  • EditInterface
Public Member Functions | Protected Member Functions | Friends | List of all members
KTextEditor::EditInterface Class Referenceabstract

#include <editinterface.h>

Public Member Functions

uint editInterfaceNumber () const
 
virtual TQString text () const =0
 
virtual TQString text (uint startLine, uint startCol, uint endLine, uint endCol) const =0
 
virtual TQString textLine (uint line) const =0
 
virtual uint numLines () const =0
 
virtual uint length () const =0
 
virtual int lineLength (uint line) const =0
 
virtual bool setText (const TQString &text)=0
 
virtual bool clear ()=0
 
virtual bool insertText (uint line, uint col, const TQString &text)=0
 
virtual bool removeText (uint startLine, uint startCol, uint endLine, uint endCol)=0
 
virtual bool insertLine (uint line, const TQString &text)=0
 
virtual bool removeLine (uint line)=0
 
virtual void textChanged ()=0
 
virtual void charactersInteractivelyInserted (int, int, const TQString &)=0
 

Protected Member Functions

void setEditInterfaceDCOPSuffix (const TQCString &suffix)
 

Friends

class PrivateEditInterface
 

Detailed Description

This is the main interface for accessing and modifying text of the Document class.

Definition at line 33 of file editinterface.h.

Constructor & Destructor Documentation

◆ EditInterface()

EditInterface::EditInterface ( )

Definition at line 25 of file editinterface.cpp.

◆ ~EditInterface()

EditInterface::~EditInterface ( )
virtual

Definition at line 34 of file editinterface.cpp.

Member Function Documentation

◆ clear()

virtual bool KTextEditor::EditInterface::clear ( )
pure virtual

clears the document Warning: This will overwrite any data currently held in this view.

◆ editInterfaceNumber()

uint EditInterface::editInterfaceNumber ( ) const

Definition at line 40 of file editinterface.cpp.

◆ insertLine()

virtual bool KTextEditor::EditInterface::insertLine ( uint  line,
const TQString &  text 
)
pure virtual

Insert line(s) at the given line number.

Use insertLine(numLines(), text) to append line at end of document

◆ insertText()

virtual bool KTextEditor::EditInterface::insertText ( uint  line,
uint  col,
const TQString &  text 
)
pure virtual

Inserts text at line "line", column "col" returns true if success Use insertText(numLines(), ...) to append text at end of document.

◆ length()

virtual uint KTextEditor::EditInterface::length ( ) const
pure virtual
Returns
the number of characters in the document

◆ lineLength()

virtual int KTextEditor::EditInterface::lineLength ( uint  line) const
pure virtual
Returns
the number of characters in the line (-1 if no line "line")

◆ numLines()

virtual uint KTextEditor::EditInterface::numLines ( ) const
pure virtual
Returns
The current number of lines in the document

◆ removeLine()

virtual bool KTextEditor::EditInterface::removeLine ( uint  line)
pure virtual

Remove line(s) at the given line number.

◆ removeText()

virtual bool KTextEditor::EditInterface::removeText ( uint  startLine,
uint  startCol,
uint  endLine,
uint  endCol 
)
pure virtual

remove text at line "line", column "col" returns true if success

◆ setEditInterfaceDCOPSuffix()

void EditInterface::setEditInterfaceDCOPSuffix ( const TQCString &  suffix)
protected

Definition at line 45 of file editinterface.cpp.

◆ setText()

virtual bool KTextEditor::EditInterface::setText ( const TQString &  text)
pure virtual

Set the given text into the view.

Warning: This will overwrite any data currently held in this view.

◆ text() [1/2]

virtual TQString KTextEditor::EditInterface::text ( ) const
pure virtual

slots !!!

Returns
the complete document as a single TQString

◆ text() [2/2]

virtual TQString KTextEditor::EditInterface::text ( uint  startLine,
uint  startCol,
uint  endLine,
uint  endCol 
) const
pure virtual
Returns
a TQString

◆ textChanged()

virtual void KTextEditor::EditInterface::textChanged ( )
pure virtual

signals !!!

◆ textLine()

virtual TQString KTextEditor::EditInterface::textLine ( uint  line) const
pure virtual
Returns
All the text from the requested line.

Friends And Related Function Documentation

◆ PrivateEditInterface

friend class PrivateEditInterface
friend

Definition at line 35 of file editinterface.h.


The documentation for this class was generated from the following files:
  • editinterface.h
  • editinterface.cpp

interfaces

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

interfaces

Skip menu "interfaces"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for interfaces by doxygen 1.9.4
This website is maintained by Timothy Pearson.