File: gtksourceview-gtksourcelanguagesmanager.xml

package info (click to toggle)
gnome-python-desktop 2.32.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,548 kB
  • sloc: sh: 10,214; xml: 8,851; ansic: 3,428; python: 1,457; makefile: 664
file content (192 lines) | stat: -rw-r--r-- 7,167 bytes parent folder | download | duplicates (5)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtksourcelanguagesmanager">
  <refnamediv>
    <refname>gtksourceview.SourceLanguagesManager</refname>
    <refpurpose>Languages Manager object for <link linkend="class-gtksourceview">gtksourceview.SourceView</link></refpurpose>
  </refnamediv>

<!-- ******************************************* -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER SYNOPSIS -->
<!-- ******************************************* -->

<refsect1>
  <title>Synopsis</title>
  
  <classsynopsis language="python">
    <ooclass><classname>gtksourceview.SourceLanguagesManager</classname></ooclass>
    <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>

    <constructorsynopsis language="python">
	    <methodname><link linkend="constructor-gtksourcelanguagesmanager">gtksourceview.SourceLanguagesManager</link></methodname>
	    <methodparam><parameter role="keyword"></parameter></methodparam>
    </constructorsynopsis>    

    <methodsynopsis language="python">
	    <methodname><link linkend="method-gtksourcelanguagesmanager--get-available-languages">get_available_languages</link></methodname>
	    <methodparam></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
	    <methodname><link linkend="method-gtksourcelanguagesmanager--get-language-from-mime-type">get_language_from_mime_type</link></methodname>
	    <methodparam></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
	    <methodname><link linkend="method-gtksourcelanguagesmanager--get-lang-files-dirs">get_lang_files_dirs</link></methodname>
	    <methodparam></methodparam>
    </methodsynopsis>
  </classsynopsis>
</refsect1>

<!-- ******************************************* -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER ANCESTRY -->
<!-- ******************************************* -->

<refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtksourcelanguagesmanager">gtksourceview.SourceLanguagesManager</link>
</synopsis>
</refsect1>

<!-- ********************************************* -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER PROPERTIES -->
<!-- ********************************************* -->

<refsect1>
  <title>Properties</title>

  <blockquote role="properties">
    <informaltable pgwide="1" frame="none">
	    <tgroup cols="3">
	    <colspec column="1" colwidth="1in"/>
	    <colspec column="2" colwidth="1in"/>
	    <colspec column="3" colwidth="3in"/>
	    <tbody>

	    <row valign="top">
	      <entry>"lang-files-dirs"</entry>
	      <entry>Read-Write</entry>
	      <entry>fixme</entry>
	    </row>
      </tbody>
	    </tgroup>
    </informaltable>
  </blockquote>
</refsect1>


<!-- ********************************************** -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER DESCRIPTION -->
<!-- ********************************************** -->

<refsect1 id="description-gtktextlanguagesmanager">
    <title>Description</title>

<para>

</para>
</refsect1>


<!-- ********************************************** -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER CONSTRUCTOR -->
<!-- ********************************************** -->

<refsect1 id="constructor-gtksourcelanguagesmanager">
  <title>Constructor</title>

  <programlisting><constructorsynopsis language="python">
	  <methodname>gtksourceview.SourceLanguagesManager</methodname>
	  <methodparam><parameter role="keyword"></parameter></methodparam>
  </constructorsynopsis></programlisting>
    
  <variablelist>
    <varlistentry>
	    <term><emphasis>Returns</emphasis>&nbsp;:</term>
	    <listitem><simpara>a new <link linkend="class-gtksourcelanguagesmanager"><classname>gtksourceview.SourceLanguagesManager</classname></link>.</simpara></listitem>
    </varlistentry>
  </variablelist>

  <para>
    Creates a new <link linkend="class-gtksourcelanguagesmanager"><classname>gtksourceview.SourceLanguagesManager</classname></link> object.
  </para>
</refsect1>

<!-- ****************************************** -->
<!-- BEGIN OF GTKSOURCELANGUAGESMANAGER METHODS -->
<!-- ****************************************** -->

<refsect1>
  <title>Methods</title>

  <refsect2 id="method-gtksourcelanguagesmanager--get-available-languages">
    <title>gtksourceview.SourceLanguagesManager.get_available_languages</title>
    <programlisting><methodsynopsis language="python">
	  <methodname>get_available_languages</methodname>
	  <methodparam></methodparam>
	  </methodsynopsis></programlisting>
      
    <variablelist>
	    <varlistentry>
	      <term><emphasis>Returns</emphasis>&nbsp;:</term>
	      <listitem><simpara>	a list of <link linkend="class-gtksourcelanguage"><classname>gtksourceview.SourceLanguage</classname></link>.</simpara></listitem>
	    </varlistentry>
    </variablelist>

    <para>
      The <methodname>get_available_languages</methodname>() method gets a list of available languages for the given language manager.
	  </para>
  </refsect2>


  <refsect2 id="method-gtksourcelanguagesmanager--get-language-from-mime-type">
    <title>gtksourceview.SourceLanguagesManager.get_language_from_mime_type</title>
    <programlisting><methodsynopsis language="python">
	  <methodname>get_language_from_mime_type</methodname>
	  <methodparam>mime_type</methodparam>
	  </methodsynopsis></programlisting>
      
    <variablelist>
	    <varlistentry>
	      <term><emphasis>mime_type</emphasis>&nbsp;:</term>
	      <listitem><simpara>	a mime type.</simpara></listitem>
	    </varlistentry>
      <varlistentry>
	      <term><emphasis>Returns</emphasis>&nbsp;:</term>
	      <listitem><simpara>	a <link linkend="class-gtksourcelanguage"><classname>gtksourceview.SourceLanguage</classname></link> 
        or <literal>None </literal> if there is no language associated with the given <parameter>mime_type</parameter>.</simpara></listitem>
	    </varlistentry>
    </variablelist>

    <para>
      The <methodname>get_language_from_mime_type</methodname>() method gets the 
      <link linkend="class-gtksourcelanguage"><classname>gtksourceview.SourceLanguage</classname></link> 
      which is associated with the given <parameter>mime_type</parameter> in the language manager.
	  </para>
  </refsect2>

  <refsect2 id="method-gtksourcelanguagesmanager--get-lang-files-dirs">
    <title>gtksourceview.SourceLanguagesManager.get_lang_files_dirs</title>
    <programlisting><methodsynopsis language="python">
	  <methodname>get_lang_files_dirs</methodname>
	  <methodparam></methodparam>
	  </methodsynopsis></programlisting>
      
    <variablelist>
	    <varlistentry>
	      <term><emphasis>Returns</emphasis>&nbsp;:</term>
	      <listitem><simpara> a list of language files directories (as strings).</simpara></listitem>
	    </varlistentry>
    </variablelist>

    <para>
      The <methodname>get_lang_files_dirs</methodname>() method gets a list of language files directories for the given language manager.
	  </para>
  </refsect2>

</refsect1> 
</refentry>