<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>bakery: App.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2-20100208 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <h1>App.h</h1><a href="App_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * Copyright 2000 Murray Cumming</span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Library General Public</span> <a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> * Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"> *</span> <a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment"> * License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment"> */</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef BAKERY_APP_H</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define BAKERY_APP_H</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <<a class="code" href="AppInstanceManager_8h.html">bakery/App/AppInstanceManager.h</a>></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <glibmm/object.h></span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#include <vector></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <list></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <map></span> <a name="l00028"></a>00028 <a name="l00029"></a><a class="code" href="namespaceBakery.html">00029</a> <span class="keyword">namespace </span>Bakery <a name="l00030"></a>00030 { <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span> <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="keyword">class </span>HelpInfo <a name="l00034"></a>00034 { <a name="l00035"></a>00035 <span class="keyword">public</span>: <a name="l00036"></a>00036 <span class="keyword">typedef</span> std::vector<Glib::ustring> type_vecStrings; <a name="l00037"></a>00037 Glib::ustring m_strVersion, m_strCopyright, m_strDescription, m_strTranslatorCredits; <a name="l00038"></a>00038 <a name="l00039"></a>00039 type_vecStrings m_vecAuthors, m_vecDocumenters; <a name="l00040"></a>00040 }; <a name="l00041"></a>00041 <span class="preprocessor">#endif //DOXYGEN_SHOULD_SKIP_THIS</span> <a name="l00042"></a>00042 <span class="preprocessor"></span> <a name="l00060"></a><a class="code" href="classBakery_1_1App.html">00060</a> <span class="keyword">class </span><a class="code" href="classBakery_1_1App.html" title="Bakery&#39;s Main Window.">App</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> Glib::ObjectBase <a name="l00061"></a>00061 { <a name="l00062"></a>00062 <span class="keyword">public</span>: <a name="l00063"></a><a class="code" href="classBakery_1_1App.html#abf8b8a647f42e60bf7b4105d490f6843">00063</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBakery_1_1AppInstanceManager.html" title="Contains a list of App instances.">AppInstanceManager</a>; <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="comment">//The constructor has a default argument so that there is a default constructor,</span> <a name="l00066"></a>00066 <span class="comment">//so that derived classes do not need to call a specific constructor. This is</span> <a name="l00067"></a>00067 <span class="comment">//a virtual base class so they would otherwise need to do that.</span> <a name="l00068"></a>00068 <a name="l00070"></a>00070 <a class="code" href="classBakery_1_1App.html#ad3c7958ad144b6e0fc338c1060c58533" title="Don&#39;t forget to call init() too.">App</a>(<span class="keyword">const</span> Glib::ustring& appname = Glib::ustring()); <a name="l00071"></a>00071 <a name="l00072"></a>00072 <span class="keyword">virtual</span> <a class="code" href="classBakery_1_1App.html#a747f548f963caa36db606e8abfd7ed19">~App</a>(); <a name="l00073"></a>00073 <a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a1002eaf2f92bb07e39a639a6d87f676e">init</a>(); <span class="comment">//Sets it up and shows it.</span> <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="comment">//'About Box' information:</span> <a name="l00077"></a><a class="code" href="classBakery_1_1App.html#a150f4eeef23ffdd5bdd85668c4f09f13">00077</a> <span class="keyword">typedef</span> std::vector<Glib::ustring> <a class="code" href="classBakery_1_1App.html#a150f4eeef23ffdd5bdd85668c4f09f13">type_vecStrings</a>; <a name="l00078"></a>00078 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ad40033bdd4a52fa7334a4581fae9d314">set_about_information</a>(<span class="keyword">const</span> Glib::ustring& strVersion, <span class="keyword">const</span> <a class="code" href="classBakery_1_1App.html#a150f4eeef23ffdd5bdd85668c4f09f13">type_vecStrings</a>& vecAuthors, <span class="keyword">const</span> Glib::ustring& strCopyright, <span class="keyword">const</span> Glib::ustring& strDescription); <a name="l00079"></a>00079 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ad40033bdd4a52fa7334a4581fae9d314">set_about_information</a>(<span class="keyword">const</span> Glib::ustring& strVersion, <span class="keyword">const</span> <a class="code" href="classBakery_1_1App.html#a150f4eeef23ffdd5bdd85668c4f09f13">type_vecStrings</a>& vecAuthors, <span class="keyword">const</span> Glib::ustring& strCopyright, <span class="keyword">const</span> Glib::ustring& strDescription, <span class="keyword">const</span> <a class="code" href="classBakery_1_1App.html#a150f4eeef23ffdd5bdd85668c4f09f13">type_vecStrings</a>& vecDocumenters, <span class="keyword">const</span> Glib::ustring& strTranslatorCredits); <a name="l00080"></a>00080 <span class="keyword">virtual</span> Glib::ustring <a class="code" href="classBakery_1_1App.html#ab670117032601ea70d0887dfc865f0cd">get_version</a>() <span class="keyword">const</span>; <a name="l00081"></a>00081 <a name="l00082"></a>00082 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a98f86dd1d8d592ac9e0e87aadadaa857">set_command_line_args</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** &argv); <span class="comment">//Needed for session management.</span> <a name="l00083"></a>00083 <a name="l00084"></a><a class="code" href="classBakery_1_1App.html#a675048569778495a71665ac147c9ed32">00084</a> <span class="keyword">typedef</span> sigc::signal<void> <a class="code" href="classBakery_1_1App.html#a675048569778495a71665ac147c9ed32">type_signal_hide</a>; <a name="l00085"></a>00085 <a class="code" href="classBakery_1_1App.html#a675048569778495a71665ac147c9ed32">type_signal_hide</a> <a class="code" href="classBakery_1_1App.html#aff4148fc8d0f1b1411fffbeb4488936d">ui_signal_hide</a>(); <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="keyword">protected</span>: <a name="l00088"></a>00088 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a7707d96e8dd937a5e950bec7b545ae21">init_app_name</a>(<span class="keyword">const</span> Glib::ustring& appname); <a name="l00089"></a>00089 <a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a211fd1d87fef1e7e11c095f076f0e0a5" title="Builds the intial ui string, with placeholders.">init_ui_manager</a>(); <a name="l00094"></a>00094 <a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ab7effab63ec144e8938249a615128880" title="Override this to add more menus or different menus.">init_menus</a>(); <a name="l00098"></a>00098 <a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#aa40377932456669655b6bbd6e00aa0b1" title="Call this from init_menus() to add the standard file menu.">init_menus_file</a>() = 0; <a name="l00102"></a>00102 <a name="l00105"></a>00105 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a70abd915d970ad9220ce18575454710f" title="Call this from init_menus() to add the standard edit menu.">init_menus_edit</a>() = 0; <a name="l00106"></a>00106 <a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ad42e3e0ceb27a74f4b8a8c7f1fdd0663" title="Call this from init_menus() to add the standard help menu.">init_menus_help</a>() = 0; <a name="l00110"></a>00110 <a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a2d91278e5f5655190c75ccffb6e503a1">init_toolbars</a>(); <a name="l00112"></a>00112 <a name="l00113"></a>00113 <span class="keyword">virtual</span> <a class="code" href="classBakery_1_1App.html" title="Bakery&#39;s Main Window.">App</a>* <a class="code" href="classBakery_1_1App.html#a8f5c9f8e8b87d8301db3a4eb1203c460">new_instance</a>() = 0; <span class="comment">//Must override in order to new() the derived document class.</span> <a name="l00114"></a>00114 <a name="l00115"></a>00115 <span class="comment">// virtual void close_window() = 0;</span> <a name="l00116"></a>00116 <span class="comment">// virtual void bring_to_front() = 0;</span> <a name="l00117"></a>00117 <span class="comment">//Signal handlers:</span> <a name="l00118"></a>00118 <a name="l00119"></a>00119 <span class="keyword">public</span>: <span class="comment">// We can not take function pointers of these methods in a </span> <a name="l00120"></a>00120 <span class="comment">// derived class, if they are protected - for instance, with sigc::mem_fun() </span> <a name="l00121"></a>00121 <span class="comment">//Menus:</span> <a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a50cafb652c4729e283bdef8cbd522240">on_menu_file_new</a>(); <a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a0befac444423c6cda07ff0eb4cca8720">on_menu_file_close</a>(); <a name="l00124"></a>00124 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a42dd01a038beca2b7091755311fc54f6">on_menu_file_exit</a>(); <a name="l00125"></a>00125 <a name="l00126"></a>00126 <span class="comment">//Edit menu handlers overriden in App_WithDoc:</span> <a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a5c7b788c249bc58c92c328e87ac57921">on_menu_edit_cut</a>(); <a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#abe208e7c0a0e34d74eca5f019259d1b4">on_menu_edit_copy</a>(); <a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a2b60ec6f131808edd31c056bc573f374">on_menu_edit_paste</a>(); <a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ae6665e91149e82ad09c2bb7658d2bc2f">on_menu_edit_clear</a>(); <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#af76257bd99691db635c78baa4238a7d7">on_menu_help_about</a>() = 0; <a name="l00133"></a>00133 <a name="l00134"></a>00134 <a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#adf52e2dc6b4aba277659bd20fe336d50">on_about_close</a>(); <a name="l00136"></a>00136 <a name="l00137"></a>00137 <span class="keyword">protected</span>: <a name="l00138"></a>00138 <span class="comment">//GUI abstractions:</span> <a name="l00139"></a>00139 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a1e6fb30895b546a8cf8c2a1c8968d66e">ui_hide</a>() = 0; <a name="l00140"></a>00140 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#a1b94b21d21a3d2b082c66957ec90c595">ui_bring_to_front</a>() = 0; <a name="l00141"></a>00141 <a name="l00142"></a>00142 <span class="comment">//operation_cancelled:</span> <a name="l00143"></a>00143 <span class="comment">//e.g. A File|Open tries to save existing data,</span> <a name="l00144"></a>00144 <span class="comment">//but this needs to be cancelled if the save failed. </span> <a name="l00145"></a>00145 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classBakery_1_1App.html#ad23c34be293a189e6570742f191eed08">set_operation_cancelled</a>(<span class="keywordtype">bool</span> bVal = <span class="keyword">true</span>); <a name="l00146"></a>00146 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classBakery_1_1App.html#a29e72debd43cfd8f8b208d6bc5773ac2">get_operation_cancelled</a>(); <a name="l00147"></a>00147 <a name="l00148"></a>00148 <span class="comment">//Member data:</span> <a name="l00149"></a>00149 <a name="l00150"></a>00150 <span class="comment">//'About Box'/WM Class information:</span> <a name="l00151"></a><a class="code" href="classBakery_1_1App.html#a5fba858657b7674aef0b75aa3f1e26ad">00151</a> <span class="keyword">static</span> Glib::ustring <a class="code" href="classBakery_1_1App.html#a5fba858657b7674aef0b75aa3f1e26ad">m_strAppName</a>; <a name="l00152"></a>00152 <a name="l00153"></a>00153 <span class="comment">//'About Box' information:</span> <a name="l00154"></a><a class="code" href="classBakery_1_1App.html#a9deb94ba642b19dd927a3f07461e7dbd">00154</a> <span class="keyword">static</span> HelpInfo <a class="code" href="classBakery_1_1App.html#a9deb94ba642b19dd927a3f07461e7dbd">m_HelpInfo</a>; <a name="l00155"></a>00155 <a name="l00156"></a>00156 <span class="comment">//Instances</span> <a name="l00157"></a><a class="code" href="classBakery_1_1App.html#a2bb03846b1b53a087d3348a8b2014662">00157</a> <span class="keyword">static</span> <a class="code" href="classBakery_1_1AppInstanceManager.html" title="Contains a list of App instances.">AppInstanceManager</a> <a class="code" href="classBakery_1_1App.html#a2bb03846b1b53a087d3348a8b2014662">m_AppInstanceManager</a>; <a name="l00158"></a>00158 <a name="l00159"></a><a class="code" href="classBakery_1_1App.html#adf00c681d9eaaffce170c891be86a454">00159</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classBakery_1_1App.html#adf00c681d9eaaffce170c891be86a454">m_bOperationCancelled</a>; <span class="comment">//see set/get_operation_cancelled().</span> <a name="l00160"></a>00160 <a name="l00161"></a>00161 <span class="comment">//All instances share 1 About box:</span> <a name="l00162"></a><a class="code" href="classBakery_1_1App.html#a32ce7e0b3510e40059c434b0baf6f9c1">00162</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classBakery_1_1App.html#a32ce7e0b3510e40059c434b0baf6f9c1">m_bAboutShown</a>; <a name="l00163"></a>00163 <a name="l00164"></a>00164 <span class="comment">//Command line args:</span> <a name="l00165"></a><a class="code" href="classBakery_1_1App.html#ae2dc3668c1ecfe8d8a6519d566eccba8">00165</a> <span class="keyword">static</span> Glib::ustring <a class="code" href="classBakery_1_1App.html#ae2dc3668c1ecfe8d8a6519d566eccba8">m_strCommandLine_0</a>; <a name="l00166"></a>00166 <a name="l00167"></a><a class="code" href="classBakery_1_1App.html#af8339d160b9a0586b6856f197af60f99">00167</a> <a class="code" href="classBakery_1_1App.html#a675048569778495a71665ac147c9ed32">type_signal_hide</a> <a class="code" href="classBakery_1_1App.html#af8339d160b9a0586b6856f197af60f99">m_signal_hide</a>; <a name="l00168"></a>00168 <a name="l00169"></a>00169 <a name="l00170"></a>00170 <a name="l00171"></a>00171 <span class="comment">//typedef std::vector<poptOption> type_vecPoptOptions;</span> <a name="l00172"></a>00172 <span class="comment">//type_vecPoptOptions m_vecPoptOptions;</span> <a name="l00173"></a>00173 }; <a name="l00174"></a>00174 <a name="l00175"></a>00175 } <span class="comment">//namespace</span> <a name="l00176"></a>00176 <a name="l00177"></a>00177 <span class="preprocessor">#endif //BAKERY_APP_H</span> </pre></div></div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>