Wrapper functions for the Scintilla editor widget SCI_* messages. More...

Functions
void	sci_delete_marker_at_line (ScintillaObject *sci, gint line_number, gint marker)
	Deletes a line marker. More...

void	sci_end_undo_action (ScintillaObject *sci)
	Ends grouping a set of edits together as one Undo action. More...

void	sci_ensure_line_is_visible (ScintillaObject *sci, gint line)
	Makes line visible (folding may have hidden it). More...

gint	sci_find_matching_brace (ScintillaObject *sci, gint pos)
	Finds a matching brace at pos. More...

gint	sci_find_text (ScintillaObject sci, gint flags, struct Sci_TextToFind ttf)
	Finds text in the document. More...

gchar	sci_get_char_at (ScintillaObject *sci, gint pos)
	Gets a character. More...

gint	sci_get_col_from_position (ScintillaObject *sci, gint position)
	Gets the column number relative to the start of the line that position is on. More...

gchar *	sci_get_contents (ScintillaObject *sci, gint buffer_len)
	Allocates and fills a buffer with text from the start of the document. More...

gchar *	sci_get_contents_range (ScintillaObject *sci, gint start, gint end)
	Gets text between start and end. More...

gint	sci_get_current_line (ScintillaObject *sci)
	Gets current line number. More...

gint	sci_get_current_position (ScintillaObject *sci)
	Gets the cursor position. More...

gint	sci_get_length (ScintillaObject *sci)
	Gets the length of all text. More...

gint	sci_get_lexer (ScintillaObject *sci)
	Gets the currently used lexer. More...

gchar *	sci_get_line (ScintillaObject *sci, gint line_num)
	Gets line contents. More...

gint	sci_get_line_count (ScintillaObject *sci)
	Gets the total number of lines. More...

gint	sci_get_line_end_position (ScintillaObject *sci, gint line)
	Gets the position at the end of a line. More...

gint	sci_get_line_from_position (ScintillaObject *sci, gint position)
	Gets the line number from position. More...

gint	sci_get_line_indentation (ScintillaObject *sci, gint line)
	Gets the indentation width of a line. More...

gboolean	sci_get_line_is_visible (ScintillaObject *sci, gint line)
	Checks if a line is visible (folding may have hidden it). More...

gint	sci_get_line_length (ScintillaObject *sci, gint line)
	Gets line length. More...

gint	sci_get_position_from_line (ScintillaObject *sci, gint line)
	Gets the position for the start of line. More...

void	sci_get_selected_text (ScintillaObject sci, gchar text)
	Gets selected text. More...

gint	sci_get_selected_text_length (ScintillaObject *sci)
	Gets selected text length including the terminating NUL character. More...

gint	sci_get_selected_text_length2 (ScintillaObject *sci)
	Gets selected text length without the terminating NUL character. More...

gchar *	sci_get_selection_contents (ScintillaObject *sci)
	Gets selected text. More...

gint	sci_get_selection_end (ScintillaObject *sci)
	Gets the selection end position. More...

gint	sci_get_selection_mode (ScintillaObject *sci)
	Gets selection mode. More...

gint	sci_get_selection_start (ScintillaObject *sci)
	Gets the selection start position. More...

gint	sci_get_style_at (ScintillaObject *sci, gint position)
	Gets style ID at position. More...

gint	sci_get_tab_width (ScintillaObject *sci)
	Gets display tab width (this is not indent width, see GeanyIndentPrefs). More...

void	sci_get_text (ScintillaObject sci, gint len, gchar text)
	Gets all text. More...

void	sci_get_text_range (ScintillaObject sci, gint start, gint end, gchar text)
	Gets text between start and end. More...

void	sci_goto_line (ScintillaObject *sci, gint line, gboolean unfold)
	Jumps to the specified line in the document. More...

gboolean	sci_has_selection (ScintillaObject *sci)
	Checks if there's a selection. More...

void	sci_indicator_clear (ScintillaObject *sci, gint pos, gint len)
	Clears the currently set indicator from a range of text. More...

void	sci_indicator_set (ScintillaObject *sci, gint indic)
	Sets the current indicator. More...

void	sci_insert_text (ScintillaObject sci, gint pos, const gchar text)
	Inserts text. More...

gboolean	sci_is_marker_set_at_line (ScintillaObject *sci, gint line, gint marker)
	Checks if a line has a marker set. More...

