• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdevelop API Reference
  • KDE Home
  • Contact Us
 

kdevplatform/interfaces

  • KDevelop
  • SourceFormatterStyle
Classes | Public Types | Public Member Functions | List of all members
KDevelop::SourceFormatterStyle Class Reference

#include <isourceformatter.h>

Classes

struct  MimeHighlightPair
 

Public Types

using MimeList = QVector< MimeHighlightPair >
 

Public Member Functions

 SourceFormatterStyle ()
 
 SourceFormatterStyle (const QString &name)
 
QString caption () const
 
QString content () const
 
void copyDataFrom (SourceFormatterStyle *other)
 
QString description () const
 
MimeList mimeTypes () const
 
QVariant mimeTypesVariant () const
 
QString modeForMimetype (const QMimeType &mime) const
 
QString name () const
 
QString overrideSample () const
 
void setCaption (const QString &caption)
 
void setContent (const QString &content)
 
void setDescription (const QString &desc)
 
void setMimeTypes (const MimeList &types)
 
void setMimeTypes (const QStringList &types)
 
void setOverrideSample (const QString &sample)
 
void setUsePreview (bool use)
 
bool supportsLanguage (const QString &language) const
 
bool usePreview () const
 

Detailed Description

Definition at line 33 of file isourceformatter.h.

Member Typedef Documentation

◆ MimeList

using KDevelop::SourceFormatterStyle::MimeList = QVector<MimeHighlightPair>

Definition at line 40 of file isourceformatter.h.

Constructor & Destructor Documentation

◆ SourceFormatterStyle() [1/2]

KDevelop::SourceFormatterStyle::SourceFormatterStyle ( )

Definition at line 42 of file isourceformatter.cpp.

◆ SourceFormatterStyle() [2/2]

KDevelop::SourceFormatterStyle::SourceFormatterStyle ( const QString &  name)
explicit

Definition at line 46 of file isourceformatter.cpp.

Member Function Documentation

◆ caption()

QString KDevelop::SourceFormatterStyle::caption ( ) const

Definition at line 67 of file isourceformatter.cpp.

◆ content()

QString KDevelop::SourceFormatterStyle::content ( ) const

Definition at line 62 of file isourceformatter.cpp.

◆ copyDataFrom()

void KDevelop::SourceFormatterStyle::copyDataFrom ( SourceFormatterStyle *  other)

Copy content, mime types and code sample from other.

Definition at line 159 of file isourceformatter.cpp.

◆ description()

QString KDevelop::SourceFormatterStyle::description ( ) const

Definition at line 77 of file isourceformatter.cpp.

◆ mimeTypes()

SourceFormatterStyle::MimeList KDevelop::SourceFormatterStyle::mimeTypes ( ) const

Definition at line 123 of file isourceformatter.cpp.

◆ mimeTypesVariant()

QVariant KDevelop::SourceFormatterStyle::mimeTypesVariant ( ) const

mime types as a QVariantList, type and mode separated by | in strings

Definition at line 128 of file isourceformatter.cpp.

◆ modeForMimetype()

QString KDevelop::SourceFormatterStyle::modeForMimetype ( const QMimeType &  mime) const

get the language / highlight mode for a given mime

Definition at line 148 of file isourceformatter.cpp.

◆ name()

QString KDevelop::SourceFormatterStyle::name ( ) const

Definition at line 72 of file isourceformatter.cpp.

◆ overrideSample()

QString KDevelop::SourceFormatterStyle::overrideSample ( ) const

Provides the possibility to the item to return a better-suited code sample.

If empty, the default is used.

Definition at line 118 of file isourceformatter.cpp.

◆ setCaption()

void KDevelop::SourceFormatterStyle::setCaption ( const QString &  caption)

Definition at line 57 of file isourceformatter.cpp.

◆ setContent()

void KDevelop::SourceFormatterStyle::setContent ( const QString &  content)

Definition at line 52 of file isourceformatter.cpp.

◆ setDescription()

void KDevelop::SourceFormatterStyle::setDescription ( const QString &  desc)

Definition at line 82 of file isourceformatter.cpp.

◆ setMimeTypes() [1/2]

void KDevelop::SourceFormatterStyle::setMimeTypes ( const MimeList &  types)

Definition at line 97 of file isourceformatter.cpp.

◆ setMimeTypes() [2/2]

void KDevelop::SourceFormatterStyle::setMimeTypes ( const QStringList &  types)

Definition at line 102 of file isourceformatter.cpp.

◆ setOverrideSample()

void KDevelop::SourceFormatterStyle::setOverrideSample ( const QString &  sample)

Definition at line 113 of file isourceformatter.cpp.

◆ setUsePreview()

void KDevelop::SourceFormatterStyle::setUsePreview ( bool  use)

Definition at line 92 of file isourceformatter.cpp.

◆ supportsLanguage()

bool KDevelop::SourceFormatterStyle::supportsLanguage ( const QString &  language) const

Definition at line 138 of file isourceformatter.cpp.

◆ usePreview()

bool KDevelop::SourceFormatterStyle::usePreview ( ) const

Definition at line 87 of file isourceformatter.cpp.


The documentation for this class was generated from the following files:
  • isourceformatter.h
  • isourceformatter.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Jan 20 2021 23:38:10 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/interfaces

Skip menu "kdevplatform/interfaces"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

Search



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