group__ctrl__propsheet__msgs.htm

MINIGUI1.6开发API

    </td>
    <td>

<p>
Gets the index of a page by handle. 
<p>
Sends this message to retreive the index to a page by handle.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga6">PSM_GETPAGEINDEX</a>
 HWND hwnd;

 wParam = hwnd;
 lParam = 0;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>hwnd</em>&nbsp;</td><td>The handle of the page.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The index of the page; PS_ERR if no such a page. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00186">186</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga9" doxytag="propsheet.h::PSM_GETTITLE"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_GETTITLE&nbsp;&nbsp;&nbsp;0xF1C8L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets a page title. 
<p>
Sends this message to retreive the title of a page.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga9">PSM_GETTITLE</a>
 <span class="keywordtype">int</span> index;
 <span class="keywordtype">char</span> *buffer;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)index;
 lParam = (<a class="code" href="group__win32__types.htm#ga9">LPARAM</a>)buffer;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index number of the page in the propsheet. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>The buffer storing the title string.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>PS_OKAY on success; PS_ERR if no such a page. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00245">245</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga8" doxytag="propsheet.h::PSM_GETTITLELENGTH"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_GETTITLELENGTH&nbsp;&nbsp;&nbsp;0xF1C7L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the length of a page title. 
<p>
Sends this message to retreive the title length of a page.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga8">PSM_GETTITLELENGTH</a>
 <span class="keywordtype">int</span> index;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)index;
 lParam = 0;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index number of the page in the propsheet.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The length of the page in the propsheet; PS_ERR if no such a page. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00223">223</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga12" doxytag="propsheet.h::PSM_REMOVEPAGE"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_REMOVEPAGE&nbsp;&nbsp;&nbsp;0xF1D1L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Removes a page from the propsheet. 
<p>
Sends this message to remove a page from the propsheet and destroys the associated controls.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga12">PSM_REMOVEPAGE</a>
 <span class="keywordtype">int</span> index;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)index;
 lParam = 0;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index number of the page to be removed from the propsheet.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>If success, return PS_OKAY, otherwise PS_ERR. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00312">312</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga3" doxytag="propsheet.h::PSM_SETACTIVEINDEX"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_SETACTIVEINDEX&nbsp;&nbsp;&nbsp;0xF1C2L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes the active page by index. 
<p>
Sends this message to change the propsheet window's active page.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga3">PSM_SETACTIVEINDEX</a>
 <span class="keywordtype">int</span> page;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)page;
 lParam = 0;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>page</em>&nbsp;</td><td>Index of the page to set.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>PS_OKAY on success, otherwise PS_ERR. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00129">129</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga10" doxytag="propsheet.h::PSM_SETTITLE"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_SETTITLE&nbsp;&nbsp;&nbsp;0xF1C9L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets a page title. 
<p>
Sends this message to specify the title of a page.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga10">PSM_SETTITLE</a>
 <span class="keywordtype">int</span> index;
 <span class="keywordtype">char</span> *buffer;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)index;
 lParam = (<a class="code" href="group__win32__types.htm#ga9">LPARAM</a>)buffer;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index number of the page in the propsheet. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>The string buffer storing the title.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>PS_OKAY on success; PS_ERR if no such a page. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00267">267</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga13" doxytag="propsheet.h::PSM_SHEETCMD"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define PSM_SHEETCMD&nbsp;&nbsp;&nbsp;0xF1D2L          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sends a MSG_SHEETCMD message to all pages in the propsheet. 
<p>
If you send MSG_SHEETCMD message to the propsheet control, the control will broadcast the message to all pages it contains. The page callback procedure will receive the message and handle it. If one page return non-zero value, the broadcast will be broken and the message will return a value indicating which page returned error. The value will be equal to the page index plus one.<p>
The PSM_SHEETCMD can be used by property sheet window, i.e., the container of the property pages. The sheet can create three buttons, like "Ok", "Cancel", and "Apply". When the user clicked the "Apply" or "Ok" button, it can send a PSM_SHEETCMD message to the propsheet control, the control will then send the message to all pages to notify pages to apply the changes made by the user. If there are some errors, the page can return a non-zero value to indicate an invalid chage so that the sheet can stop to close the sheet window. You can tell the pages which action should be taken by passing a value through the WPARAM parameter of the message.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__ctrl__propsheet__msgs.htm#ga13">PSM_SHEETCMD</a>
 <a class="code" href="group__win32__types.htm#ga8">WPARAM</a> wParam;
 <a class="code" href="group__win32__types.htm#ga9">LPARAM</a> lParam;

 wParam = (<a class="code" href="group__win32__types.htm#ga8">WPARAM</a>)wParam;
 lParam = (<a class="code" href="group__win32__types.htm#ga9">LPARAM</a>)lParam;
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>wParam</em>&nbsp;</td><td>The WPARAM parameter of the MSG_SHEETCMD message. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>lParam</em>&nbsp;</td><td>The LPARAM parameter of the MSG_SHEETCMD message.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The message has been broken by a page, the value will be (page_index + 1); Zero indicates no page asserts an error. </dd></dl>

<p>
Definition at line <a class="el" href="propsheet_8h-source.htm#l00350">350</a> of file <a class="el" href="propsheet_8h-source.htm">propsheet.h</a>.    </td>
  </tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 22 15:35:53 2007 for MiniGUI V1.6.10 API Reference by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="http://www.minigui.com/api_ref/1.6.10/doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>