Source: ktexteditor/editdcopinterface.h
|
|
|
|
#ifndef EDIT_DCOP_INTERFACE_H
#define EDIT_DCOP_INTERFACE_H
#include
#include
#include
#include
//#include "editdcopinterface.moc"
namespace KTextEditor
{
class EditInterface;
/**
This is the main interface to the @ref EditInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref EditInterface.
@author Ian Reinhart Geiser
*/
class EditDCOPInterface : virtual public DCOPObject
{
K_DCOP
public:
/**
Construct a new interface object for the text editor.
@param ParentEditInterface - The parent @ref EditInterface object
that will provide us with the functions for the interface.
*/
EditDCOPInterface( EditInterface *Parent, const char *name );
/**
Destructor
Cleans up the object.
**/
virtual ~EditDCOPInterface();
k_dcop:
/**
* @return the complete document as a single QString
*/
virtual QString text ();
/**
* @return All the text from the requested line.
*/
virtual QString textLine ( uint line );
/**
* @return The current number of lines in the document
*/
virtual int numLines ();
/**
* @return the number of characters in the document
*/
virtual int length ();
/**
* Set the given text into the view.
* Warning: This will overwrite any data currently held in this view.
*/
virtual void setText (const QString &text );
/**
* Inserts text at line "line", column "col"
* returns true if success
*/
virtual bool insertText ( uint line, uint col, const QString &text );
/**
* remove text at line "line", column "col"
* returns true if success
*/
virtual bool removeText ( uint startLine, uint startCol, uint endLine, uint endCol) ;
/**
* Insert line(s) at the given line number.
*/
virtual bool insertLine ( uint line, const QString &text );
/**
* Insert line(s) at the given line number.
* If only one line is in the current document, removeLine will fail (return false)
*/
virtual bool removeLine ( uint line );
private:
EditInterface *m_parent;
};
};
#endif
Generated by: caleb on tcdevel on Tue Jan 28 12:54:37 2003, using kdoc $. |