← Back to branch summary

~ubuntu-branches/ubuntu/raring/codeblocks/raring-proposed

« back to all changes in this revision

Viewing changes to src/plugins/contrib/wxSmith/propgrid/contrib/docs/html/propgrid/group__miscellaneous.htm

  • Committer: Bazaar Package Importer
  • Author(s): Cosme Domínguez Díaz
  • Date: 2010-08-09 04:38:38 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20100809043838-a59ygguym4eg0jgw
Tags: 10.05-0ubuntu1
https://launchpad.net/bugs/322350
* New upstream release. Closes (LP: #322350)
 - Switch to dpkg-source 3.0 (quilt) format
 - Remove unneeded README.source
 - Add debian/get-source-orig script that removes all
   Windows prebuilt binaries
* Bump Standards-Version to 3.9.1
 - Stop shipping *.la files
* debian/control
 - Add cdbs package as Build-Depend
 - Add libbz2-dev and zlib1g-dev packages as
   Build-Depends (needed by libhelp_plugin.so)
 - Remove dpatch package of Build-Depends
 - Add codeblocks-contrib-debug package
 - Split architecture-independent files of codeblocks
   package in codeblocks-common package
* debian/rules
 - Switch to CDBS rules system
 - Add parallel build support
 - Add a call to debian/get-source-orig script
 - Use lzma compression (saves 23,5 MB of free space)
* debian/patches
 - Refresh 01_codeblocks_plugin_path
 - Add 02_no_Makefiles_in_debian_dir to remove any link
   in codeblocks build system to deleted Makefiles of debian directory
 - Drop 02_ftbfs_gcc44 and 03_ftbfs_glib221 (merged in upstream)
* debian/watch
 - Update to use the new host (berlios.de)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/contrib/wxSmith/propgrid/contrib/docs/html/propgrid/group__miscellaneous.htm
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>wxPropertyGrid: wxPropertyGrid Miscellanous</title>
4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
</head><body>
6
 
<!-- Generated by Doxygen 1.3.6 -->
7
 
<div class="qindex">  <form class="search" action="search.php" method="get">
8
 
<a class="qindex" href="index.htm">Main&nbsp;Page</a> | <a class="qindex" href="modules.htm">Modules</a> | <a class="qindex" href="hierarchy.htm">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.htm">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.htm">Class&nbsp;List</a> | <a class="qindex" href="functions.htm">Class&nbsp;Members</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
9
 
<h1>wxPropertyGrid Miscellanous</h1>This section describes some miscellanous values, types and macros.  
10
 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
11
 
<tr><td></td></tr>
12
 
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
13
 
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga13">WX_PG_CLASSINFO</a>(NAME)&nbsp;&nbsp;&nbsp;NAME##ClassInfo</td></tr>
14
 
 
15
 
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga8">wxPG_COLOUR</a>(R, G, B)&nbsp;&nbsp;&nbsp;((wxUint32)(R+(G&lt;&lt;8)+(B&lt;&lt;16)))</td></tr>
16
 
 
17
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga6" doxytag="miscellaneous::wxPG_COLOUR_BLACK" ></a>
18
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_COLOUR_BLACK</b>&nbsp;&nbsp;&nbsp;(*wxBLACK)</td></tr>
19
 
 
20
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga2" doxytag="miscellaneous::wxPG_EMPTY_ARRAYINT" ></a>
21
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_EMPTY_ARRAYINT</b>&nbsp;&nbsp;&nbsp;(*((wxArrayInt*)NULL))</td></tr>
22
 
 
23
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga3" doxytag="miscellaneous::wxPG_EMPTY_ARRAYSTRING" ></a>
24
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_EMPTY_ARRAYSTRING</b>&nbsp;&nbsp;&nbsp;(*((wxArrayString*)NULL))</td></tr>
25
 
 
26
 
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga9">wxPG_FLEXIBLE_SIZE</a>(PREFWID, PREFHEI)&nbsp;&nbsp;&nbsp;wxSize(-(PREFWID),-(PREFHEI))</td></tr>
27
 
 
28
 
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga12">wxPG_FULL_CUSTOM_PAINT_FLEXIBLE_SIZE</a>(PREFHEI)&nbsp;&nbsp;&nbsp;wxSize(wxPG_FULL_CUSTOM_PAINT_WIDTH,-(PREFHEI))</td></tr>
29
 
 
30
 
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga11">wxPG_FULL_CUSTOM_PAINT_SIZE</a>(HEI)&nbsp;&nbsp;&nbsp;wxSize(wxPG_FULL_CUSTOM_PAINT_WIDTH,HEI)</td></tr>
31
 
 
32
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga10" doxytag="miscellaneous::wxPG_FULL_CUSTOM_PAINT_WIDTH" ></a>
33
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_FULL_CUSTOM_PAINT_WIDTH</b>&nbsp;&nbsp;&nbsp;-99999</td></tr>
34
 
 
35
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga7" doxytag="miscellaneous::wxPG_INVALID_VALUE" ></a>
36
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_INVALID_VALUE</b>&nbsp;&nbsp;&nbsp;INT_MAX</td></tr>
37
 
 
38
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga4" doxytag="miscellaneous::wxPG_LABEL" ></a>
39
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_LABEL</b>&nbsp;&nbsp;&nbsp;(*((wxString*)NULL))</td></tr>
40
 
 
41
 
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga5" doxytag="miscellaneous::wxPG_NULL_BITMAP" ></a>
42
 
#define&nbsp;</td><td class="memItemRight" valign=bottom><b>wxPG_NULL_BITMAP</b>&nbsp;&nbsp;&nbsp;wxNullBitmap</td></tr>
43
 
 
44
 
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
45
 
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef void(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga1">wxPGPaintCallback</a> )(<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxDC &amp;dc, const wxRect &amp;rect, <a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> &amp;paintdata)</td></tr>
46
 
 
47
 
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef bool(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__miscellaneous.htm#ga0">wxPropertyGridCallback</a> )(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl, int data)</td></tr>
48
 
 
49
 
</table>
50
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
51
 
This section describes some miscellanous values, types and macros. 
52
 
<p>
53
 
<hr><h2>Define Documentation</h2>
54
 
<a class="anchor" name="ga13" doxytag="propgrid.h::WX_PG_CLASSINFO" ></a><p>
55
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
56
 
  <tr>
57
 
    <td class="mdRow">
58
 
      <table cellpadding="0" cellspacing="0" border="0">
59
 
        <tr>
60
 
          <td class="md" nowrap valign="top"> #define WX_PG_CLASSINFO</td>
61
 
          <td class="md" valign="top">(&nbsp;</td>
62
 
          <td class="md" nowrap valign="top">NAME&nbsp;</td>
63
 
          <td class="mdname1" valign="top" nowrap>          </td>
64
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
65
 
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;NAME##ClassInfo
66
 
      </table>
67
 
    </td>
68
 
  </tr>
69
 
</table>
70
 
<table cellspacing=5 cellpadding=0 border=0>
71
 
  <tr>
72
 
    <td>
73
 
      &nbsp;
74
 
    </td>
75
 
    <td>
76
 
 
77
 
<p>
78
 
Use this with <a class="el" href="classwxPropertyContainerMethods.htm#wxPropertyGridPagee24">wxPropertyGrid::IsPropertyKindOf</a>. 
79
 
<p>
80
 
For example, as in <pre class="fragment"><div>        pg-&gt;<a class="code" href="classwxPropertyContainerMethods.htm#wxPropertyGridPagee24">IsPropertyKindOf</a>(<a class="code" href="group__miscellaneous.htm#ga13">WX_PG_CLASSINFO</a>(wxStringProperty))
81
 
</div></pre>    </td>
82
 
  </tr>
83
 
</table>
84
 
<a class="anchor" name="ga8" doxytag="propgrid.h::wxPG_COLOUR" ></a><p>
85
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
86
 
  <tr>
87
 
    <td class="mdRow">
88
 
      <table cellpadding="0" cellspacing="0" border="0">
89
 
        <tr>
90
 
          <td class="md" nowrap valign="top"> #define wxPG_COLOUR</td>
91
 
          <td class="md" valign="top">(&nbsp;</td>
92
 
          <td class="md" nowrap valign="top">R,         <tr>
93
 
          <td class="md" nowrap align="right"></td>
94
 
          <td></td>
95
 
          <td class="md" nowrap>G,         <tr>
96
 
          <td class="md" nowrap align="right"></td>
97
 
          <td></td>
98
 
          <td class="md" nowrap>B&nbsp;</td>
99
 
          <td class="mdname1" valign="top" nowrap>          </td>
100
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
101
 
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;((wxUint32)(R+(G&lt;&lt;8)+(B&lt;&lt;16)))
102
 
      </table>
103
 
    </td>
104
 
  </tr>
105
 
</table>
106
 
<table cellspacing=5 cellpadding=0 border=0>
107
 
  <tr>
108
 
    <td>
109
 
      &nbsp;
110
 
    </td>
111
 
    <td>
112
 
 
113
 
<p>
114
 
Convert Red, Green and Blue to a single 32-bit value. 
115
 
<p>
116
 
    </td>
117
 
  </tr>
118
 
</table>
119
 
<a class="anchor" name="ga9" doxytag="propgrid.h::wxPG_FLEXIBLE_SIZE" ></a><p>
120
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
121
 
  <tr>
122
 
    <td class="mdRow">
123
 
      <table cellpadding="0" cellspacing="0" border="0">
124
 
        <tr>
125
 
          <td class="md" nowrap valign="top"> #define wxPG_FLEXIBLE_SIZE</td>
126
 
          <td class="md" valign="top">(&nbsp;</td>
127
 
          <td class="md" nowrap valign="top">PREFWID,         <tr>
128
 
          <td class="md" nowrap align="right"></td>
129
 
          <td></td>
130
 
          <td class="md" nowrap>PREFHEI&nbsp;</td>
131
 
          <td class="mdname1" valign="top" nowrap>          </td>
132
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
133
 
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;wxSize(-(PREFWID),-(PREFHEI))
134
 
      </table>
135
 
    </td>
136
 
  </tr>
137
 
</table>
138
 
<table cellspacing=5 cellpadding=0 border=0>
139
 
  <tr>
140
 
    <td>
141
 
      &nbsp;
142
 
    </td>
143
 
    <td>
144
 
 
145
 
<p>
146
 
Return this in GetImageSize() to indicate that the custom painted property image is flexible. 
147
 
<p>
148
 
That is, it will paint (dropdown) list item images with PREFWID,PREFHEI size.     </td>
149
 
  </tr>
150
 
</table>
151
 
<a class="anchor" name="ga12" doxytag="propgrid.h::wxPG_FULL_CUSTOM_PAINT_FLEXIBLE_SIZE" ></a><p>
152
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
153
 
  <tr>
154
 
    <td class="mdRow">
155
 
      <table cellpadding="0" cellspacing="0" border="0">
156
 
        <tr>
157
 
          <td class="md" nowrap valign="top"> #define wxPG_FULL_CUSTOM_PAINT_FLEXIBLE_SIZE</td>
158
 
          <td class="md" valign="top">(&nbsp;</td>
159
 
          <td class="md" nowrap valign="top">PREFHEI&nbsp;</td>
160
 
          <td class="mdname1" valign="top" nowrap>          </td>
161
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
162
 
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;wxSize(wxPG_FULL_CUSTOM_PAINT_WIDTH,-(PREFHEI))
163
 
      </table>
164
 
    </td>
165
 
  </tr>
166
 
</table>
167
 
<table cellspacing=5 cellpadding=0 border=0>
168
 
  <tr>
169
 
    <td>
170
 
      &nbsp;
171
 
    </td>
172
 
    <td>
173
 
 
174
 
<p>
175
 
Return this in GetImageSize() to indicate that the property is custom painted completely (ie. 
176
 
<p>
177
 
the text as well), and with flexible height.     </td>
178
 
  </tr>
179
 
</table>
180
 
<a class="anchor" name="ga11" doxytag="propgrid.h::wxPG_FULL_CUSTOM_PAINT_SIZE" ></a><p>
181
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
182
 
  <tr>
183
 
    <td class="mdRow">
184
 
      <table cellpadding="0" cellspacing="0" border="0">
185
 
        <tr>
186
 
          <td class="md" nowrap valign="top"> #define wxPG_FULL_CUSTOM_PAINT_SIZE</td>
187
 
          <td class="md" valign="top">(&nbsp;</td>
188
 
          <td class="md" nowrap valign="top">HEI&nbsp;</td>
189
 
          <td class="mdname1" valign="top" nowrap>          </td>
190
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191
 
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;wxSize(wxPG_FULL_CUSTOM_PAINT_WIDTH,HEI)
192
 
      </table>
193
 
    </td>
194
 
  </tr>
195
 
</table>
196
 
<table cellspacing=5 cellpadding=0 border=0>
197
 
  <tr>
198
 
    <td>
199
 
      &nbsp;
200
 
    </td>
201
 
    <td>
202
 
 
203
 
<p>
204
 
Return this in GetImageSize() to indicate that the property is custom painted completely (ie. 
205
 
<p>
206
 
the text as well).     </td>
207
 
  </tr>
208
 
</table>
209
 
<hr><h2>Typedef Documentation</h2>
210
 
<a class="anchor" name="ga1" doxytag="propgrid.h::wxPGPaintCallback" ></a><p>
211
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
212
 
  <tr>
213
 
    <td class="mdRow">
214
 
      <table cellpadding="0" cellspacing="0" border="0">
215
 
        <tr>
216
 
          <td class="md" nowrap valign="top"> typedef void(* <a class="el" href="group__miscellaneous.htm#ga1">wxPGPaintCallback</a>)(<a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* property, wxDC&amp; dc, const wxRect&amp; rect, <a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a>&amp; paintdata)
217
 
      </table>
218
 
    </td>
219
 
  </tr>
220
 
</table>
221
 
<table cellspacing=5 cellpadding=0 border=0>
222
 
  <tr>
223
 
    <td>
224
 
      &nbsp;
225
 
    </td>
226
 
    <td>
227
 
 
228
 
<p>
229
 
This callback function is used by atleast wxCustomProperty to facilitiate drawing items in drop down list. 
230
 
<p>
231
 
Works very much like <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa54">wxPGProperty::OnCustomPaint</a>.     </td>
232
 
  </tr>
233
 
</table>
234
 
<a class="anchor" name="ga0" doxytag="propgrid.h::wxPropertyGridCallback" ></a><p>
235
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
236
 
  <tr>
237
 
    <td class="mdRow">
238
 
      <table cellpadding="0" cellspacing="0" border="0">
239
 
        <tr>
240
 
          <td class="md" nowrap valign="top"> typedef bool(* <a class="el" href="group__miscellaneous.htm#ga0">wxPropertyGridCallback</a>)(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a>* propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* property, wxWindow* ctrl, int data)
241
 
      </table>
242
 
    </td>
243
 
  </tr>
244
 
</table>
245
 
<table cellspacing=5 cellpadding=0 border=0>
246
 
  <tr>
247
 
    <td>
248
 
      &nbsp;
249
 
    </td>
250
 
    <td>
251
 
 
252
 
<p>
253
 
This callback function is used by atleast wxCustomProperty to facilitiate easy custom action on button press. 
254
 
<p>
255
 
<dl compact><dt><b>Parameters:</b></dt><dd>
256
 
  <table border="0" cellspacing="2" cellpadding="0">
257
 
    <tr><td valign=top><em>propGrid</em>&nbsp;</td><td>related <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> </td></tr>
258
 
    <tr><td valign=top><em>property</em>&nbsp;</td><td>related <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> </td></tr>
259
 
    <tr><td valign=top><em>ctrl</em>&nbsp;</td><td>If not NULL (for example, not selected), a wxWindow* or equivalent </td></tr>
260
 
    <tr><td valign=top><em>data</em>&nbsp;</td><td>Value depends on the context. </td></tr>
261
 
  </table>
262
 
</dl>
263
 
<dl compact><dt><b>Return values:</b></dt><dd>
264
 
  <table border="0" cellspacing="2" cellpadding="0">
265
 
    <tr><td valign=top><em>True</em>&nbsp;</td><td>if changed value of the property. </td></tr>
266
 
  </table>
267
 
</dl>
268
 
    </td>
269
 
  </tr>
270
 
</table>
271
 
<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 29 16:56:25 2007 for wxPropertyGrid by
272
 
<a href="http://www.doxygen.org/index.html">
273
 
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
274
 
</a>1.3.6 </small></address>
275
 
</body>
276
 
</html>