root/library/doc/html/classbdm_1_1UIException.html @ 652

Revision 651, 6.9 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: bdm::UIException Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1UIException.html">UIException</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::UIException Class Reference</h1><!-- doxytag: class="bdm::UIException" --><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code>
71<p>
72
73<p>
74<a href="classbdm_1_1UIException-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
75<tr><td></td></tr>
76<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#7b2b53f2265165deea6f7c0cce1aa770">UIException</a> (const string &amp;message)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor.  <a href="#7b2b53f2265165deea6f7c0cce1aa770"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bf477e4ea19abb638fe5b883f09218e"></a><!-- doxytag: member="bdm::UIException::what" ref="1bf477e4ea19abb638fe5b883f09218e" args="() const " -->
81virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#1bf477e4ea19abb638fe5b883f09218e">what</a> () const   throw ()</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overriden method for reporting the error message. <br></td></tr>
84<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top">static string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#864c8a6b9000691ea3e0f2b48b6f9d6a">format_message</a> (const string &amp;reason, const string &amp;path)</td></tr>
86
87</table>
88<hr><a name="_details"></a><h2>Detailed Description</h2>
89Generic exception for reporting configuration errors<p>
90<a class="el" href="ui_page.html">User Infos and their use</a> <hr><h2>Constructor &amp; Destructor Documentation</h2>
91<a class="anchor" name="7b2b53f2265165deea6f7c0cce1aa770"></a><!-- doxytag: member="bdm::UIException::UIException" ref="7b2b53f2265165deea6f7c0cce1aa770" args="(const string &amp;message)" -->
92<div class="memitem">
93<div class="memproto">
94      <table class="memname">
95        <tr>
96          <td class="memname">bdm::UIException::UIException           </td>
97          <td>(</td>
98          <td class="paramtype">const string &amp;&nbsp;</td>
99          <td class="paramname"> <em>message</em>          </td>
100          <td>&nbsp;)&nbsp;</td>
101          <td><code> [inline]</code></td>
102        </tr>
103      </table>
104</div>
105<div class="memdoc">
106
107<p>
108The constructor.
109<p>
110<dl compact><dt><b>Parameters:</b></dt><dd>
111  <table border="0" cellspacing="2" cellpadding="0">
112    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>the reason for throwing the exception. Should be a complete English sentence (or a couple sentences), starting with "UIException: ". </td></tr>
113  </table>
114</dl>
115
116</div>
117</div><p>
118<hr><h2>Member Function Documentation</h2>
119<a class="anchor" name="864c8a6b9000691ea3e0f2b48b6f9d6a"></a><!-- doxytag: member="bdm::UIException::format_message" ref="864c8a6b9000691ea3e0f2b48b6f9d6a" args="(const string &amp;reason, const string &amp;path)" -->
120<div class="memitem">
121<div class="memproto">
122      <table class="memname">
123        <tr>
124          <td class="memname">string bdm::UIException::format_message           </td>
125          <td>(</td>
126          <td class="paramtype">const string &amp;&nbsp;</td>
127          <td class="paramname"> <em>reason</em>, </td>
128        </tr>
129        <tr>
130          <td class="paramkey"></td>
131          <td></td>
132          <td class="paramtype">const string &amp;&nbsp;</td>
133          <td class="paramname"> <em>path</em></td><td>&nbsp;</td>
134        </tr>
135        <tr>
136          <td></td>
137          <td>)</td>
138          <td></td><td></td><td><code> [static, protected]</code></td>
139        </tr>
140      </table>
141</div>
142<div class="memdoc">
143
144<p>
145Formats error messages for derived classes, which use a Setting path in addition to the message.
146</div>
147</div><p>
148<hr>The documentation for this class was generated from the following files:<ul>
149<li><a class="el" href="user__info_8h_source.html">user_info.h</a><li>user_info.cpp</ul>
150</div>
151<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp;
152<a href="http://www.doxygen.org/index.html">
153<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
154</body>
155</html>
Note: See TracBrowser for help on using the browser.