/usr/share/gtk-doc/html/pygtksourceview2/class-gtksourcelanguage2.html is in python-gtksourceview2 2.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtksourceview2.Language</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="PyGtksourceview2 Reference Manual"><link rel="up" href="index.html" title="PyGtksourceview2 Reference Manual"><link rel="prev" href="class-gtksourcegutter2.html" title="gtksourceview2.Gutter"><link rel="next" href="class-gtksourcelanguagemanager2.html" title="gtksourceview2.LanguageManager"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtksourceview2.Language</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtksourcegutter2.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="class-gtksourcelanguagemanager2.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="class-gtksourcelanguage2"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtksourceview2.Language</h2><p>gtksourceview2.Language — Source language object for <a class="link" href="class-gtksourceview2.html" title="gtksourceview2.View">gtksourceview2.View</a></p></div><div class="refsect1"><a name="idm2621"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtksourceview2.Language</span></span>(<span class="ooclass"><span class="classname"><a
href="../pygobject/class-gobject.html"
>gobject.GObject</a></span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-globs" title="gtksourceview2.Language.get_globs">get_globs</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-hidden" title="gtksourceview2.Language.get_hidden">get_hidden</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-id" title="gtksourceview2.Language.get_id">get_id</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-metadata" title="gtksourceview2.Language.get_metadata">get_metadata</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-mime-types" title="gtksourceview2.Language.get_mime_types">get_mime_types</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-name" title="gtksourceview2.Language.get_name">get_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-section" title="gtksourceview2.Language.get_section">get_section</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-style-ids" title="gtksourceview2.Language.get_style_ids">get_style_ids</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-style-name" title="gtksourceview2.Language.get_style_name">get_style_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>style_id</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1"><a name="idm2667"></a><h2>Ancestry</h2><pre class="synopsis">+-- <a
href="../pygobject/class-gobject.html"
>gobject.GObject</a>
+-- <a class="link" href="class-gtksourcelanguage2.html" title="gtksourceview2.Language">gtksourceview2.Language</a>
</pre></div><div class="refsect1"><a name="description-gtksourcelanguage"></a><h2>Description</h2><p>
A source code language description.
</p></div><div class="refsect1"><a name="idm2675"></a><h2>Methods</h2><div class="refsect2"><a name="method-gtksourcelanguage2--get-globs"></a><h3>gtksourceview2.Language.get_globs</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_globs</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a list containing the globs or <code class="literal">None</code>
if no globs are found.</td></tr></tbody></table><p>
The <code class="methodname">get_globs</code>() method returns the globs associated to this language.
This is just an utility wrapper around
<code class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-metadata" title="gtksourceview2.Language.get_metadata">gtksourceview2.Language.get_metadata</a></code>()
to retrieve the "globs" metadata property and split it into an array.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-hidden"></a><h3>gtksourceview2.Language.get_hidden</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_hidden</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the language should be hidden,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>
The <code class="methodname">get_hidden</code>() method
returns whether the language should be hidden from the user.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-id"></a><h3>gtksourceview2.Language.get_id</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_id</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the ID of language.</td></tr></tbody></table><p>
The <code class="methodname">get_id</code>() method
returns the ID of the language. The ID is not locale-dependent.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-metadata"></a><h3>gtksourceview2.Language.get_metadata</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_metadata</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>metadata property name.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>value of property name stored in the metadata of language
or <code class="literal">None</code> if language doesn't contain that metadata property.</td></tr></tbody></table><p>
The <code class="methodname">get_metadata</code>() method
returns the value of property name stored in the metadata of language.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-mime-types"></a><h3>gtksourceview2.Language.get_mime_types</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_mime_types</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a list of mime types (strings).</td></tr></tbody></table><p>
The <code class="methodname">get_mime_types</code>() method returns a list of mime types for the given <em class="parameter"><code>language</code></em>.
This is just an utility wrapper around <code class="methodname"><a class="link" href="class-gtksourcelanguage2.html#method-gtksourcelanguage2--get-metadata" title="gtksourceview2.Language.get_metadata">get_metadata</a></code>
to retrieve the "mimetypes" metadata property and split it into a list.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-name"></a><h3>gtksourceview2.Language.get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the name of <em class="parameter"><code>language</code></em>.</td></tr></tbody></table><p>
The <code class="methodname">get_name</code>() method returns the localized name of the language.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-section"></a><h3>gtksourceview2.Language.get_section</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_section</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the section of <em class="parameter"><code>language</code></em>.</td></tr></tbody></table><p>
The <code class="methodname">get_section</code>() method returns the localized section of the language.
Each language belong to a section (ex. HTML belogs to the Markup section)
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-style-ids"></a><h3>gtksourceview2.Language.get_style_ids</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_style_ids</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a list containing ids of the styles defined by this
language or <code class="literal">None</code> if no style is defined.</td></tr></tbody></table><p>
The <code class="methodname">get_style_ids</code>() method
returns the ids of the styles defined by this language.
</p></div><div class="refsect2"><a name="method-gtksourcelanguage2--get-style-name"></a><h3>gtksourceview2.Language.get_style_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_style_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>style_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>style_id</code></strong> :</span></p></td><td>a style ID.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the name of the style with ID style_id defined by this
language or <code class="literal">None</code> if the style has no name or there is
no style with ID defined by this language</td></tr></tbody></table><p>
The <code class="methodname">get_style_name</code>() method
returns the name of the style with ID <em class="parameter"><code>style_id</code></em> defined by this language.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtksourcegutter2.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="class-gtksourcelanguagemanager2.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtksourceview2.Gutter </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtksourceview2.LanguageManager</td></tr></table></div></body></html>
|