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

Revision 614, 6.9 kB (checked in by smidl, 15 years ago)

doc

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