eric6.QScintilla.MarkupProviders.RestructuredTextProvider

Module implementing the reStructured Text markup provider.

Global Attributes

None

Classes

RestructuredTextProvider

Class implementing the reStructured Text markup provider.

Functions

None

RestructuredTextProvider

Class implementing the reStructured Text markup provider.

Derived from

MarkupBase

Class Attributes

None

Class Methods

None

Methods

RestructuredTextProvider	Constructor
__insertMarkup	Private method to insert the specified markup.
__makeList	Private method to generate the desired list markup.
bold	Public method to generate bold text.
bulletedList	Public method to generate bulleted list text.
code	Public method to generate inline code text.
codeBlock	Public method to generate code block text.
hasBold	Public method to indicate the availability of bold markup.
hasBulletedList	Public method to indicate the availability of bulleted list markup.
hasCode	Public method to indicate the availability of inline code markup.
hasCodeBlock	Public method to indicate the availability of code block markup.
hasHyperlink	Public method to indicate the availability of hyperlink markup.
hasImage	Public method to indicate the availability of image markup.
hasItalic	Public method to indicate the availability of italic markup.
hasLine	Public method to indicate the availability of a horizontal line markup.
hasNumberedList	Public method to indicate the availability of numbered list markup.
hasQuote	Public method to indicate the availability of block quote markup.
header	Public method to generate a header.
headerLevels	Public method to determine the available header levels.
hyperlink	Public method to generate hyperlink text.
image	Public method to generate image text.
italic	Public method to generate italic text.
kind	Public method to get the markup kind.
line	Public method to generate a horizontal line text.
numberedList	Public method to generate numbered list text.
quote	Public method to generate block quote text.

Static Methods

None

RestructuredTextProvider (Constructor)

RestructuredTextProvider()

Constructor

RestructuredTextProvider.__insertMarkup

__insertMarkup(markup, editor)

Private method to insert the specified markup.

If the editor has selected text, this text is enclosed by the given markup. If no text is selected, the markup is inserted at the cursor position and the cursor is positioned in between.

markup (str): markup string to be inserted
editor (Editor): reference to the editor to work on

RestructuredTextProvider.__makeList

__makeList(editor, numberedList)

Private method to generate the desired list markup.

editor (Editor): reference to the editor to work on
numberedList (bool): flag indicating the generation of a numbered list

RestructuredTextProvider.bold

bold(editor)

Public method to generate bold text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.bulletedList

bulletedList(editor)

Public method to generate bulleted list text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.code

code(editor)

Public method to generate inline code text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.codeBlock

codeBlock(editor)

Public method to generate code block text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.hasBold

hasBold()

Public method to indicate the availability of bold markup.

Returns:: flag indicating the availability of bold markup

Return Type:: bool

RestructuredTextProvider.hasBulletedList

hasBulletedList()

Public method to indicate the availability of bulleted list markup.

Returns:: flag indicating the availability of bulleted list markup

Return Type:: bool

RestructuredTextProvider.hasCode

hasCode()

Public method to indicate the availability of inline code markup.

Returns:: flag indicating the availability of inline code markup

Return Type:: bool

RestructuredTextProvider.hasCodeBlock

hasCodeBlock()

Public method to indicate the availability of code block markup.

Returns:: flag indicating the availability of code block markup

Return Type:: bool

RestructuredTextProvider.hasHyperlink

hasHyperlink()

Public method to indicate the availability of hyperlink markup.

Returns:: flag indicating the availability of hyperlink markup

Return Type:: bool

RestructuredTextProvider.hasImage

hasImage()

Public method to indicate the availability of image markup.

Returns:: flag indicating the availability of image markup

Return Type:: bool

RestructuredTextProvider.hasItalic

hasItalic()

Public method to indicate the availability of italic markup.

Returns:: flag indicating the availability of italic markup

Return Type:: bool

RestructuredTextProvider.hasLine

hasLine()

Public method to indicate the availability of a horizontal line markup.

Returns:: flag indicating the availability of a horizontal line markup

Return Type:: bool

RestructuredTextProvider.hasNumberedList

hasNumberedList()

Public method to indicate the availability of numbered list markup.

Returns:: flag indicating the availability of numbered list markup

Return Type:: bool

RestructuredTextProvider.hasQuote

hasQuote()

Public method to indicate the availability of block quote markup.

Returns:: flag indicating the availability of block quote markup

Return Type:: bool

RestructuredTextProvider.header

header(editor, level)

Public method to generate a header.

editor (Editor): reference to the editor to work on
level (int): header level

RestructuredTextProvider.headerLevels

headerLevels()

Public method to determine the available header levels.

Returns:: supported header levels

Return Type:: int

RestructuredTextProvider.hyperlink

hyperlink(editor)

Public method to generate hyperlink text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.image

image(editor)

Public method to generate image text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.italic

italic(editor)

Public method to generate italic text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.kind

kind()

Public method to get the markup kind.

Returns:: string with markup kind

Return Type:: str

RestructuredTextProvider.line

line(editor)

Public method to generate a horizontal line text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.numberedList

numberedList(editor)

Public method to generate numbered list text.

editor (Editor): reference to the editor to work on

RestructuredTextProvider.quote

quote(editor)

Public method to generate block quote text.

editor (Editor): reference to the editor to work on

Home ⌂Doc Index ◂Up ▴