KTextEditor.MarkInterface

KDE 4.9 PyKDE API Reference

- KDE's Python API

# MarkInterface Class Reference

`from PyKDE4.ktexteditor import *`

Namespace: KTextEditor

## Detailed Description

Mark extension interface for the Document.

Introduction

The MarkInterface provides methods to enable and disable marks in a Document, a marked line can be visualized for example with a shaded background color and/or a pixmap in the iconborder of the Document's View. There are a number of predefined mark types, specified in reservedMarkersCount(). Additionally it is possible to add custom marks and set custom pixmaps.

Accessing the Interface

The MarkInterface is supposed to be an extension interface for a Document, i.e. the Document inherits the interface provided that the KTextEditor library in use implements the interface. Use qobject_cast to access the interface:

     // doc is of type KTextEditor.Document*
     KTextEditor.MarkInterface *iface =
         qobject_cast<KTextEditor.MarkInterface*>( doc );

     if( iface ) {
         // the implementation supports the interface
         // do stuff
     }

Handling Marks

Get all marks in the document by calling marks(). Use clearMarks() to remove all marks in the entire document. A single mark can be retrieved with mark(). To remove all marks from a line call clearMark(). To add and remove marks from a given line use addMark() and removeMark(). It is also possible to replace all marks with setMark(), i.e. setMark() is the same as a call of clearMark() followed by addMark(). The signals marksChanged() and markChanged() are emitted whenever a line's marks changed.

\attention A mark type is represented as an uint. An uint can have several mark types combined (see above: logical OR). That means for all functions/signals with an uint parameter, e.g. setMark(), removeMark(), etc, the uint may contain multiple marks, i.e. you can add and remove multiple marks simultaneously.

User Defined Marks

All marks that should be editable by the user can be specified with a mark mask via setEditableMarks(). To set a description and pixmap of a mark type call setMarkDescription() and setMarkPixmap().

See also:
  KTextEditor.Document, KTextEditor.Mark

Author:
  Christoph Cullmann <cullmann@kde.org>

## Enumerations
MarkChangeAction | { MarkAdded, MarkRemoved }
MarkTypes | { markType01, markType02, markType03, markType04, markType05, markType06, markType07, markType08, markType09, markType10, markType11, markType12, markType13, markType14, markType15, markType16, markType17, markType18, markType19, markType20, markType21, markType22, markType23, markType24, markType25, markType26, markType27, markType28, markType29, markType30, markType31, markType32, Bookmark, BreakpointActive, BreakpointReached, BreakpointDisabled, Execution, Warning, Error }
## Methods
| __init__ (self)
| addMark (self, int line, long markType)
| clearMark (self, int line)
| clearMarks (self)
long | editableMarks (self)
long | mark (self, int line)
| markChanged (self, KTextEditor.Document document, KTextEditor.Mark mark, KTextEditor.MarkInterface.MarkChangeAction action)
QString | markDescription (self, KTextEditor.MarkInterface.MarkTypes mark)
QPixmap | markPixmap (self, KTextEditor.MarkInterface.MarkTypes mark)
{int:KTextEditor.Mark} | marks (self)
| marksChanged (self, KTextEditor.Document document)
| removeMark (self, int line, long markType)
| setEditableMarks (self, long markMask)
| setMark (self, int line, long markType)
| setMarkDescription (self, KTextEditor.MarkInterface.MarkTypes mark, QString text)
| setMarkPixmap (self, KTextEditor.MarkInterface.MarkTypes mark, QPixmap pixmap)
## Static Methods
int | reservedMarkersCount ()

## Method Documentation

__init__ | ( |  | self ) |

