GtkSourceStyleScheme

GtkSourceStyleScheme — Object controlling the appearance of GtkSourceView

Synopsis

#include <gtksourceview/gtksource.h>

                    GtkSourceStyleScheme;
const gchar *       gtk_source_style_scheme_get_id      (GtkSourceStyleScheme *scheme);
const gchar *       gtk_source_style_scheme_get_name    (GtkSourceStyleScheme *scheme);
const gchar *       gtk_source_style_scheme_get_description
                                                        (GtkSourceStyleScheme *scheme);
const gchar * const * gtk_source_style_scheme_get_authors
                                                        (GtkSourceStyleScheme *scheme);
const gchar *       gtk_source_style_scheme_get_filename
                                                        (GtkSourceStyleScheme *scheme);
GtkSourceStyle *    gtk_source_style_scheme_get_style   (GtkSourceStyleScheme *scheme,
                                                         const gchar *style_id);

Object Hierarchy

  GObject
   +----GtkSourceStyleScheme

Properties

  "description"              gchar*                : Read
  "filename"                 gchar*                : Read
  "id"                       gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read

Description

GtkSourceStyleScheme contains all the text styles to be used in GtkSourceView and GtkSourceBuffer. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, color for the line numbers, etc.

Style schemes are stored in XML files. The format of a scheme file is documented in the style scheme reference.

Details

GtkSourceStyleScheme

typedef struct _GtkSourceStyleScheme GtkSourceStyleScheme;

gtk_source_style_scheme_get_id ()

const gchar *       gtk_source_style_scheme_get_id      (GtkSourceStyleScheme *scheme);

scheme :

a GtkSourceStyleScheme.

Returns :

scheme id.

Since 2.0


gtk_source_style_scheme_get_name ()

const gchar *       gtk_source_style_scheme_get_name    (GtkSourceStyleScheme *scheme);

scheme :

a GtkSourceStyleScheme.

Returns :

scheme name.

Since 2.0


gtk_source_style_scheme_get_description ()

const gchar *       gtk_source_style_scheme_get_description
                                                        (GtkSourceStyleScheme *scheme);

scheme :

a GtkSourceStyleScheme.

Returns :

scheme description (if defined), or NULL.

Since 2.0


gtk_source_style_scheme_get_authors ()

const gchar * const * gtk_source_style_scheme_get_authors
                                                        (GtkSourceStyleScheme *scheme);

scheme :

a GtkSourceStyleScheme.

Returns :

a NULL-terminated array containing the scheme authors or NULL if no author is specified by the style scheme. [array zero-terminated=1][transfer none]

Since 2.0


gtk_source_style_scheme_get_filename ()

const gchar *       gtk_source_style_scheme_get_filename
                                                        (GtkSourceStyleScheme *scheme);

scheme :

a GtkSourceStyleScheme.

Returns :

scheme file name if the scheme was created parsing a style scheme file or NULL in the other cases.

Since 2.0


gtk_source_style_scheme_get_style ()

GtkSourceStyle *    gtk_source_style_scheme_get_style   (GtkSourceStyleScheme *scheme,
                                                         const gchar *style_id);

scheme :

a GtkSourceStyleScheme.

style_id :

id of the style to retrieve.

Returns :

style which corresponds to style_id in the scheme, or NULL when no style with this name found. It is owned by scheme and may not be unref'ed. [transfer none]

Since 2.0

Property Details

The "description" property

  "description"              gchar*                : Read

Style scheme description, a translatable string to present to the user.

Default value: NULL


The "filename" property

  "filename"                 gchar*                : Read

Style scheme filename or NULL.

Default value: NULL


The "id" property

  "id"                       gchar*                : Read / Write / Construct Only

Style scheme id, a unique string used to identify the style scheme in GtkSourceStyleSchemeManager.

Default value: NULL


The "name" property

  "name"                     gchar*                : Read

Style scheme name, a translatable string to present to the user.

Default value: NULL

See Also

GtkSourceStyle, GtkSourceStyleSchemeManager