void	sci_replace_sel (ScintillaObject sci, const gchar text)
	Replaces selection. More...

void	sci_scroll_caret (ScintillaObject *sci)
	Scrolls the cursor in view. More...

void	sci_send_command (ScintillaObject *sci, gint cmd)
	Sends Scintilla commands without any parameters. More...

void	sci_set_current_position (ScintillaObject *sci, gint position, gboolean scroll_to_caret)
	Sets the cursor position. More...

void	sci_set_font (ScintillaObject sci, gint style, const gchar font, gint size)
	Sets the font for a particular style. More...

void	sci_set_line_indentation (ScintillaObject *sci, gint line, gint indent)
	Sets the indentation of a line. More...

void	sci_set_marker_at_line (ScintillaObject *sci, gint line_number, gint marker)
	Sets a line marker. More...

void	sci_set_selection_end (ScintillaObject *sci, gint position)
	Sets the selection end position. More...

void	sci_set_selection_mode (ScintillaObject *sci, gint mode)
	Sets selection mode. More...

void	sci_set_selection_start (ScintillaObject *sci, gint position)
	Sets the selection start position. More...

void	sci_set_text (ScintillaObject sci, const gchar text)
	Sets all text. More...

void	sci_start_undo_action (ScintillaObject *sci)
	Begins grouping a set of edits together as one Undo action. More...

Detailed Description

Wrapper functions for the Scintilla editor widget SCI_* messages.

You should also check the https://scintilla.org documentation, as it is more detailed.

To get Scintilla notifications, use the "editor-notify" signal .