addMark | ( | self, |
|  | int | line,
|  | long | markType
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Add marks of type markType to line. Existing marks on this line are preserved. If the mark markType already is set, nothing happens.

Parameters:

  | line | line to set the mark

Parameters:

  | markType | mark type

See also:
  removeMark(), setMark()

clearMark | ( | self, |
|  | int | line
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Clear all marks set in the line.

Parameters:

  | line | line to clear marks

See also:
  clearMarks(), removeMark(), addMark()

clearMarks | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Clear all marks in the entire document.

See also:
  clearMark(), removeMark()

long editableMarks | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Get, which marks can be toggled by the user. The returned value is a mark mask containing all editable marks combined with a logical OR.

Returns:
  mark mask containing all editable marks

See also:
  setEditableMarks()

long mark | ( | self, |
|  | int | line
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Get all marks set on the line.

Parameters:

  | line | requested line

Returns:
  a uint representing of the marks set in line concatenated by logical OR

See also:
  addMark(), removeMark()

markChanged | ( | self, |
|  | KTextEditor.Document | document,
|  | KTextEditor.Mark | mark,
|  | KTextEditor.MarkInterface.MarkChangeAction | action
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

The document emits this signal whenever the mark changes.

Parameters:

  | document | the document which emitted the signal

Parameters:

  | mark | changed mark

Parameters:

  | action | action, either removed or added

See also:
  marksChanged()

QString markDescription | ( | self, |
|  | KTextEditor.MarkInterface.MarkTypes | mark
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Get the mark's description to text.

Parameters:

  | mark | mark to set the description

Returns:
  text of the given mark or QString(), if the entry does not exist

See also:
  setMarkDescription(), setMarkPixmap()

QPixmap markPixmap | ( | self, |
|  | KTextEditor.MarkInterface.MarkTypes | mark
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Get the mark's pixmap.

Parameters:

  | mark | mark type. If the pixmap does not exist the resulting is null (check with QPixmap.isNull()).

See also:
  setMarkDescription()

{int:KTextEditor.Mark} marks | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Get a hash holding all marks in the document. The hash key for a mark is its line.

Returns:
  a hash holding all marks in the document

marksChanged | ( | self, |
|  | KTextEditor.Document | document
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

The document emits this signal whenever a mark mask changed.

Parameters:

  | document | document which emitted this signal

See also:
  markChanged()

removeMark | ( | self, |
|  | int | line,
|  | long | markType
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Remove the mark mask of type markType from line.

Parameters:

  | line | line to remove the mark

Parameters:

  | markType | mark type to be removed

See also:
  clearMark()

setEditableMarks | ( | self, |
|  | long | markMask
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Set the mark mask the user is allowed to toggle to markMask. I.e. concatenate all editable marks with a logical OR. If the user should be able to add a bookmark and set a breakpoint with the context menu in the icon pane, you have to call

     // iface is of Type KTextEditor.MarkInterface*
     // only make bookmark and breakpoint editable
     iface->setEditableMarks( MarkInterface.Bookmark |
                              MarkInterface.BreakpointActive );

     // or preserve last settings, and add bookmark and breakpoint
     iface->setEditableMarks( iface->editableMarks() |
                              MarkInterface.Bookmark |
                              MarkInterface.BreakpointActive );

Parameters:

  | markMask | bitmap pattern

See also:
  editableMarks(), setMarkPixmap(), setMarkDescription()

setMark | ( | self, |
|  | int | line,
|  | long | markType
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Set the line's mark types to markType. If line already contains a mark of the given type it has no effect. All other marks are deleted before the mark is set. You can achieve the same by calling

     clearMark(line);
     addMark(line, markType);

Parameters:

  | line | line to set the mark

Parameters:

  | markType | mark type

See also:
  clearMark(), addMark(), mark()

setMarkDescription | ( | self, |
|  | KTextEditor.MarkInterface.MarkTypes | mark,
|  | QString | text
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Set the mark's description to text.

Parameters:

  | mark | mark to set the description

Parameters:

  | text | new descriptive text

See also:
  markDescription(), setMarkPixmap()

setMarkPixmap | ( | self, |
|  | KTextEditor.MarkInterface.MarkTypes | mark,
|  | QPixmap | pixmap
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Set the mark's pixmap to pixmap.

Parameters:

  | mark | mark to which the pixmap will be attached

Parameters:

  | pixmap | new pixmap

See also:
  setMarkDescription()

## Static Method Documentation

int reservedMarkersCount | ( |  | ) |

Get the number of predefined mark types we have so far.

Note:
  FIXME: If you change this you have to make sure katepart supports the new size!

Returns:
  number of reserved marker types

## Enumeration Documentation

MarkChangeAction

Possible actions on a mark.

See also:
  markChanged()

Enumerator:

  MarkAdded = 0 |
  MarkRemoved = 1 |

MarkTypes

Predefined mark types.

To add a new standard mark type, edit this interface and document the type.

Enumerator:

  markType01 = 0x1 |
  markType02 = 0x2 |
  markType03 = 0x4 |
  markType04 = 0x8 |
  markType05 = 0x10 |
  markType06 = 0x20 |
  markType07 = 0x40 |
  markType08 = 0x80 |
  markType09 = 0x100 |
  markType10 = 0x200 |
  markType11 = 0x400 |
  markType12 = 0x800 |
  markType13 = 0x1000 |
  markType14 = 0x2000 |
  markType15 = 0x4000 |
  markType16 = 0x8000 |
  markType17 = 0x10000 |
  markType18 = 0x20000 |
  markType19 = 0x40000 |
  markType20 = 0x80000 |
  markType21 = 0x100000 |
  markType22 = 0x200000 |
  markType23 = 0x400000 |
  markType24 = 0x800000 |
  markType25 = 0x1000000 |
  markType26 = 0x2000000 |
  markType27 = 0x4000000 |
  markType28 = 0x8000000 |
  markType29 = 0x10000000 |
  markType30 = 0x20000000 |
  markType31 = 0x40000000 |
  markType32 = 0x80000000 |
  Bookmark = markType01 |
  BreakpointActive = markType02 |
  BreakpointReached = markType03 |
  BreakpointDisabled = markType04 |
  Execution = markType05 |
  Warning = markType06 |
  Error = markType07 |