ide-highlight-engine: Builder SDK Reference

## ide-highlight-engine ide-highlight-engine |

## Functions

IdeHighlightEngine * | ide_highlight_engine_new ()
IdeBuffer * | ide_highlight_engine_get_buffer ()
IdeHighlighter * | ide_highlight_engine_get_highlighter ()
void | ide_highlight_engine_rebuild ()
void | ide_highlight_engine_clear ()
void | ide_highlight_engine_invalidate ()
GtkTextTag * | ide_highlight_engine_get_style ()
void | ide_highlight_engine_pause ()
void | ide_highlight_engine_unpause ()
void | ide_highlight_engine_advance ()

## Properties

IdeBuffer * | buffer | Read / Write / Construct Only
IdeHighlighter * | highlighter | Read

## Types and Values

#define | IDE_TYPE_HIGHLIGHT_ENGINE
| IdeHighlightEngine

## Object Hierarchy

        GObject
        ╰── IdeObject
            ╰── IdeHighlightEngine

## Description

## Functions

### ide_highlight_engine_new ()

    IdeHighlightEngine *
    ide_highlight_engine_new (IdeBuffer *buffer);

### ide_highlight_engine_get_buffer ()

    IdeBuffer *
    ide_highlight_engine_get_buffer (IdeHighlightEngine *self);

Gets the IdeHighlightEngine:buffer property.

#### Parameters

self | an IdeHighlightEngine. |

#### Returns

An IdeBuffer.

[transfer none]

Since: 3.32

### ide_highlight_engine_get_highlighter ()

    IdeHighlighter *
    ide_highlight_engine_get_highlighter (IdeHighlightEngine *self);

Gets the IdeHighlightEngine:highlighter property.

#### Parameters

self | an IdeHighlightEngine. |

#### Returns

An IdeHighlighter.

[transfer none]

Since: 3.32

### ide_highlight_engine_rebuild ()

    void
    ide_highlight_engine_rebuild (IdeHighlightEngine *self);

### ide_highlight_engine_clear ()

    void
    ide_highlight_engine_clear (IdeHighlightEngine *self);

### ide_highlight_engine_invalidate ()

    void
    ide_highlight_engine_invalidate (IdeHighlightEngine *self,
                                     const GtkTextIter *begin,
                                     const GtkTextIter *end);

This function will extend the invalidated range of the buffer to include the range of `begin` to `end` .

The highlighter will be queued to interactively update the invalidated region.

Updating the invalidated region of the buffer may take some time, as it is important that the highlighter does not block for more than 1-2 milliseconds to avoid dropping frames.

#### Parameters

self | An IdeHighlightEngine. |
begin | the beginning of the range to invalidate |
end | the end of the range to invalidate |

Since: 3.32

### ide_highlight_engine_get_style ()

    GtkTextTag *
    ide_highlight_engine_get_style (IdeHighlightEngine *self,
                                    const gchar *style_name);

A GtkTextTag for `style_name` .

#### Parameters

self | the IdeHighlightEngine |
style_name | the name of the style to retrieve |

#### Returns

a GtkTextTag.

[transfer none]

Since: 3.32

### ide_highlight_engine_pause ()

    void
    ide_highlight_engine_pause (IdeHighlightEngine *self);

### ide_highlight_engine_unpause ()

    void
    ide_highlight_engine_unpause (IdeHighlightEngine *self);

### ide_highlight_engine_advance ()

    void
    ide_highlight_engine_advance (IdeHighlightEngine *self);

This function is useful for IdeHighlighter implementations that need to asynchronously do work to process the highlighting.

If they return from their update function without advancing, nothing will happen until they call this method to proceed.

#### Parameters

self | a IdeHighlightEngine |

Since: 3.32

## Types and Values

### IDE_TYPE_HIGHLIGHT_ENGINE

    #define IDE_TYPE_HIGHLIGHT_ENGINE (ide_highlight_engine_get_type())

### IdeHighlightEngine

    typedef struct _IdeHighlightEngine IdeHighlightEngine;

## Property Details

### The `“buffer”` property

      “buffer”                   IdeBuffer *

The buffer to highlight.

Flags: Read / Write / Construct Only

### The `“highlighter”` property

      “highlighter”              IdeHighlighter *

The highlighter to use for type information.

Flags: Read