• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.7 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

Modules | Classes | Enumerations
Document Extension Interfaces

Modules

 Smart Cursors and Ranges
 
 MovingCursors and MovingRanges
 

Classes

class  KTextEditor::AnnotationInterface
 
struct  KTextEditor::HighlightInterface::AttributeBlock
 
class  KTextEditor::ConfigInterface
 
class  KTextEditor::HighlightInterface
 
class  KTextEditor::MarkInterface
 
class  KTextEditor::MessageInterface
 
class  KTextEditor::ModeInterface
 
class  KTextEditor::ModificationInterface
 
class  KTextEditor::MovingInterface
 
class  KTextEditor::ParameterizedSessionConfigInterface
 
class  KTextEditor::RecoveryInterface
 
class  KTextEditor::SearchInterface
 
class  KTextEditor::SessionConfigInterface
 
class  KTextEditor::SmartInterface
 
class  KTextEditor::VariableInterface
 

Enumerations

enum  KTextEditor::HighlightInterface::DefaultStyle {
  KTextEditor::HighlightInterface::dsNormal, KTextEditor::HighlightInterface::dsKeyword, KTextEditor::HighlightInterface::dsDataType, KTextEditor::HighlightInterface::dsDecVal,
  KTextEditor::HighlightInterface::dsBaseN, KTextEditor::HighlightInterface::dsFloat, KTextEditor::HighlightInterface::dsChar, KTextEditor::HighlightInterface::dsString,
  KTextEditor::HighlightInterface::dsComment, KTextEditor::HighlightInterface::dsOthers, KTextEditor::HighlightInterface::dsAlert, KTextEditor::HighlightInterface::dsFunction,
  KTextEditor::HighlightInterface::dsRegionMarker, KTextEditor::HighlightInterface::dsError
}
 
enum  KTextEditor::MarkInterface::MarkChangeAction { KTextEditor::MarkInterface::MarkAdded =0, KTextEditor::MarkInterface::MarkRemoved =1 }
 
enum  KTextEditor::MarkInterface::MarkTypes {
  KTextEditor::MarkInterface::markType01 = 0x1, KTextEditor::MarkInterface::markType02 = 0x2, KTextEditor::MarkInterface::markType03 = 0x4, KTextEditor::MarkInterface::markType04 = 0x8,
  KTextEditor::MarkInterface::markType05 = 0x10, KTextEditor::MarkInterface::markType06 = 0x20, KTextEditor::MarkInterface::markType07 = 0x40, KTextEditor::MarkInterface::markType08 = 0x80,
  KTextEditor::MarkInterface::markType09 = 0x100, KTextEditor::MarkInterface::markType10 = 0x200, KTextEditor::MarkInterface::markType11 = 0x400, KTextEditor::MarkInterface::markType12 = 0x800,
  KTextEditor::MarkInterface::markType13 = 0x1000, KTextEditor::MarkInterface::markType14 = 0x2000, KTextEditor::MarkInterface::markType15 = 0x4000, KTextEditor::MarkInterface::markType16 = 0x8000,
  KTextEditor::MarkInterface::markType17 = 0x10000, KTextEditor::MarkInterface::markType18 = 0x20000, KTextEditor::MarkInterface::markType19 = 0x40000, KTextEditor::MarkInterface::markType20 = 0x80000,
  KTextEditor::MarkInterface::markType21 = 0x100000, KTextEditor::MarkInterface::markType22 = 0x200000, KTextEditor::MarkInterface::markType23 = 0x400000, KTextEditor::MarkInterface::markType24 = 0x800000,
  KTextEditor::MarkInterface::markType25 = 0x1000000, KTextEditor::MarkInterface::markType26 = 0x2000000, KTextEditor::MarkInterface::markType27 = 0x4000000, KTextEditor::MarkInterface::markType28 = 0x8000000,
  KTextEditor::MarkInterface::markType29 = 0x10000000, KTextEditor::MarkInterface::markType30 = 0x20000000, KTextEditor::MarkInterface::markType31 = 0x40000000, KTextEditor::MarkInterface::markType32 = 0x80000000,
  KTextEditor::MarkInterface::Bookmark = markType01, KTextEditor::MarkInterface::BreakpointActive = markType02, KTextEditor::MarkInterface::BreakpointReached = markType03, KTextEditor::MarkInterface::BreakpointDisabled = markType04,
  KTextEditor::MarkInterface::Execution = markType05, KTextEditor::MarkInterface::Warning = markType06, KTextEditor::MarkInterface::Error = markType07
}
 
