.TH "KTextEditor::MarkInterface" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor::MarkInterface \- This is an interface to enable marks to be made in the iconborder of the \fBDocument\fP class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <markinterface.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMarkTypes\fP { \fBmarkType01\fP =  0x1, \fBmarkType02\fP =  0x2, \fBmarkType03\fP =  0x4, \fBmarkType04\fP =  0x8, \fBmarkType05\fP =  0x10, \fBmarkType06\fP =  0x20, \fBmarkType07\fP =  0x40, \fBmarkType08\fP =  0x80, \fBmarkType09\fP =  0x100, \fBmarkType10\fP =  0x200, \fBmarkType11\fP =  0x400, \fBmarkType12\fP =  0x800, \fBmarkType13\fP =  0x1000, \fBmarkType14\fP =  0x2000, \fBmarkType15\fP =  0x4000, \fBmarkType16\fP =  0x8000, \fBmarkType17\fP =  0x10000, \fBmarkType18\fP =  0x20000, \fBmarkType19\fP =  0x40000, \fBmarkType20\fP =  0x80000, \fBmarkType21\fP =  0x100000, \fBmarkType22\fP =  0x200000, \fBmarkType23\fP =  0x400000, \fBmarkType24\fP =  0x800000, \fBmarkType25\fP =  0x1000000, \fBmarkType26\fP =  0x2000000, \fBmarkType27\fP =  0x4000000, \fBmarkType28\fP =  0x8000000, \fBmarkType29\fP =  0x10000000, \fBmarkType30\fP =  0x20000000, \fBmarkType31\fP =  0x40000000, \fBmarkType32\fP =  0x80000000, \fBBookmark\fP =  markType01, \fBBreakpointActive\fP =  markType02, \fBBreakpointReached\fP =  markType03, \fBBreakpointDisabled\fP =  markType04, \fBExecution\fP =  markType05, \fBWarning\fP =  markType06, \fBError\fP =  markType07 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "unsigned int \fBmarkInterfaceNumber\fP () const "
.br
.ti -1c
.RI "virtual uint \fBmark\fP (uint line)=0"
.br
.ti -1c
.RI "virtual void \fBsetMark\fP (uint line, uint markType)=0"
.br
.ti -1c
.RI "virtual void \fBclearMark\fP (uint line)=0"
.br
.ti -1c
.RI "virtual void \fBaddMark\fP (uint line, uint markType)=0"
.br
.ti -1c
.RI "virtual void \fBremoveMark\fP (uint line, uint markType)=0"
.br
.ti -1c
.RI "virtual \fBQPtrList\fP< KTextEditor::Mark > \fBmarks\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBclearMarks\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBmarksChanged\fP ()=0"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static int \fBreservedMarkersCount\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetMarkInterfaceDCOPSuffix\fP (const \fBQCString\fP &suffix)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBPrivateMarkInterface\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is an interface to enable marks to be made in the iconborder of the \fBDocument\fP class. 
.PP
Definition at line 42 of file markinterface.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKTextEditor::MarkInterface::MarkTypes\fP"
.PP
Pre-defined mark types. 
.PP
To create a non-standard mark type, use \fBMarkInterfaceExtension\fP. To add a new standard mark type, edit this interface to document the type. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fImarkType01 \fP\fP
Bookmark. 
.TP
\fB\fImarkType02 \fP\fP
Breakpoint active. 
.TP
\fB\fImarkType03 \fP\fP
Breakpoint reached. 
.TP
\fB\fImarkType04 \fP\fP
Breakpoint disabled. 
.TP
\fB\fImarkType05 \fP\fP
Execution mark. 
.TP
\fB\fImarkType06 \fP\fP
Warning. 
.TP
\fB\fImarkType07 \fP\fP
Error. 
.PP
Definition at line 103 of file markinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual uint KTextEditor::MarkInterface::mark (uint line)\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
a uint representing the marks set in \fCline\fP OR'ed togeather. 
.RE
.PP

.SS "virtual void KTextEditor::MarkInterface::setMark (uint line, uint markType)\fC [pure virtual]\fP"
.PP
Adds a mark of type \fCmarkType\fP to \fCline\fP. 
.PP
Has no effect if the line allready contains a mark of that type. 
.SS "virtual void KTextEditor::MarkInterface::clearMark (uint line)\fC [pure virtual]\fP"
.PP
Clears all marks set in \fCline\fP. 
.PP
.SS "virtual void KTextEditor::MarkInterface::removeMark (uint line, uint markType)\fC [pure virtual]\fP"
.PP
Removes any mark of type \fCmarkType\fP from \fCline\fP. 
.PP
.SS "virtual \fBQPtrList\fP<KTextEditor::Mark> KTextEditor::MarkInterface::marks ()\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
a list of all marks in the document 
.RE
.PP

.SS "virtual void KTextEditor::MarkInterface::clearMarks ()\fC [pure virtual]\fP"
.PP
Clears all marks in the document. 
.PP
.SS "int MarkInterface::reservedMarkersCount ()\fC [static]\fP"
.PP
get the number of predefined marker types we have so far. 
.PP
\fBNote:\fP
.RS 4
If you change this you have to make sure katepart supports the new size! 
.RE
.PP
\fBReturns:\fP
.RS 4
number of reserved marker types 
.RE
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 71 of file markinterface.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
