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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::Stock Class Reference</h1>A C++ wrapper class for various stock methods.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="stock_8hh-source.html">gfc/gtk/stock.hh</a>></code>
<p>
<a href="classGFC_1_1Gtk_1_1Stock-members.html">List of all members.</a><h2>Static Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1Stock.html#z842_0">add</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockItem.html">StockItem</a> &item)
<dl class="el"><dd class="mdescRight">Registers a stock item. <a href="#z842_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1Stock.html#z842_1">lookup</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> &stock_id, <a class="el" href="classGFC_1_1Gtk_1_1StockItem.html">StockItem</a> &item)
<dl class="el"><dd class="mdescRight">Fills <em>item</em> with the registered values for stock_id, returning true if stock_id was known. <a href="#z842_1"></a><br></dl><li>std::vector< <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> > <a class="el" href="classGFC_1_1Gtk_1_1Stock.html#z842_2">list_ids</a> ()
<dl class="el"><dd class="mdescRight">Retrieves a list of all known stock IDs added to an <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> or registered with <a class="el" href="classGFC_1_1Gtk_1_1Stock.html#z842_0">add()</a>. <a href="#z842_2"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A C++ wrapper class for various stock methods.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1Stock.html">Stock</a> is a convenience class that wraps the miscellaneous GTK+ stock functions.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z842_0" doxytag="GFC::Gtk::Stock::add" ></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"> void GFC::Gtk::Stock::add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockItem.html">StockItem</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>item</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Registers a stock item.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>item</em> </td><td>The stock item to register.</td></tr>
</table>
</dl>
<br>
If the item already exists with the same stock ID as one of the items, the old item gets replaced. </td>
</tr>
</table>
<a class="anchor" name="z842_2" doxytag="GFC::Gtk::Stock::list_ids" ></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"> std::vector<<a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a>> GFC::Gtk::Stock::list_ids </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves a list of all known stock IDs added to an <a class="el" href="classGFC_1_1Gtk_1_1IconFactory.html">IconFactory</a> or registered with <a class="el" href="classGFC_1_1Gtk_1_1Stock.html#z842_0">add()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A vector of <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> that holds the list of known stock IDs. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z842_1" doxytag="GFC::Gtk::Stock::lookup" ></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 GFC::Gtk::Stock::lookup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> & </td>
<td class="mdname" nowrap> <em>stock_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Gtk_1_1StockItem.html">StockItem</a> & </td>
<td class="mdname" nowrap> <em>item</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fills <em>item</em> with the registered values for stock_id, returning true if stock_id was known.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stock_id</em> </td><td>The stock id for the stock item. </td></tr>
<tr><td></td><td valign=top><em>item</em> </td><td>A stock item to initialize with values. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if item was initialized. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="stock_8hh-source.html">stock.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:42 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|