Skip to content
Snippets Groups Projects
Normal view Permalink
class_pic_puzzle_1_1_hints.html 9.38 KiB
Newer Older
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
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 
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>PicPuzzle: PicPuzzle.Hints Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">PicPuzzle
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
Justin's avatar
Added game logic and updated documentation  
Justin committed
45 
<li class="navelem"><b>PicPuzzle</b></li><li class="navelem"><a class="el" href="class_pic_puzzle_1_1_hints.html">Hints</a></li>  </ul>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_pic_puzzle_1_1_hints-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PicPuzzle.Hints Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for PicPuzzle.Hints:</div>
<div class="dyncontent">
<div class="center"><img src="class_pic_puzzle_1_1_hints__coll__graph.png" border="0" usemap="#_pic_puzzle_8_hints_coll__map" alt="Collaboration graph"/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad490bb353404503077d39c592d4aaa2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_hints.html#ad490bb353404503077d39c592d4aaa2b">Hints</a> (<a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> ng, boolean rows)</td></tr>
<tr class="separator:ad490bb353404503077d39c592d4aaa2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a101a52fc931cebf3eae4736843e40121"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_hints.html#a101a52fc931cebf3eae4736843e40121">getHintWidth</a> ()</td></tr>
<tr class="separator:a101a52fc931cebf3eae4736843e40121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a257740aca3112940f31ab25521973536"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_hints.html#a257740aca3112940f31ab25521973536">getHintCount</a> (int position)</td></tr>
<tr class="separator:a257740aca3112940f31ab25521973536"><td class="memSeparator" colspan="2">&#160;</td></tr>
Justin's avatar
Added game logic and updated documentation  
Justin committed
70 71 
<tr class="memitem:a9a99654f3591414592b55d9df2945d20"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_hints.html#a9a99654f3591414592b55d9df2945d20">getMaxHintCount</a> ()</td></tr>
<tr class="separator:a9a99654f3591414592b55d9df2945d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
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 
<tr class="memitem:a89bc015a549fff9d943cf14377111dd2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_hints.html#a89bc015a549fff9d943cf14377111dd2">getHint</a> (int position, int hintNumber)</td></tr>
<tr class="separator:a89bc015a549fff9d943cf14377111dd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used to represent row and column hints for a <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad490bb353404503077d39c592d4aaa2b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PicPuzzle.Hints.Hints </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a>&#160;</td>
          <td class="paramname"><em>ng</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">boolean&#160;</td>
          <td class="paramname"><em>rows</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create either row or column hints from a <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ng</td><td>The <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> to create the hints for </td></tr>
    <tr><td class="paramname">rows</td><td>Create row hints if true, otherwise create column hints </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a89bc015a549fff9d943cf14377111dd2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PicPuzzle.Hints.getHint </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hintNumber</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get a hint </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>The hints row or column number to get a hint from </td></tr>
    <tr><td class="paramname">hintNumber</td><td>Which hint in a given row or column to get </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The hint at the given position </dd></dl>

</div>
</div>
<a class="anchor" id="a257740aca3112940f31ab25521973536"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PicPuzzle.Hints.getHintCount </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>position</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get how many hints are in a given row or column </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>The row or column number to get how many hints it contains </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of hints in this row or column </dd></dl>

</div>
</div>
<a class="anchor" id="a101a52fc931cebf3eae4736843e40121"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PicPuzzle.Hints.getHintWidth </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the amount of hint rows or columns </p><dl class="section return"><dt>Returns</dt><dd>How many hint rows or columns are contained in this object </dd></dl>

</div>
</div>
Justin's avatar
Added game logic and updated documentation  
Justin committed
185 
<a class="anchor" id="a9a99654f3591414592b55d9df2945d20"></a>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
186 187 188 189 
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
Justin's avatar
Added game logic and updated documentation  
Justin committed
190 191 192 193 
          <td class="memname">int PicPuzzle.Hints.getMaxHintCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
194 195 196 
        </tr>
      </table>
</div><div class="memdoc">
Justin's avatar
Added game logic and updated documentation  
Justin committed
197 
<p>Calculate the maximum number of hints in any position </p><dl class="section return"><dt>Returns</dt><dd>the maximum number of hints </dd></dl>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
198 199 200 201 

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
Justin's avatar
Added game logic and updated documentation  
Justin committed
202 
<li>src/PicPuzzle/Hints.java</li>
Justin's avatar
Cleaned up and created doxygen documentation
Justin committed
203 204 205 206 207 208 209 210 211 212 
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>