enum  KTextEditor::ModificationInterface::ModifiedOnDiskReason { KTextEditor::ModificationInterface::OnDiskUnmodified = 0, KTextEditor::ModificationInterface::OnDiskModified = 1, KTextEditor::ModificationInterface::OnDiskCreated = 2, KTextEditor::ModificationInterface::OnDiskDeleted = 3 }
 
enum  KTextEditor::ParameterizedSessionConfigInterface::SessionConfigParameter {
  KTextEditor::ParameterizedSessionConfigInterface::SkipNone = 0, KTextEditor::ParameterizedSessionConfigInterface::SkipUrl = 1 << 0, KTextEditor::ParameterizedSessionConfigInterface::SkipMode = 1 << 1, KTextEditor::ParameterizedSessionConfigInterface::SkipHighlighting = 1 << 2,
  KTextEditor::ParameterizedSessionConfigInterface::SkipEncoding = 1 << 3, KTextEditor::ParameterizedSessionConfigInterface::SkipFolding = 1 << 4
}
 

Detailed Description

A KTextEditor implementation may implement a Document extension interface, but it does not need to.

So as a KTextEditor user you have to cast the Document to the desired interface and then check, whether the cast returns NULL or the valid interface.

Use qobject_cast to cast a Document doc into the DesiredExtensionInterface, example:

// doc is of type KTextEditor::Document*
KTextEditor::DesiredExtensionInterface *iface =
qobject_cast<KTextEditor::DesiredExtensionInterface*>( doc );
if( iface ) {
// the implementation supports the interface
// do stuff
}
else
{
// the implementation does not support the interface
}
See also
KTextEditor::Document

The following classes are a list of all available Document extension interfaces.

Enumeration Type Documentation

enum KTextEditor::HighlightInterface::DefaultStyle

TODO: Documentation.

Enumerator
dsNormal 
dsKeyword 
dsDataType 
dsDecVal 
dsBaseN 
dsFloat 
dsChar 
dsString 
dsComment 
dsOthers 
dsAlert 
dsFunction 
dsRegionMarker 
dsError 

Definition at line 68 of file highlightinterface.h.

enum KTextEditor::MarkInterface::MarkChangeAction

Possible actions on a mark.

See also
markChanged()
Enumerator
MarkAdded 

action: a mark was added.

MarkRemoved 

action: a mark was removed.

Definition at line 343 of file markinterface.h.

enum KTextEditor::MarkInterface::MarkTypes

Predefined mark types.

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

Enumerator
markType01 

Bookmark.

markType02 

Breakpoint active.

markType03 

Breakpoint reached.

markType04 

Breakpoint disabled.

markType05 

Execution mark.

markType06 

Warning.

markType07 

Error.

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 

Definition at line 209 of file markinterface.h.

enum KTextEditor::ModificationInterface::ModifiedOnDiskReason

Reasons why a document is modified on disk.

Enumerator
OnDiskUnmodified 

Not modified.

OnDiskModified 

The file was modified by another program.

OnDiskCreated 

The file was created by another program.

OnDiskDeleted 

The file was deleted.

Definition at line 84 of file modificationinterface.h.

enum KTextEditor::ParameterizedSessionConfigInterface::SessionConfigParameter

Flags for session restore.

These flags allow to skip some parts of the configuration from restoration.

Enumerator
SkipNone 
SkipUrl 
SkipMode 
SkipHighlighting 
SkipEncoding 
SkipFolding 

Definition at line 192 of file sessionconfiginterface.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2015 The KDE developers.
Generated on Mon May 4 2015 09:56:33 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

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

kdelibs-4.14.7 API Reference

Skip menu "kdelibs-4.14.7 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal