QCodeEdit  2.2
Signals | Friends | List of all members
QLineMarksInfoCenter Class Reference

A class managing line marks accross all managed editors. More...

Inheritance diagram for QLineMarksInfoCenter:
Inheritance graph
[legend]

Signals

void lineMarkAdded (const QLineMark &mark)
 
void lineMarkRemoved (const QLineMark &mark)
 

Friends

class QEditor
 
class QCodeEdit
 
static QLineMarksInfoCenterinstance ()
 
static void destroy ()
 
QLineMarkList marks (const QString &file=QString())
 
QString markTypeId (int id)
 int -> string mark type identifier conversion
 
int markTypeId (const QString &id)
 string -> int mark type identifier conversion
 
QLineMarkType markType (int id)
 
QLineMarkType markType (const QString &id)
 
int priority (const QList< int > &marks)
 
QString priority (const QStringList &marks)
 
QStringList availableMarkTypes (const QString &context=QString())
 
QList< QStringList > marksLayout (const QString &context=QString())
 Useless for now.
 
void loadMarks (const QString &f)
 Load serialized line marks data from a file.
 
void saveMarks (const QString &f)
 Write serialized line marks data to a file.
 
void loadMarkTypes (const QString &f)
 Load line marks definition from a file.
 
void clear ()
 Remove all line marks on all files.
 
void removeMarks (const QString &file)
 Remove all line marks on a given file.
 
void addLineMark (const QLineMark &mark)
 Add a line mark. More...
 
void toggleLineMark (const QLineMark &mark)
 Remove a line mark. More...
 
void removeLineMark (const QLineMark &mark)
 Toggle a line mark. More...
 
void addLineMark (const QLineMarkHandle &mark)
 Add a line mark.
 
void toggleLineMark (const QLineMarkHandle &mark)
 Toggle a line mark.
 
void removeLineMark (const QLineMarkHandle &mark)
 Remove a line mark.
 
void flush (const QString &file)
 Flush all delayed line marks addition/removal/toggling for a given file.
 
void cursorMoved (QEditor *e)
 
void lineDeleted (QDocumentLineHandle *h)
 
void markChanged (const QString &f, QDocumentLineHandle *h, int mark, bool on)
 Entry point for changes in documents. More...
 

Detailed Description

A class managing line marks accross all managed editors.

QLineMarksInfoCenter provides mean to read/write line marks on managed editors but also to serialize and deserialize that data.

Member Function Documentation

◆ addLineMark

void QLineMarksInfoCenter::addLineMark ( const QLineMark mark)
slot

Add a line mark.

If the target file is not found the toggling will be delayed.

References QDocumentLine::addMark(), QEditor::document(), QDocumentLine::isValid(), QDocument::line(), QCodeEdit::managed(), and QEditor::setCursor().

◆ availableMarkTypes()

QStringList QLineMarksInfoCenter::availableMarkTypes ( const QString &  context = QString())
Returns
A list of available mark types
Parameters
contextcontext filter (no filtering is performed if empty)

◆ markChanged

void QLineMarksInfoCenter::markChanged ( const QString &  f,
QDocumentLineHandle line,
int  mark,
bool  on 
)
protectedslot

Entry point for changes in documents.

Every document notify through this function a change in its line marks...

◆ marks()

QLineMarkList QLineMarksInfoCenter::marks ( const QString &  file = QString())
Returns
the list of line marks set on a given file

◆ markType() [1/2]

QLineMarkType QLineMarksInfoCenter::markType ( int  id)
Returns
The mark type definition associated with a given id

◆ markType() [2/2]

QLineMarkType QLineMarksInfoCenter::markType ( const QString &  id)
Returns
the mark type definition associated with a given id

◆ priority() [1/2]

int QLineMarksInfoCenter::priority ( const QList< int > &  marks)
Returns
the mark that has the highest priority among a list of marks

◆ priority() [2/2]

QString QLineMarksInfoCenter::priority ( const QStringList &  marks)
Returns
the mark that has the highest priority among a list of marks

◆ removeLineMark

void QLineMarksInfoCenter::removeLineMark ( const QLineMark mark)
slot

Toggle a line mark.

If the target file is not found the removal will be delayed.

References QEditor::document(), QDocumentLine::isValid(), QDocument::line(), QCodeEdit::managed(), and QDocumentLine::removeMark().

◆ toggleLineMark

void QLineMarksInfoCenter::toggleLineMark ( const QLineMark mark)
slot

Remove a line mark.

If the target file is not found the addition will be delayed.

References QEditor::document(), QDocumentLine::isValid(), QDocument::line(), QCodeEdit::managed(), QEditor::setCursor(), and QDocumentLine::toggleMark().


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