/usr/share/doc/liblablgtk-extras-ocaml-dev/html/api/Gtksv_utils.html is in liblablgtk-extras-ocaml-doc 1.5-1.
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 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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Gtke_version.html">
<link rel="next" href="Okey.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Configwin" rel="Chapter" href="Configwin.html">
<link title="Configwin_keys" rel="Chapter" href="Configwin_keys.html">
<link title="Gdir" rel="Chapter" href="Gdir.html">
<link title="Gmylist" rel="Chapter" href="Gmylist.html">
<link title="Gmytree" rel="Chapter" href="Gmytree.html">
<link title="Gstuff" rel="Chapter" href="Gstuff.html">
<link title="Gtke_install" rel="Chapter" href="Gtke_install.html">
<link title="Gtke_version" rel="Chapter" href="Gtke_version.html">
<link title="Gtksv_utils" rel="Chapter" href="Gtksv_utils.html">
<link title="Okey" rel="Chapter" href="Okey.html"><link title="Languages" rel="Section" href="#2_Languages">
<link title="Styles" rel="Section" href="#2_Styles">
<link title="Sourceview props" rel="Section" href="#2_Sourceviewprops">
<link title="Choosing style scheme" rel="Section" href="#2_Choosingstylescheme">
<link title="Setting sourceview props" rel="Section" href="#2_Settingsourceviewprops">
<title>Lablgtk-extras : Gtksv_utils</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Gtke_version.html" title="Gtke_version">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Okey.html" title="Okey">Next</a>
</div>
<h1>Module <a href="type_Gtksv_utils.html">Gtksv_utils</a></h1>
<pre><span class="keyword">module</span> Gtksv_utils: <code class="code">sig</code> <a href="Gtksv_utils.html">..</a> <code class="code">end</code></pre><div class="info module top">
Using the same sourceview preferences through all applications
which use the LablGtkSourceView2 library.
<p>
Use the <code class="code">source_language_manager</code> and <code class="code">source_style_scheme_manager</code>
below to get the languages to use in your code views.<br>
<b>Author(s):</b> Maxence Guesdon<br>
<b>Version:</b> 1.0<br>
</div>
<hr width="100%">
<br>
<h2 id="2_Languages">Languages</h2><br>
<pre><span id="VALsource_language_manager"><span class="keyword">val</span> source_language_manager</span> : <code class="type">GSourceView2.source_language_manager</code></pre>
<pre><span id="VALsort_languages_by_name"><span class="keyword">val</span> sort_languages_by_name</span> : <code class="type">GSourceView2.source_language list -> GSourceView2.source_language list</code></pre><div class="info ">
Sort the given list of languages by name.<br>
</div>
<pre><span id="VALavailable_source_languages"><span class="keyword">val</span> available_source_languages</span> : <code class="type">?manager:GSourceView2.source_language_manager -><br> unit -> GSourceView2.source_language list</code></pre><div class="info ">
<code class="code">available_source_languages ()</code> returns the list of languages known by the
language_manager.<br>
</div>
<div class="param_info"><code class="code">manager</code> : can be given to use an alternative language_manager</div>
<pre><span id="VALsource_language_by_name"><span class="keyword">val</span> source_language_by_name</span> : <code class="type">?manager:GSourceView2.source_language_manager -><br> string -> GSourceView2.source_language option</code></pre><div class="info ">
<code class="code">source_language_by_name ?manager name</code> returns the language with
the given name, or <code class="code">None</code> if no such language was found.<br>
</div>
<br>
<h2 id="2_Styles">Styles</h2><br>
<pre><span id="VALsource_style_scheme_manager"><span class="keyword">val</span> source_style_scheme_manager</span> : <code class="type">GSourceView2.source_style_scheme_manager</code></pre><div class="info ">
This source style scheme manager has an extended search path to
look for styles in the user's ~/.mlgtksourceview2 directory first.<br>
</div>
<pre><span id="VALavailable_source_style_schemes"><span class="keyword">val</span> available_source_style_schemes</span> : <code class="type">?manager:GSourceView2.source_style_scheme_manager -><br> unit -> GSourceView2.source_style_scheme list</code></pre>
<pre><span id="VALsource_style_scheme_by_name"><span class="keyword">val</span> source_style_scheme_by_name</span> : <code class="type">?manager:GSourceView2.source_style_scheme_manager -><br> string -> GSourceView2.source_style_scheme option</code></pre><div class="info ">
<code class="code">source_style_scheme_by_name ?manager name</code> returns the style scheme with
the given name, or <code class="code">None</code> if no such style scheme was found.<br>
</div>
<pre><span id="VALstore_style_scheme_selection"><span class="keyword">val</span> store_style_scheme_selection</span> : <code class="type">GSourceView2.source_style_scheme option -> unit</code></pre><div class="info ">
Store the name of the given style scheme in the user's personal files.<br>
</div>
<pre><span id="VALread_style_scheme_selection"><span class="keyword">val</span> read_style_scheme_selection</span> : <code class="type">?manager:GSourceView2.source_style_scheme_manager -><br> unit -> GSourceView2.source_style_scheme option</code></pre><div class="info ">
Read the name of the selected style scheme from the user's personal files.<br>
</div>
<div class="param_info"><code class="code">manager</code> : can specify the style scheme manager to use instead of
<a href="Gtksv_utils.html#VALsource_style_scheme_manager"><code class="code">Gtksv_utils.source_style_scheme_manager</code></a>.</div>
<pre><span id="VALsource_style_scheme"><span class="keyword">val</span> source_style_scheme</span> : <code class="type">unit -> GSourceView2.source_style_scheme option</code></pre><div class="info ">
Return the currently selected style scheme, if any.<br>
</div>
<pre><span id="VALset_source_style_scheme"><span class="keyword">val</span> set_source_style_scheme</span> : <code class="type">GSourceView2.source_style_scheme option -> unit</code></pre><div class="info ">
Set the currently selected style scheme, if any.<br>
</div>
<pre><span id="VALregister_source_buffer"><span class="keyword">val</span> register_source_buffer</span> : <code class="type">GSourceView2.source_buffer -> unit</code></pre><div class="info ">
Register a source buffer so that each time the scheme returned
by <a href="Gtksv_utils.html#VALsource_style_scheme"><code class="code">Gtksv_utils.source_style_scheme</code></a> changes, the new scheme is set in
the buffer. It is also set when registering the buffer.<br>
</div>
<pre><span id="VALunregister_source_buffer"><span class="keyword">val</span> unregister_source_buffer</span> : <code class="type">GSourceView2.source_buffer -> unit</code></pre><div class="info ">
Unregister the given source buffer.<br>
</div>
<pre><span id="VALapply_source_style_scheme_to_registered_buffers"><span class="keyword">val</span> apply_source_style_scheme_to_registered_buffers</span> : <code class="type">GSourceView2.source_style_scheme option -> unit</code></pre><div class="info ">
Apply the given style scheme to the registered buffers.<br>
</div>
<br>
<h2 id="2_Sourceviewprops">Sourceview props</h2><br>
<pre><span id="TYPEsource_view_props"><span class="keyword">type</span> <code class="type"></code>source_view_props</span> </pre>
<pre><span id="VALstore_sourceview_props"><span class="keyword">val</span> store_sourceview_props</span> : <code class="type"><a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a> -> unit</code></pre><div class="info ">
Store the given source view properties in the user's personal files.<br>
</div>
<pre><span id="VALread_sourceview_props"><span class="keyword">val</span> read_sourceview_props</span> : <code class="type">unit -> <a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a></code></pre><div class="info ">
Read the source view properties from the user's personal files.
If there is no properties file, default properties are returned.<br>
</div>
<pre><span id="VALregister_source_view"><span class="keyword">val</span> register_source_view</span> : <code class="type">GSourceView2.source_view -> unit</code></pre><div class="info ">
Register a source view so that each time the function <a href="Gtksv_utils.html#VALread_sourceview_props"><code class="code">Gtksv_utils.read_sourceview_props</code></a>
is called, the properties read are applied to every registered view.
The sourceview is automatically unregistered when it is destroyed.<br>
</div>
<pre><span id="VALapply_sourceview_props"><span class="keyword">val</span> apply_sourceview_props</span> : <code class="type">GSourceView2.source_view -> <a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a> -> unit</code></pre><div class="info ">
Apply the given source view properties to the given source view.<br>
</div>
<pre><span id="VALapply_sourceview_props_to_registered"><span class="keyword">val</span> apply_sourceview_props_to_registered</span> : <code class="type"><a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a> -> unit</code></pre><div class="info ">
Apply the given source view properties to the registered views.<br>
</div>
<br>
<h2 id="2_Choosingstylescheme">Choosing style scheme</h2><br>
<pre><span name="TYPEsource_style_scheme_box"><span class="keyword">class</span> <a href="Gtksv_utils.source_style_scheme_box-c.html">source_style_scheme_box</a></span> : <code class="type">?manager:GSourceView2.source_style_scheme_manager -> ?current:GSourceView2.source_style_scheme option -> ?preview:GSourceView2.source_style_scheme option -> unit -> unit -> </code><code class="code">object</code> <a href="Gtksv_utils.source_style_scheme_box-c.html">..</a> <code class="code">end</code></pre><div class="info">
This box can be used to make the user set the source style scheme.
</div>
<pre><span id="VALedit_source_style_scheme"><span class="keyword">val</span> edit_source_style_scheme</span> : <code class="type">?modal:bool -><br> ?manager:GSourceView2.source_style_scheme_manager -><br> ?current:GSourceView2.source_style_scheme option -><br> ?preview:(GSourceView2.source_style_scheme option -> unit) -> unit -> unit</code></pre><div class="info ">
Make the user set his source style scheme.
Then <a href="Gtksv_utils.html#VALstore_style_scheme_selection"><code class="code">Gtksv_utils.store_style_scheme_selection</code></a> is used to save the changes or
<a href="Gtksv_utils.html#VALread_style_scheme_selection"><code class="code">Gtksv_utils.read_style_scheme_selection</code></a> is used to restore the original values.<br>
</div>
<div class="param_info"><code class="code">preview</code> : is the function called to apply the shcheme when
the user makes a change or when he closes the window with "Ok".</div>
<br>
<h2 id="2_Settingsourceviewprops">Setting sourceview props</h2><br>
<pre><span name="TYPEsourceview_props_box"><span class="keyword">class</span> <a href="Gtksv_utils.sourceview_props_box-c.html">sourceview_props_box</a></span> : <code class="type">(<a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a> -> unit) -> </code><code class="code">object</code> <a href="Gtksv_utils.sourceview_props_box-c.html">..</a> <code class="code">end</code></pre><div class="info">
This box can be used to make the user set source view properties.
</div>
<pre><span id="VALedit_sourceview_props"><span class="keyword">val</span> edit_sourceview_props</span> : <code class="type">?modal:bool -><br> ?preview:(<a href="Gtksv_utils.html#TYPEsource_view_props">source_view_props</a> -> unit) -> unit -> unit</code></pre><div class="info ">
Make the user set his source view properties.
Then <a href="Gtksv_utils.html#VALstore_sourceview_props"><code class="code">Gtksv_utils.store_sourceview_props</code></a> is used to save the changes or
<a href="Gtksv_utils.html#VALread_sourceview_props"><code class="code">Gtksv_utils.read_sourceview_props</code></a> is used to restore the original values.<br>
</div>
<div class="param_info"><code class="code">preview</code> : is the function called to apply the properties when
the user makes a change or when he closes the window with "Ok".</div>
</body></html>
|