File: classInti_1_1Gtk_1_1SourceStyleScheme.html

package info (click to toggle)
inti-sourceview 0.6.0-4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,220 kB
  • ctags: 967
  • sloc: sh: 64,518; cpp: 3,137; makefile: 142
file content (222 lines) | stat: -rw-r--r-- 10,981 bytes parent folder | download
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  <title>Main Page - Header</title>
  <link href="inti.css" rel="stylesheet" type="text/css">
  <meta name="description" content="Reference Manual">
  <meta name="author" content="The Inti Development Team">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(231, 232, 231);"
 link="#000099" vlink="#990099" alink="#000099">
<table cellpadding="0" cellspacing="0" border="0" style="width: 100%;">
  <tbody>
    <tr
 style="color: rgb(255, 255, 204); font-family: helvetica,arial,sans-serif; font-weight: bold;">
      <td
 style="vertical-align: top; background-color: rgb(0, 55, 85); text-align: center;">
      <font size="+1">Reference Manual</font> </td>
    </tr>
    <tr>
      <td valign="top" height="116" background="../images/top-fade.png"
 align="center"><img src="../images/inti-logo.png" alt="Inti Logo"> <br>
      </td>
    </tr>
  </tbody>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.3.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>Inti::Gtk::SourceStyleScheme Class Reference</h1>A GtkSourceStyleScheme C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sourcestylescheme_8h-source.html">inti/gtk-sourceview/sourcestylescheme.h</a>&gt;</code>
<p>
<a href="classInti_1_1Gtk_1_1SourceStyleScheme-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a name="z34_0" doxytag="Inti::Gtk::SourceStyleScheme::gtk_source_style_scheme"></a>
GtkSourceStyleScheme * <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_0">gtk_source_style_scheme</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkSourceStyleScheme structure. <br><br></dl><li><a name="z34_1" doxytag="Inti::Gtk::SourceStyleScheme::gtk_source_style_scheme_class"></a>
GtkSourceStyleSchemeClass * <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_1">gtk_source_style_scheme_class</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkSourceStyleSchemeClass structure. <br><br></dl><li><a name="z34_2" doxytag="Inti::Gtk::SourceStyleScheme::operator GtkSourceStyleScheme *"></a>
<a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_2">operator GtkSourceStyleScheme *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html">SourceStyleScheme</a> to a GtkSourceStyleScheme pointer. <br><br></dl><li><a name="z34_3" doxytag="Inti::Gtk::SourceStyleScheme::is_gtk_source_style_scheme"></a>
bool <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_3">is_gtk_source_style_scheme</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the object instance is of type GTK_TYPE_SOURCE_STYLE_SCHEME. <br><br></dl><li><a name="z34_4" doxytag="Inti::Gtk::SourceStyleScheme::get_name"></a>
String <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_4">get_name</a> () const
<dl class="el"><dd class="mdescRight">Returns the name of the scheme. <br><br></dl><li><a class="el" href="classInti_1_1Gtk_1_1SourceTagStyle.html">SourceTagStyle</a> * <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_5">get_tag_style</a> (const String &amp;style_name) const
<dl class="el"><dd class="mdescRight">Gets the tag style for this scheme. </em> <a href="#z34_5"></a><em><br><br></dl><li>bool <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z34_6">get_style_names</a> (std::vector&lt; String &gt; &amp;names) const
<dl class="el"><dd class="mdescRight">Get a list of the tag style names. </em> <a href="#z34_6"></a><em><br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a name="z35_0" doxytag="Inti::Gtk::SourceStyleScheme::sig_style_changed"></a>
const StyleChangedSignalProxy <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z35_0">sig_style_changed</a> ()
<dl class="el"><dd class="mdescRight">Connect to the style_changed_signal; emitted whenever the tag style changes. <br><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a name="e0" doxytag="Inti::Gtk::SourceStyleScheme::get_default"></a>
<a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html">SourceStyleScheme</a> * <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#e0">get_default</a> ()
<dl class="el"><dd class="mdescRight">Returns a pointer to the default scheme object. <br><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a name="z32_0" doxytag="Inti::Gtk::SourceStyleScheme::~SourceStyleScheme"></a>
virtual <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z32_0">~SourceStyleScheme</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Handlers</div></td></tr>
<ul>
<li>virtual void <a class="el" href="classInti_1_1Gtk_1_1SourceStyleScheme.html#z33_0">on_style_changed</a> (const String &amp;tag_id)
<dl class="el"><dd class="mdescRight">Called whenever the tag style changes. </em> <a href="#z33_0"></a><em><br><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkSourceStyleScheme C++ wrapper class. 
<p>
<hr><h2>Member Function Documentation</h2>
<a name="z34_6" doxytag="Inti::Gtk::SourceStyleScheme::get_style_names"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool Inti::Gtk::SourceStyleScheme::get_style_names </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">std::vector&lt; String &gt; &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>names</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get a list of the tag style names. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>names</em>&nbsp;</td><td>A reference to a std::vector of String to hold the style names. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if <em>names</em> is not empty. </dd></dl>
    </td>
  </tr>
</table>
<a name="z34_5" doxytag="Inti::Gtk::SourceStyleScheme::get_tag_style"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classInti_1_1Gtk_1_1SourceTagStyle.html">SourceTagStyle</a>* Inti::Gtk::SourceStyleScheme::get_tag_style </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>style_name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the tag style for this scheme. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>style_name</em>&nbsp;</td><td>The name of the source tag style. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classInti_1_1Gtk_1_1SourceTagStyle.html">SourceTagStyle</a> for <em>style_name</em>. </dd></dl>
    </td>
  </tr>
</table>
<a name="z33_0" doxytag="Inti::Gtk::SourceStyleScheme::on_style_changed"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void Inti::Gtk::SourceStyleScheme::on_style_changed </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>tag_id</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called whenever the tag style changes. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>tag_id</em>&nbsp;</td><td>The tag identifier for the new style. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sourcestylescheme_8h-source.html">sourcestylescheme.h</a></ul>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>Main Page - Footer</title>
  <meta name="description" content="Reference Manual">
  <meta name="author" content="The Inti Development Team">
</head>
<body>
<br>
<br>
<table cellpadding="0" cellspacing="0" border="0" style="width: 100%;">
  <tbody>
    <tr>
      <td valign="top">
      <hr></td>
    </tr>
    <tr>
      <td valign="top" height="116"
 background="../images/bottom-fade.png">
      <address><small>Generated on Wed Aug 27 21:17:28 2003 for Inti-SourceView by <a
 href="http://www.doxygen.org/index.html"><img src="doxygen.png"
 alt="doxygen" align="middle" border="0" width="110" height="53"> </a>
1.3.2 written by <a href="mailto:dimitri@stack.nl">Dimitri
van Heesch</a>,  &copy;&nbsp;1997-2002</small></address>
      </td>
    </tr>
    <tr>
      <td style="vertical-align: top; background-color: rgb(0, 55, 85);"><br>
      </td>
    </tr>
  </tbody>
</table>
<br>
</body>
</html>