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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
<!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::FileChooserDialog Class Reference</h1>A GtkFileChooserDialog C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="filechooserdialog_8hh-source.html">gfc/gtk/filechooserdialog.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::FileChooserDialog:
<p><center><img src="classGFC_1_1Gtk_1_1FileChooserDialog.png" usemap="#GFC::Gtk::FileChooserDialog_map" border="0" alt=""></center>
<map name="GFC::Gtk::FileChooserDialog_map">
<area href="classGFC_1_1Gtk_1_1Dialog.html" alt="GFC::Gtk::Dialog" shape="rect" coords="113,448,330,472">
<area href="classGFC_1_1Gtk_1_1FileChooser.html" alt="GFC::Gtk::FileChooser" shape="rect" coords="340,448,557,472">
<area href="classGFC_1_1Gtk_1_1Window.html" alt="GFC::Gtk::Window" shape="rect" coords="113,392,330,416">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="340,392,557,416">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="113,336,330,360">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="340,336,557,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="113,280,330,304">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="340,280,557,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="113,224,330,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,217,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="227,168,444,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,217,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="227,112,444,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,217,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="227,56,444,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,217,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="227,0,444,24">
<area href="classGFC_1_1Gtk_1_1FileChooserOpenDialog.html" alt="GFC::Gtk::FileChooserOpenDialog" shape="rect" coords="113,560,330,584">
<area href="classGFC_1_1Gtk_1_1FileChooserSaveAsDialog.html" alt="GFC::Gtk::FileChooserSaveAsDialog" shape="rect" coords="340,560,557,584">
</map>
<a href="classGFC_1_1Gtk_1_1FileChooserDialog-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z526_1">FileChooserDialog</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &title, <a class="el" href="namespaceGFC_1_1Gtk.html#a347">FileChooserAction</a> action, const char *backend=0)
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> with no parent. <a href="#z526_1"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z526_3">FileChooserDialog</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &title, <a class="el" href="classGFC_1_1Gtk_1_1Window.html">Window</a> *parent, <a class="el" href="namespaceGFC_1_1Gtk.html#a347">FileChooserAction</a> action, const char *backend=0)
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a>. <a href="#z526_3"></a><br></dl><li><a class="anchor" name="z526_4" doxytag="GFC::Gtk::FileChooserDialog::~FileChooserDialog" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z526_4">~FileChooserDialog</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z527_0" doxytag="GFC::Gtk::FileChooserDialog::gtk_file_chooser_dialog" ></a>
GtkFileChooserDialog * <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z527_0">gtk_file_chooser_dialog</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkFileChooserDialog structure. <br></dl><li><a class="anchor" name="z527_1" doxytag="GFC::Gtk::FileChooserDialog::operator GtkFileChooserDialog *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z527_1">operator GtkFileChooserDialog *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> to a GtkFileChooserDialog pointer. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html#z525_0">FileChooserDialog</a> (GtkFileChooserDialog *dialog, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> from an existing GtkFileChooserDialog. <a href="#z525_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkFileChooserDialog C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> is a dialog box suitable for use with "File/Open" or "File/Save as" commands. This widget works by putting a <a class="el" href="classGFC_1_1Gtk_1_1FileChooserWidget.html">Gtk::FileChooserWidget</a> inside a <a class="el" href="classGFC_1_1Gtk_1_1Dialog.html">Gtk::Dialog</a>. It exposes the <a class="el" href="classGFC_1_1Gtk_1_1FileChooser.html">Gtk::FileChooser</a> interface, so you can use all of the <a class="el" href="classGFC_1_1Gtk_1_1FileChooser.html">Gtk::FileChooser</a> functions on the file chooser dialog as well as those for <a class="el" href="classGFC_1_1Gtk_1_1Dialog.html">Gtk::Dialog</a>. To add buttons to the dialog call <a class="el" href="classGFC_1_1Gtk_1_1Dialog.html#z478_2">Gtk::Dialog::add_button()</a>.<p>
Note that <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> does not have any methods of its own. Instead, you should use the functions that work on a <a class="el" href="classGFC_1_1Gtk_1_1FileChooser.html">Gtk::FileChooser</a>.<p>
<b>Example:</b> Typical usage<p>
In the simplest of cases, you can use <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> as in the following code: <div class="fragment"><pre> Gtk::FileChooserDialog dialog(<span class="stringliteral">"Open File"</span>, parent_window, Gtk::FILE_CHOOSER_ACTION_OPEN);
dialog->add_button(Gtk::StockId::CANCEL, Gtk::RESPONSE_CANCEL);
dialog->add_button(Gtk::StockId::OPEN, Gtk::RESPONSE_ACCEPT);
<span class="keywordflow">if</span> (dialog->run() == Gtk::RESPONSE_ACCEPT)
{
String filename = dialog->get_filename();
open_file(filename.c_str());
}
</pre></div><p>
<b>Response Codes</b><p>
<a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> inherits from <a class="el" href="classGFC_1_1Gtk_1_1Dialog.html">Gtk::Dialog</a>, so buttons that go in its action area have response codes such as <a class="el" href="namespaceGFC_1_1Gtk.html#a314a29">Gtk::RESPONSE_ACCEPT</a> and <a class="el" href="namespaceGFC_1_1Gtk.html#a314a32">Gtk::RESPONSE_CANCEL</a>. In the above example the calls to <a class="el" href="classGFC_1_1Gtk_1_1Dialog.html#z478_2">add_button()</a> adds stock "Cancel" and "Open" buttons that use the response indentifiers from <a class="el" href="namespaceGFC_1_1Gtk.html#a314">Gtk::ResponseType</a>. For most dialog boxes you can use your own custom response codes rather than the ones in <a class="el" href="namespaceGFC_1_1Gtk.html#a314">Gtk::ResponseType</a>, but <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">Gtk::FileChooserDialog</a> assumes that its "accept"-type action, e.g. an "Open" or "Save" button, will have one of the following response codes:<ul>
<li><a class="el" href="namespaceGFC_1_1Gtk.html#a314a29">Gtk::RESPONSE_ACCEPT</a></li><li><a class="el" href="namespaceGFC_1_1Gtk.html#a314a31">Gtk::RESPONSE_OK</a></li><li><a class="el" href="namespaceGFC_1_1Gtk.html#a314a34">Gtk::RESPONSE_YES</a></li><li><a class="el" href="namespaceGFC_1_1Gtk.html#a314a36">Gtk::RESPONSE_APPLY</a></li></ul>
<p>
This is because <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">Gtk::FileChooserDialog</a> must intercept responses and switch to folders if appropriate, rather than letting the dialog terminate the implementation uses these known response codes to know which responses can be blocked if appropriate.<p>
<b>Note:</b> Make sure you use a stock response code when you use <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">Gtk::FileChooserDialog</a> to ensure proper operation.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z525_0" doxytag="GFC::Gtk::FileChooserDialog::FileChooserDialog" ></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"> GFC::Gtk::FileChooserDialog::FileChooserDialog </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkFileChooserDialog * </td>
<td class="mdname" nowrap> <em>dialog</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> from an existing GtkFileChooserDialog.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>dialog</em> </td><td>A pointer to a GtkFileChooserDialog. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>dialog</em> can be a newly created GtkFileChooserDialog or an existing GtkFileChooserDialog (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z526_1" doxytag="GFC::Gtk::FileChooserDialog::FileChooserDialog" ></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"> GFC::Gtk::FileChooserDialog::FileChooserDialog </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>title</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a347">FileChooserAction</a> </td>
<td class="mdname" nowrap> <em>action</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>backend</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a> with no parent.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>title</em> </td><td>The title of the dialog, or null. </td></tr>
<tr><td></td><td valign=top><em>action</em> </td><td>Open or save mode for the dialog. </td></tr>
<tr><td></td><td valign=top><em>backend</em> </td><td>The name of the specific filesystem backend to use, or null for the default. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z526_3" doxytag="GFC::Gtk::FileChooserDialog::FileChooserDialog" ></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"> GFC::Gtk::FileChooserDialog::FileChooserDialog </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>title</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_1Window.html">Window</a> * </td>
<td class="mdname" nowrap> <em>parent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a347">FileChooserAction</a> </td>
<td class="mdname" nowrap> <em>action</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>backend</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1FileChooserDialog.html">FileChooserDialog</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>title</em> </td><td>The title of the dialog, or null. </td></tr>
<tr><td></td><td valign=top><em>parent</em> </td><td>The transient parent of the dialog. </td></tr>
<tr><td></td><td valign=top><em>action</em> </td><td>Open or save mode for the dialog. </td></tr>
<tr><td></td><td valign=top><em>backend</em> </td><td>The name of the specific filesystem backend to use, or null for the default. </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="filechooserdialog_8hh-source.html">filechooserdialog.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:39 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>
|