Note: These functions were originally from the cssed project (https://sourceforge.net/projects/cssed/, thanks).

See also: scintilla_send_message().

Function Documentation

◆ sci_delete_marker_at_line()

void sci_delete_marker_at_line	(	ScintillaObject *	sci,
		gint	line_number,
		gint	marker
	)

Deletes a line marker.

Parameters

sci	Scintilla widget.
line_number	Line number.
marker	Marker number.

◆ sci_end_undo_action()

void sci_end_undo_action ( ScintillaObject * sci )

Ends grouping a set of edits together as one Undo action.

Parameters

sci	Scintilla `GtkWidget`.

See also: sci_start_undo_action().

◆ sci_ensure_line_is_visible()

void sci_ensure_line_is_visible	(	ScintillaObject *	sci,
		gint	line
	)

Makes line visible (folding may have hidden it).

Parameters

sci	Scintilla widget.
line	Line number.

◆ sci_find_matching_brace()

gint sci_find_matching_brace	(	ScintillaObject *	sci,
		gint	pos
	)

Finds a matching brace at pos.

Parameters

sci	Scintilla widget.
pos	Position.

Returns: Matching brace position.

Since: 0.15

◆ sci_find_text()

gint sci_find_text	(	ScintillaObject *	sci,
		gint	flags,
		struct Sci_TextToFind *	ttf
	)

Finds text in the document.

The ttf argument should be a pointer to a Sci_TextToFind structure which contains the text to find and the range in which the text should be searched.

Please refer to the Scintilla documentation for a more detailed description.

Parameters

sci	Scintilla widget.
flags	Bitmask of Scintilla search flags (`SCFIND_*`, see Scintilla documentation).
ttf	Pointer to a TextToFind structure which contains the text to find and the range.

Returns: The position of the start of the found text if it succeeds, otherwise -1. The chrgText.cpMin and chrgText.cpMax members of TextToFind are filled in with the start and end positions of the found text.

◆ sci_get_char_at()

gchar sci_get_char_at	(	ScintillaObject *	sci,
		gint	pos
	)

Gets a character.

Parameters

sci	Scintilla widget.
pos	Position.

Returns: Char.

◆ sci_get_col_from_position()

gint sci_get_col_from_position	(	ScintillaObject *	sci,
		gint	position
	)

Gets the column number relative to the start of the line that position is on.

Parameters

sci	Scintilla widget.
position	Position.

Returns: The column.

◆ sci_get_contents()

gchar * sci_get_contents	(	ScintillaObject *	sci,
		gint	buffer_len
	)

Allocates and fills a buffer with text from the start of the document.

Parameters

sci	Scintilla widget.
buffer_len	Buffer length to allocate, including the terminating null char, e.g. sci_get_length() + 1. Alternatively use `-1` to get all text (since Geany 1.23).

Returns: A copy of the text. Should be freed when no longer needed.

Since: 1.23 (0.17)

◆ sci_get_contents_range()

gchar * sci_get_contents_range	(	ScintillaObject *	sci,
		gint	start,
		gint	end
	)

Gets text between start and end.

Parameters

sci	Scintilla widget.
start	Start position.
end	End position.

Returns: The text inside the given range. Should be freed when no longer needed.

Since: 0.17

◆ sci_get_current_line()

gint sci_get_current_line ( ScintillaObject * sci )

Gets current line number.

Parameters

sci	Scintilla widget.

Returns: Line number.

◆ sci_get_current_position()

gint sci_get_current_position ( ScintillaObject * sci )

Gets the cursor position.

Parameters

sci	Scintilla widget.

Returns: Position.

◆ sci_get_length()

gint sci_get_length ( ScintillaObject * sci )

Gets the length of all text.

Parameters

sci	Scintilla widget.

Returns: Length.

◆ sci_get_lexer()

gint sci_get_lexer ( ScintillaObject * sci )

Gets the currently used lexer.

Parameters

sci	Scintilla widget.

Returns: The lexer ID

◆ sci_get_line()

gchar * sci_get_line	(	ScintillaObject *	sci,
		gint	line_num
	)

Gets line contents.

Parameters

sci	Scintilla widget.
line_num	Line number.

Returns: A NULL-terminated copy of the line text.

◆ sci_get_line_count()

gint sci_get_line_count ( ScintillaObject * sci )

Gets the total number of lines.

Parameters

sci	Scintilla widget.

Returns: The line count.

◆ sci_get_line_end_position()

gint sci_get_line_end_position	(	ScintillaObject *	sci,
		gint	line
	)

Gets the position at the end of a line.

Parameters

sci	Scintilla widget.
line	Line.

Returns: The position at the end of the line.

◆ sci_get_line_from_position()

gint sci_get_line_from_position	(	ScintillaObject *	sci,
		gint	position
	)

Gets the line number from position.

Parameters

sci	Scintilla widget.
position	Position.

Returns: The line.

◆ sci_get_line_indentation()

gint sci_get_line_indentation	(	ScintillaObject *	sci,
		gint	line
	)

Gets the indentation width of a line.

Parameters

sci	Scintilla widget.
line	Line to get the indentation from.

Returns: Indentation width.

Since: 0.19

◆ sci_get_line_is_visible()

gboolean sci_get_line_is_visible	(	ScintillaObject *	sci,
		gint	line
	)

Checks if a line is visible (folding may have hidden it).

Parameters

sci	Scintilla widget.
line	Line number.

Returns: Whether line will be drawn on the screen.

◆ sci_get_line_length()

gint sci_get_line_length	(	ScintillaObject *	sci,
		gint	line
	)

Gets line length.

Parameters

sci	Scintilla widget.
line	Line number.

Returns: Length.

◆ sci_get_position_from_line()

gint sci_get_position_from_line	(	ScintillaObject *	sci,
		gint	line
	)

Gets the position for the start of line.

Parameters

sci	Scintilla widget.
line	Line.

Returns: Position.

◆ sci_get_selected_text()

void sci_get_selected_text	(	ScintillaObject *	sci,
		gchar *	text
	)

Gets selected text.

Deprecated:: sci_get_selected_text is deprecated and should not be used in newly-written code. Use sci_get_selection_contents() instead.

Note: You must ensure NUL termination yourself, this function does not NUL terminate the buffer itself.

Parameters

sci	Scintilla widget.
text	Text buffer; must be allocated sci_get_selected_text_length() + 1 bytes for null-termination.

◆ sci_get_selected_text_length()

gint sci_get_selected_text_length ( ScintillaObject * sci )

Gets selected text length including the terminating NUL character.

Deprecated:: sci_get_selected_text_length is deprecated and should not be used in newly-written code. Use sci_get_selected_text_length2() instead.

Parameters

sci	Scintilla widget.

Returns: Length.

◆ sci_get_selected_text_length2()

gint sci_get_selected_text_length2 ( ScintillaObject * sci )

Gets selected text length without the terminating NUL character.

Parameters

sci	Scintilla widget.

Returns: Length.

◆ sci_get_selection_contents()

gchar * sci_get_selection_contents ( ScintillaObject * sci )

Gets selected text.

Parameters

sci	Scintilla widget.

Returns: The selected text. Should be freed when no longer needed.

Since: 0.17

◆ sci_get_selection_end()

gint sci_get_selection_end ( ScintillaObject * sci )

Gets the selection end position.

Parameters

sci	Scintilla widget.

Returns: Position.

◆ sci_get_selection_mode()

gint sci_get_selection_mode ( ScintillaObject * sci )

Gets selection mode.

Parameters

sci	Scintilla widget.

Returns: Selection mode.

◆ sci_get_selection_start()

gint sci_get_selection_start ( ScintillaObject * sci )

Gets the selection start position.

Parameters

sci	Scintilla widget.

Returns: Position.

◆ sci_get_style_at()

gint sci_get_style_at	(	ScintillaObject *	sci,
		gint	position
	)

Gets style ID at position.

Parameters

sci	Scintilla widget.
position	Position.

Returns: Style ID.

◆ sci_get_tab_width()

gint sci_get_tab_width ( ScintillaObject * sci )

Gets display tab width (this is not indent width, see GeanyIndentPrefs).

Parameters

sci	Scintilla widget.

Returns: Width.

Since: 0.15

◆ sci_get_text()

void sci_get_text	(	ScintillaObject *	sci,
		gint	len,
		gchar *	text
	)

Gets all text.

Deprecated:: sci_get_text is deprecated and should not be used in newly-written code. Use sci_get_contents() instead.

Parameters

sci	Scintilla widget.
len	Length of text buffer, usually sci_get_length() + 1.
text	Text buffer; must be allocated len bytes for null-termination.

◆ sci_get_text_range()

void sci_get_text_range	(	ScintillaObject *	sci,
		gint	start,
		gint	end,
		gchar *	text
	)

Gets text between start and end.

Deprecated:: sci_get_text_range is deprecated and should not be used in newly-written code. Use sci_get_contents_range() instead.

Parameters

sci	Scintilla widget.
start	Start.
end	End.
text	Text will be zero terminated and must be allocated (end - start + 1) bytes.

◆ sci_goto_line()

void sci_goto_line	(	ScintillaObject *	sci,
		gint	line,
		gboolean	unfold
	)

Jumps to the specified line in the document.

If unfold is set and line is hidden by a fold, it is unfolded first to ensure it is visible.

Parameters

sci	Scintilla widget.
line	Line.
unfold	Whether to unfold first.

◆ sci_has_selection()

gboolean sci_has_selection ( ScintillaObject * sci )

Checks if there's a selection.

Parameters

sci	Scintilla widget.

Returns: Whether a selection is present.

Since: 0.15

◆ sci_indicator_clear()

void sci_indicator_clear	(	ScintillaObject *	sci,
		gint	pos,
		gint	len
	)

Clears the currently set indicator from a range of text.

Starting at pos, len characters long. In order to make this function properly, you need to set the current indicator before with sci_indicator_set().

Parameters

sci	Scintilla widget.
pos	Starting position.
len	Length.

Since: 0.16

◆ sci_indicator_set()

void sci_indicator_set	(	ScintillaObject *	sci,
		gint	indic
	)

Sets the current indicator.

This is necessary to define an indicator for a range of text or clearing indicators for a range of text.

Parameters

sci	Scintilla widget.
indic	The indicator number to set.

See also: sci_indicator_clear

Since: 0.16

◆ sci_insert_text()

void sci_insert_text	(	ScintillaObject *	sci,
		gint	pos,
		const gchar *	text
	)

Inserts text.

Parameters

sci	Scintilla widget.
pos	Position, or -1 for current.
text	Text.

◆ sci_is_marker_set_at_line()

gboolean sci_is_marker_set_at_line	(	ScintillaObject *	sci,
		gint	line,
		gint	marker
	)

Checks if a line has a marker set.

Parameters

sci	Scintilla widget.
line	Line number.
marker	Marker number.

Returns: Whether it's set.

◆ sci_replace_sel()

void sci_replace_sel	(	ScintillaObject *	sci,
		const gchar *	text
	)

Replaces selection.

Parameters

sci	Scintilla widget.
text	Text.

◆ sci_scroll_caret()

void sci_scroll_caret ( ScintillaObject * sci )

Scrolls the cursor in view.

Parameters

sci	Scintilla widget.

◆ sci_send_command()

void sci_send_command	(	ScintillaObject *	sci,
		gint	cmd
	)

Sends Scintilla commands without any parameters.

Parameters

sci	The Scintilla `GtkWidget`.
cmd	`SCI_COMMAND`.

See also: https://scintilla.org for the documentation.

Since: 0.16

◆ sci_set_current_position()

void sci_set_current_position	(	ScintillaObject *	sci,
		gint	position,
		gboolean	scroll_to_caret
	)

Sets the cursor position.

Parameters

sci	Scintilla widget.
position	Position.
scroll_to_caret	Whether to scroll the cursor in view.

◆ sci_set_font()

void sci_set_font	(	ScintillaObject *	sci,
		gint	style,
		const gchar *	font,
		gint	size
	)

Sets the font for a particular style.

Parameters

sci	Scintilla widget.
style	The style.
font	The font name.
size	The font size.

◆ sci_set_line_indentation()

void sci_set_line_indentation	(	ScintillaObject *	sci,
		gint	line,
		gint	indent
	)

Sets the indentation of a line.

Parameters

sci	Scintilla widget.
line	Line to indent.
indent	Indentation width.

Since: 0.19

◆ sci_set_marker_at_line()

void sci_set_marker_at_line	(	ScintillaObject *	sci,
		gint	line_number,
		gint	marker
	)

Sets a line marker.

Parameters

sci	Scintilla widget.
line_number	Line number.
marker	Marker number.

◆ sci_set_selection_end()

void sci_set_selection_end	(	ScintillaObject *	sci,
		gint	position
	)

Sets the selection end position.

Parameters

sci	Scintilla widget.
position	Position.

◆ sci_set_selection_mode()

void sci_set_selection_mode	(	ScintillaObject *	sci,
		gint	mode
	)

Sets selection mode.

Parameters

sci	Scintilla widget.
mode	Mode.

◆ sci_set_selection_start()

void sci_set_selection_start	(	ScintillaObject *	sci,
		gint	position
	)

Sets the selection start position.

Parameters

sci	Scintilla widget.
position	Position.

◆ sci_set_text()

void sci_set_text	(	ScintillaObject *	sci,
		const gchar *	text
	)

Sets all text.

Parameters

sci	Scintilla widget.
text	Text.

◆ sci_start_undo_action()

void sci_start_undo_action ( ScintillaObject * sci )

Begins grouping a set of edits together as one Undo action.

You must call sci_end_undo_action() after making your edits.

Parameters

sci	Scintilla `GtkWidget`.

Functions

Detailed Description

Function Documentation

◆ sci_delete_marker_at_line()

◆ sci_end_undo_action()

◆ sci_ensure_line_is_visible()

◆ sci_find_matching_brace()

◆ sci_find_text()

◆ sci_get_char_at()

◆ sci_get_col_from_position()

◆ sci_get_contents()

◆ sci_get_contents_range()

◆ sci_get_current_line()

◆ sci_get_current_position()

◆ sci_get_length()

◆ sci_get_lexer()

◆ sci_get_line()

◆ sci_get_line_count()

◆ sci_get_line_end_position()

◆ sci_get_line_from_position()

◆ sci_get_line_indentation()

◆ sci_get_line_is_visible()

◆ sci_get_line_length()

◆ sci_get_position_from_line()

◆ sci_get_selected_text()

◆ sci_get_selected_text_length()

◆ sci_get_selected_text_length2()

◆ sci_get_selection_contents()

◆ sci_get_selection_end()

◆ sci_get_selection_mode()

◆ sci_get_selection_start()

◆ sci_get_style_at()

◆ sci_get_tab_width()

◆ sci_get_text()

◆ sci_get_text_range()

◆ sci_goto_line()

◆ sci_has_selection()

◆ sci_indicator_clear()

◆ sci_indicator_set()

◆ sci_insert_text()

◆ sci_is_marker_set_at_line()

◆ sci_replace_sel()

◆ sci_scroll_caret()

◆ sci_send_command()

◆ sci_set_current_position()

◆ sci_set_font()

◆ sci_set_line_indentation()

◆ sci_set_marker_at_line()

◆ sci_set_selection_end()

◆ sci_set_selection_mode()

◆ sci_set_selection_start()

◆ sci_set_text()

◆ sci_start_undo_action()