]>
Commit | Line | Data |
---|---|---|
1c4293cb VZ |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/propgrid/propgrid.h | |
3 | // Purpose: wxPropertyGrid | |
4 | // Author: Jaakko Salli | |
5 | // Modified by: | |
6 | // Created: 2004-09-25 | |
ea5af9c5 | 7 | // RCS-ID: $Id$ |
1c4293cb VZ |
8 | // Copyright: (c) Jaakko Salli |
9 | // Licence: wxWindows license | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_PROPGRID_PROPGRID_H_ | |
13 | #define _WX_PROPGRID_PROPGRID_H_ | |
14 | ||
f4bc1aa2 JS |
15 | #if wxUSE_PROPGRID |
16 | ||
1c4293cb VZ |
17 | #include "wx/dcclient.h" |
18 | #include "wx/scrolwin.h" | |
19 | #include "wx/tooltip.h" | |
20 | #include "wx/datetime.h" | |
21 | ||
22 | #include "wx/propgrid/property.h" | |
23 | #include "wx/propgrid/propgridiface.h" | |
24 | ||
25 | ||
26 | #ifndef SWIG | |
27 | extern WXDLLIMPEXP_PROPGRID const wxChar *wxPropertyGridNameStr; | |
28 | #endif | |
29 | ||
30 | ||
31 | // ----------------------------------------------------------------------- | |
32 | // Global variables | |
33 | // ----------------------------------------------------------------------- | |
34 | ||
35 | #ifndef SWIG | |
36 | ||
37 | // This is required for sharing common global variables. | |
38 | class WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass | |
39 | { | |
40 | public: | |
41 | ||
42 | wxPGGlobalVarsClass(); | |
43 | ~wxPGGlobalVarsClass(); | |
44 | ||
45 | // Used by advprops, but here to make things easier. | |
46 | wxString m_pDefaultImageWildcard; | |
47 | ||
48 | // Map of editor class instances (keys are name string). | |
49 | wxPGHashMapS2P m_mapEditorClasses; | |
50 | ||
51 | #if wxUSE_VALIDATORS | |
f7a094e1 | 52 | wxVector<wxValidator*> m_arrValidators; // These wxValidators need to be freed |
1c4293cb VZ |
53 | #endif |
54 | ||
55 | wxPGHashMapS2P m_dictPropertyClassInfo; // PropertyName -> ClassInfo | |
56 | ||
57 | wxPGChoices* m_fontFamilyChoices; | |
58 | ||
59 | // Replace with your own to affect all properties using default renderer. | |
60 | wxPGCellRenderer* m_defaultRenderer; | |
61 | ||
1c4293cb VZ |
62 | wxPGChoices m_boolChoices; |
63 | ||
64 | wxVariant m_vEmptyString; | |
65 | wxVariant m_vZero; | |
66 | wxVariant m_vMinusOne; | |
67 | wxVariant m_vTrue; | |
68 | wxVariant m_vFalse; | |
69 | ||
70 | // Cached constant strings | |
0372d42e JS |
71 | wxPGCachedString m_strstring; |
72 | wxPGCachedString m_strlong; | |
73 | wxPGCachedString m_strbool; | |
74 | wxPGCachedString m_strlist; | |
75 | ||
1c4293cb VZ |
76 | wxPGCachedString m_strMin; |
77 | wxPGCachedString m_strMax; | |
78 | wxPGCachedString m_strUnits; | |
79 | wxPGCachedString m_strInlineHelp; | |
80 | ||
81 | // If true then some things are automatically translated | |
82 | bool m_autoGetTranslation; | |
83 | ||
84 | // > 0 if errors cannot or should not be shown in statusbar etc. | |
85 | int m_offline; | |
86 | ||
87 | int m_extraStyle; // global extra style | |
88 | ||
89 | #ifdef __WXDEBUG__ | |
90 | int m_warnings; | |
91 | #endif | |
92 | ||
93 | int HasExtraStyle( int style ) const { return (m_extraStyle & style); } | |
94 | }; | |
95 | ||
96 | extern WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass* wxPGGlobalVars; | |
97 | ||
1c4293cb VZ |
98 | #define wxPGVariant_EmptyString (wxPGGlobalVars->m_vEmptyString) |
99 | #define wxPGVariant_Zero (wxPGGlobalVars->m_vZero) | |
100 | #define wxPGVariant_MinusOne (wxPGGlobalVars->m_vMinusOne) | |
101 | #define wxPGVariant_True (wxPGGlobalVars->m_vTrue) | |
102 | #define wxPGVariant_False (wxPGGlobalVars->m_vFalse) | |
103 | ||
104 | #define wxPGVariant_Bool(A) (A?wxPGVariant_True:wxPGVariant_False) | |
105 | ||
1c4293cb VZ |
106 | #endif // !SWIG |
107 | ||
108 | // ----------------------------------------------------------------------- | |
109 | ||
110 | /** @section propgrid_window_styles wxPropertyGrid Window Styles | |
111 | ||
112 | SetWindowStyleFlag method can be used to modify some of these at run-time. | |
113 | @{ | |
114 | */ | |
115 | enum wxPG_WINDOW_STYLES | |
116 | { | |
117 | ||
118 | /** This will cause Sort() automatically after an item is added. | |
119 | When inserting a lot of items in this mode, it may make sense to | |
120 | use Freeze() before operations and Thaw() afterwards to increase | |
121 | performance. | |
122 | */ | |
123 | wxPG_AUTO_SORT = 0x00000010, | |
124 | ||
125 | /** Categories are not initially shown (even if added). | |
126 | IMPORTANT NOTE: If you do not plan to use categories, then this | |
127 | style will waste resources. | |
128 | This flag can also be changed using wxPropertyGrid::EnableCategories method. | |
129 | */ | |
130 | wxPG_HIDE_CATEGORIES = 0x00000020, | |
131 | ||
132 | /* This style combines non-categoric mode and automatic sorting. | |
133 | */ | |
134 | wxPG_ALPHABETIC_MODE = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT), | |
135 | ||
136 | /** Modified values are shown in bold font. Changing this requires Refresh() | |
137 | to show changes. | |
138 | */ | |
139 | wxPG_BOLD_MODIFIED = 0x00000040, | |
140 | ||
141 | /** When wxPropertyGrid is resized, splitter moves to the center. This | |
142 | behavior stops once the user manually moves the splitter. | |
143 | */ | |
144 | wxPG_SPLITTER_AUTO_CENTER = 0x00000080, | |
145 | ||
146 | /** Display tooltips for cell text that cannot be shown completely. If | |
147 | wxUSE_TOOLTIPS is 0, then this doesn't have any effect. | |
148 | */ | |
149 | wxPG_TOOLTIPS = 0x00000100, | |
150 | ||
151 | /** Disables margin and hides all expand/collapse buttons that would appear | |
152 | outside the margin (for sub-properties). Toggling this style automatically | |
153 | expands all collapsed items. | |
154 | */ | |
155 | wxPG_HIDE_MARGIN = 0x00000200, | |
156 | ||
157 | /** This style prevents user from moving the splitter. | |
158 | */ | |
159 | wxPG_STATIC_SPLITTER = 0x00000400, | |
160 | ||
161 | /** Combination of other styles that make it impossible for user to modify | |
162 | the layout. | |
163 | */ | |
164 | wxPG_STATIC_LAYOUT = (wxPG_HIDE_MARGIN|wxPG_STATIC_SPLITTER), | |
165 | ||
166 | /** Disables wxTextCtrl based editors for properties which | |
167 | can be edited in another way. | |
168 | ||
169 | Equals calling wxPropertyGrid::LimitPropertyEditing for all added | |
170 | properties. | |
171 | */ | |
172 | wxPG_LIMITED_EDITING = 0x00000800, | |
173 | ||
174 | /** wxPropertyGridManager only: Show toolbar for mode and page selection. */ | |
175 | wxPG_TOOLBAR = 0x00001000, | |
176 | ||
177 | /** wxPropertyGridManager only: Show adjustable text box showing description | |
178 | or help text, if available, for currently selected property. | |
179 | */ | |
180 | wxPG_DESCRIPTION = 0x00002000 | |
181 | ||
182 | }; | |
183 | ||
184 | enum wxPG_EX_WINDOW_STYLES | |
185 | { | |
186 | ||
187 | /** | |
188 | NOTE: wxPG_EX_xxx are extra window styles and must be set using | |
189 | SetExtraStyle() member function. | |
190 | ||
191 | Speeds up switching to wxPG_HIDE_CATEGORIES mode. Initially, if | |
192 | wxPG_HIDE_CATEGORIES is not defined, the non-categorized data storage is | |
193 | not activated, and switching the mode first time becomes somewhat slower. | |
194 | wxPG_EX_INIT_NOCAT activates the non-categorized data storage right away. | |
195 | IMPORTANT NOTE: If you do plan not switching to non-categoric mode, or if | |
196 | you don't plan to use categories at all, then using this style will result | |
197 | in waste of resources. | |
198 | ||
199 | */ | |
200 | wxPG_EX_INIT_NOCAT = 0x00001000, | |
201 | ||
202 | /** Extended window style that sets wxPropertyGridManager toolbar to not | |
203 | use flat style. | |
204 | */ | |
205 | wxPG_EX_NO_FLAT_TOOLBAR = 0x00002000, | |
206 | ||
207 | /** Shows alphabetic/categoric mode buttons from toolbar. | |
208 | */ | |
209 | wxPG_EX_MODE_BUTTONS = 0x00008000, | |
210 | ||
211 | /** Show property help strings as tool tips instead as text on the status bar. | |
212 | You can set the help strings using SetPropertyHelpString member function. | |
213 | */ | |
214 | wxPG_EX_HELP_AS_TOOLTIPS = 0x00010000, | |
215 | ||
216 | /** Prevent TAB from focusing to wxButtons. This behavior was default | |
217 | in version 1.2.0 and earlier. | |
218 | NOTE! Tabbing to button doesn't work yet. Problem seems to be that on wxMSW | |
219 | atleast the button doesn't properly propagate key events (yes, I'm using | |
220 | wxWANTS_CHARS). | |
221 | */ | |
222 | //wxPG_EX_NO_TAB_TO_BUTTON = 0x00020000, | |
223 | ||
224 | /** Allows relying on native double-buffering. | |
225 | */ | |
226 | wxPG_EX_NATIVE_DOUBLE_BUFFERING = 0x00080000, | |
227 | ||
228 | /** Set this style to let user have ability to set values of properties to | |
229 | unspecified state. Same as setting wxPG_PROP_AUTO_UNSPECIFIED for | |
230 | all properties. | |
231 | */ | |
232 | wxPG_EX_AUTO_UNSPECIFIED_VALUES = 0x00200000, | |
233 | ||
234 | /** | |
235 | If this style is used, built-in attributes (such as wxPG_FLOAT_PRECISION | |
236 | and wxPG_STRING_PASSWORD) are not stored into property's attribute storage | |
237 | (thus they are not readable). | |
238 | ||
239 | Note that this option is global, and applies to all wxPG property | |
240 | containers. | |
241 | */ | |
242 | wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES = 0x00400000, | |
243 | ||
1c4293cb VZ |
244 | /** Hides page selection buttons from toolbar. |
245 | */ | |
246 | wxPG_EX_HIDE_PAGE_BUTTONS = 0x01000000 | |
247 | ||
248 | }; | |
249 | ||
250 | /** Combines various styles. | |
251 | */ | |
252 | #define wxPG_DEFAULT_STYLE (0) | |
253 | ||
254 | /** Combines various styles. | |
255 | */ | |
256 | #define wxPGMAN_DEFAULT_STYLE (0) | |
257 | ||
258 | /** @} | |
259 | */ | |
260 | ||
261 | // ----------------------------------------------------------------------- | |
262 | ||
263 | // | |
264 | // Ids for sub-controls | |
265 | // NB: It should not matter what these are. | |
266 | #define wxPG_SUBID1 2 | |
267 | #define wxPG_SUBID2 3 | |
268 | #define wxPG_SUBID_TEMP1 4 | |
269 | ||
270 | // ----------------------------------------------------------------------- | |
271 | ||
272 | /** @class wxPGCommonValue | |
273 | ||
274 | wxPropertyGrid stores information about common values in these | |
275 | records. | |
276 | ||
277 | NB: Common value feature is not complete, and thus not mentioned in | |
278 | documentation. | |
279 | */ | |
280 | class WXDLLIMPEXP_PROPGRID wxPGCommonValue | |
281 | { | |
282 | public: | |
283 | ||
284 | wxPGCommonValue( const wxString& label, wxPGCellRenderer* renderer ) | |
285 | { | |
286 | m_label = label; | |
287 | m_renderer = renderer; | |
288 | renderer->IncRef(); | |
289 | } | |
290 | virtual ~wxPGCommonValue() | |
291 | { | |
292 | m_renderer->DecRef(); | |
293 | } | |
294 | ||
295 | virtual wxString GetEditableText() const { return m_label; } | |
296 | const wxString& GetLabel() const { return m_label; } | |
297 | wxPGCellRenderer* GetRenderer() const { return m_renderer; } | |
298 | ||
299 | protected: | |
300 | wxString m_label; | |
301 | wxPGCellRenderer* m_renderer; | |
302 | }; | |
303 | ||
304 | // ----------------------------------------------------------------------- | |
305 | ||
306 | /** @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags | |
307 | @{ | |
308 | */ | |
309 | ||
310 | enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS | |
311 | { | |
312 | ||
313 | /** Prevents user from leaving property unless value is valid. If this | |
314 | behavior flag is not used, then value change is instead cancelled. | |
315 | */ | |
316 | wxPG_VFB_STAY_IN_PROPERTY = 0x01, | |
317 | ||
318 | /** Calls wxBell() on validation failure. | |
319 | */ | |
320 | wxPG_VFB_BEEP = 0x02, | |
321 | ||
322 | /** Cell with invalid value will be marked (with red colour). | |
323 | */ | |
324 | wxPG_VFB_MARK_CELL = 0x04, | |
325 | ||
326 | /** Display customizable text message explaining the situation. | |
327 | */ | |
328 | wxPG_VFB_SHOW_MESSAGE = 0x08, | |
329 | ||
330 | /** Defaults. */ | |
331 | wxPG_VFB_DEFAULT = wxPG_VFB_STAY_IN_PROPERTY|wxPG_VFB_BEEP, | |
332 | ||
333 | /** Only used internally. */ | |
334 | wxPG_VFB_UNDEFINED = 0x80 | |
335 | ||
336 | }; | |
337 | ||
338 | /** @} | |
339 | */ | |
340 | ||
341 | typedef wxByte wxPGVFBFlags; | |
342 | ||
2a8312bc JS |
343 | /** |
344 | wxPGValidationInfo | |
1c4293cb VZ |
345 | |
346 | Used to convey validation information to and from functions that | |
2a8312bc JS |
347 | actually perform validation. Mostly used in custom property |
348 | classes. | |
1c4293cb | 349 | */ |
47e343c6 | 350 | class WXDLLIMPEXP_PROPGRID wxPGValidationInfo |
1c4293cb | 351 | { |
2a8312bc JS |
352 | friend class wxPropertyGrid; |
353 | public: | |
6b03a638 JS |
354 | /** |
355 | @return Returns failure behavior which is a combination of | |
356 | @ref propgrid_vfbflags. | |
357 | */ | |
47e343c6 JS |
358 | wxPGVFBFlags GetFailureBehavior() const |
359 | { return m_failureBehavior; } | |
6b03a638 JS |
360 | |
361 | /** | |
362 | Returns current failure message. | |
363 | */ | |
364 | const wxString& GetFailureMessage() const | |
365 | { return m_failureMessage; } | |
366 | ||
2a8312bc JS |
367 | /** |
368 | Returns reference to pending value. | |
369 | */ | |
370 | const wxVariant& GetValue() const | |
371 | { | |
372 | wxASSERT(m_pValue); | |
373 | return *m_pValue; | |
374 | } | |
375 | ||
6b03a638 | 376 | /** Set validation failure behavior |
1c4293cb | 377 | |
6b03a638 JS |
378 | @param failureBehavior |
379 | Mixture of @ref propgrid_vfbflags. | |
380 | */ | |
1c4293cb VZ |
381 | void SetFailureBehavior(wxPGVFBFlags failureBehavior) |
382 | { m_failureBehavior = failureBehavior; } | |
383 | ||
6b03a638 JS |
384 | /** |
385 | Set current failure message. | |
386 | */ | |
9891e165 JS |
387 | void SetFailureMessage(const wxString& message) |
388 | { m_failureMessage = message; } | |
2a8312bc JS |
389 | |
390 | private: | |
391 | /** Value to be validated. | |
392 | */ | |
393 | wxVariant* m_pValue; | |
394 | ||
395 | /** Message displayed on validation failure. | |
396 | */ | |
397 | wxString m_failureMessage; | |
398 | ||
399 | /** Validation failure behavior. Use wxPG_VFB_XXX flags. | |
400 | */ | |
401 | wxPGVFBFlags m_failureBehavior; | |
1c4293cb VZ |
402 | }; |
403 | ||
404 | // ----------------------------------------------------------------------- | |
405 | ||
406 | /** @section propgrid_pgactions wxPropertyGrid Action Identifiers | |
407 | ||
408 | These are used with wxPropertyGrid::AddActionTrigger() and | |
409 | wxPropertyGrid::ClearActionTriggers(). | |
410 | @{ | |
411 | */ | |
412 | ||
413 | enum wxPG_KEYBOARD_ACTIONS | |
414 | { | |
415 | wxPG_ACTION_INVALID = 0, | |
416 | wxPG_ACTION_NEXT_PROPERTY, | |
417 | wxPG_ACTION_PREV_PROPERTY, | |
418 | wxPG_ACTION_EXPAND_PROPERTY, | |
419 | wxPG_ACTION_COLLAPSE_PROPERTY, | |
420 | wxPG_ACTION_CANCEL_EDIT, | |
421 | wxPG_ACTION_CUT, | |
422 | wxPG_ACTION_COPY, | |
423 | wxPG_ACTION_PASTE, | |
1766bf34 | 424 | wxPG_ACTION_PRESS_BUTTON, // Causes editor button (if any) to be pressed |
1c4293cb VZ |
425 | wxPG_ACTION_MAX |
426 | }; | |
427 | ||
428 | /** @} | |
429 | */ | |
430 | ||
431 | // ----------------------------------------------------------------------- | |
432 | ||
433 | ||
434 | // wxPropertyGrid::DoSelectProperty flags (selFlags) | |
435 | ||
436 | // Focuses to created editor | |
437 | #define wxPG_SEL_FOCUS 0x01 | |
438 | // Forces deletion and recreation of editor | |
439 | #define wxPG_SEL_FORCE 0x02 | |
440 | // For example, doesn't cause EnsureVisible | |
441 | #define wxPG_SEL_NONVISIBLE 0x04 | |
442 | // Do not validate editor's value before selecting | |
443 | #define wxPG_SEL_NOVALIDATE 0x08 | |
444 | // Property being deselected is about to be deleted | |
445 | #define wxPG_SEL_DELETING 0x10 | |
446 | // Property's values was set to unspecified by the user | |
447 | #define wxPG_SEL_SETUNSPEC 0x20 | |
448 | // Property's event handler changed the value | |
449 | #define wxPG_SEL_DIALOGVAL 0x40 | |
450 | ||
451 | ||
452 | // ----------------------------------------------------------------------- | |
453 | ||
454 | #ifndef SWIG | |
455 | ||
456 | // Internal flags | |
457 | #define wxPG_FL_INITIALIZED 0x0001 | |
458 | // Set when creating editor controls if it was clicked on. | |
459 | #define wxPG_FL_ACTIVATION_BY_CLICK 0x0002 | |
460 | #define wxPG_FL_DONT_CENTER_SPLITTER 0x0004 | |
461 | #define wxPG_FL_FOCUSED 0x0008 | |
462 | #define wxPG_FL_MOUSE_CAPTURED 0x0010 | |
463 | #define wxPG_FL_MOUSE_INSIDE 0x0020 | |
464 | #define wxPG_FL_VALUE_MODIFIED 0x0040 | |
465 | // don't clear background of m_wndEditor | |
466 | #define wxPG_FL_PRIMARY_FILLS_ENTIRE 0x0080 | |
467 | // currently active editor uses custom image | |
468 | #define wxPG_FL_CUR_USES_CUSTOM_IMAGE 0x0100 | |
469 | // cell colours override selection colours for selected cell | |
470 | #define wxPG_FL_CELL_OVERRIDES_SEL 0x0200 | |
471 | #define wxPG_FL_SCROLLED 0x0400 | |
472 | // set when all added/inserted properties get hideable flag | |
473 | #define wxPG_FL_ADDING_HIDEABLES 0x0800 | |
474 | // Disables showing help strings on statusbar. | |
475 | #define wxPG_FL_NOSTATUSBARHELP 0x1000 | |
476 | // Marks that we created the state, so we have to destroy it too. | |
477 | #define wxPG_FL_CREATEDSTATE 0x2000 | |
478 | // Set if scrollbar's existence was detected in last onresize. | |
479 | #define wxPG_FL_SCROLLBAR_DETECTED 0x4000 | |
480 | // Set if wxPGMan requires redrawing of description text box. | |
481 | #define wxPG_FL_DESC_REFRESH_REQUIRED 0x8000 | |
482 | // Set if contained in wxPropertyGridManager | |
483 | #define wxPG_FL_IN_MANAGER 0x00020000 | |
484 | // Set after wxPropertyGrid is shown in its initial good size | |
485 | #define wxPG_FL_GOOD_SIZE_SET 0x00040000 | |
1c4293cb VZ |
486 | // Set when in SelectProperty. |
487 | #define wxPG_FL_IN_SELECT_PROPERTY 0x00100000 | |
488 | // Set when help string is shown in status bar | |
489 | #define wxPG_FL_STRING_IN_STATUSBAR 0x00200000 | |
490 | // Splitter position has been custom-set by the user | |
491 | #define wxPG_FL_SPLITTER_PRE_SET 0x00400000 | |
492 | // Validation failed. Clear on modify event. | |
493 | #define wxPG_FL_VALIDATION_FAILED 0x00800000 | |
494 | // Set if selected is fully painted (ie. both image and text) | |
495 | //#define wxPG_FL_SELECTED_IS_FULL_PAINT 0x01000000 | |
496 | // Set after page has been inserted to manager | |
497 | #define wxPG_MAN_FL_PAGE_INSERTED 0x02000000 | |
498 | // Active editor control is abnormally large | |
499 | #define wxPG_FL_ABNORMAL_EDITOR 0x04000000 | |
500 | // Recursion guard for OnCustomEditorEvent | |
501 | #define wxPG_FL_IN_ONCUSTOMEDITOREVENT 0x08000000 | |
502 | #define wxPG_FL_VALUE_CHANGE_IN_EVENT 0x10000000 | |
503 | // Editor control width should not change on resize | |
504 | #define wxPG_FL_FIXED_WIDTH_EDITOR 0x20000000 | |
505 | // Width of panel can be different than width of grid | |
506 | #define wxPG_FL_HAS_VIRTUAL_WIDTH 0x40000000 | |
507 | // Prevents RecalculateVirtualSize re-entrancy | |
508 | #define wxPG_FL_RECALCULATING_VIRTUAL_SIZE 0x80000000 | |
509 | ||
510 | #endif // #ifndef SWIG | |
511 | ||
512 | #if !defined(__wxPG_SOURCE_FILE__) && !defined(SWIG) | |
513 | // Reduce compile time, but still include in user app | |
514 | #include "wx/propgrid/props.h" | |
515 | #endif | |
516 | ||
517 | // ----------------------------------------------------------------------- | |
518 | ||
519 | /** @class wxPropertyGrid | |
520 | ||
521 | wxPropertyGrid is a specialized grid for editing properties | |
522 | such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet | |
523 | used to do the very same thing, but it hasn't been updated for a while | |
524 | and it is currently deprecated. | |
525 | ||
526 | Please note that most member functions are inherited and as such not | |
527 | documented on this page. This means you will probably also want to read | |
528 | wxPropertyGridInterface class reference. | |
529 | ||
530 | See also @ref overview_propgrid. | |
531 | ||
532 | @section propgrid_window_styles_ Window Styles | |
533 | ||
534 | See @ref propgrid_window_styles. | |
535 | ||
536 | @section propgrid_event_handling Event Handling | |
537 | ||
538 | To process input from a propertygrid control, use these event handler | |
539 | macros to direct input to member functions that take a wxPropertyGridEvent | |
540 | argument. | |
541 | ||
542 | @beginEventTable{wxPropertyGridEvent} | |
543 | @event{EVT_PG_SELECTED (id, func)} | |
544 | Respond to wxEVT_PG_SELECTED event, generated when property value | |
545 | has been changed by user. | |
546 | @event{EVT_PG_CHANGING(id, func)} | |
547 | Respond to wxEVT_PG_CHANGING event, generated when property value | |
548 | is about to be changed by user. Use wxPropertyGridEvent::GetValue() | |
549 | to take a peek at the pending value, and wxPropertyGridEvent::Veto() | |
550 | to prevent change from taking place, if necessary. | |
551 | @event{EVT_PG_HIGHLIGHTED(id, func)} | |
552 | Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse | |
553 | moves over a property. Event's property is NULL if hovered area does | |
554 | not belong to any property. | |
555 | @event{EVT_PG_RIGHT_CLICK(id, func)} | |
556 | Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is | |
557 | clicked on with right mouse button. | |
558 | @event{EVT_PG_DOUBLE_CLICK(id, func)} | |
559 | Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is | |
560 | double-clicked onwith left mouse button. | |
561 | @event{EVT_PG_ITEM_COLLAPSED(id, func)} | |
562 | Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses | |
563 | a property or category.. | |
564 | @event{EVT_PG_ITEM_EXPANDED(id, func)} | |
565 | Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands | |
566 | a property or category.. | |
567 | @endEventTable | |
568 | ||
569 | @remarks | |
570 | ||
571 | - Use Freeze() and Thaw() respectively to disable and enable drawing. This | |
572 | will also delay sorting etc. miscellaneous calculations to the last | |
573 | possible moment. | |
574 | ||
575 | @library{wxpropgrid} | |
576 | @category{propgrid} | |
577 | */ | |
578 | class WXDLLIMPEXP_PROPGRID | |
579 | wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface | |
580 | { | |
581 | friend class wxPropertyGridPageState; | |
582 | friend class wxPropertyGridInterface; | |
583 | friend class wxPropertyGridManager; | |
584 | friend class wxPGCanvas; | |
585 | ||
586 | #ifndef SWIG | |
587 | DECLARE_DYNAMIC_CLASS(wxPropertyGrid) | |
588 | #endif | |
589 | public: | |
590 | ||
591 | #ifdef SWIG | |
592 | %pythonAppend wxPropertyGrid { | |
593 | self._setOORInfo(self) | |
594 | self.DoDefaultTypeMappings() | |
595 | self.edited_objects = {} | |
596 | self.DoDefaultValueTypeMappings() | |
597 | if not hasattr(self.__class__,'_vt2setter'): | |
598 | self.__class__._vt2setter = {} | |
599 | } | |
600 | %pythonAppend wxPropertyGrid() "" | |
601 | ||
602 | wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY, | |
603 | const wxPoint& pos = wxDefaultPosition, | |
604 | const wxSize& size = wxDefaultSize, | |
605 | long style = wxPG_DEFAULT_STYLE, | |
606 | const wxChar* name = wxPyPropertyGridNameStr ); | |
607 | %RenameCtor(PrePropertyGrid, wxPropertyGrid()); | |
608 | #else | |
609 | ||
610 | /** | |
611 | Two step constructor. | |
612 | ||
613 | Call Create when this constructor is called to build up the | |
614 | wxPropertyGrid | |
615 | */ | |
616 | wxPropertyGrid(); | |
617 | ||
618 | /** The default constructor. The styles to be used are styles valid for | |
619 | the wxWindow and wxScrolledWindow. | |
620 | @see @link wndflags Additional Window Styles@endlink | |
621 | */ | |
622 | wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY, | |
623 | const wxPoint& pos = wxDefaultPosition, | |
624 | const wxSize& size = wxDefaultSize, | |
625 | long style = wxPG_DEFAULT_STYLE, | |
626 | const wxChar* name = wxPropertyGridNameStr ); | |
627 | ||
628 | /** Destructor */ | |
629 | virtual ~wxPropertyGrid(); | |
630 | #endif | |
631 | ||
632 | /** Adds given key combination to trigger given action. | |
633 | @param action | |
634 | Which action to trigger. See @link pgactions List of list of | |
635 | wxPropertyGrid actions@endlink. | |
636 | */ | |
637 | void AddActionTrigger( int action, int keycode, int modifiers = 0 ); | |
638 | ||
639 | /** | |
640 | This static function enables or disables automatic use of | |
641 | wxGetTranslation for following strings: wxEnumProperty list labels, | |
642 | wxFlagsProperty sub-property labels. | |
643 | ||
644 | Default is false. | |
645 | */ | |
646 | static void AutoGetTranslation( bool enable ); | |
647 | ||
648 | /** | |
649 | Changes value of a property, as if from an editor. | |
650 | ||
651 | Use this instead of SetPropertyValue() if you need the value to run | |
652 | through validation process, and also send the property change event. | |
653 | ||
654 | @return | |
655 | Returns true if value was successfully changed. | |
656 | */ | |
657 | bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue ); | |
658 | ||
659 | /** | |
660 | Centers the splitter. | |
661 | ||
662 | If argument is true, automatic splitter centering is enabled (only | |
663 | applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined). | |
664 | */ | |
665 | void CenterSplitter( bool enable_auto_centering = false ); | |
666 | ||
667 | /** Deletes all properties. | |
668 | */ | |
669 | virtual void Clear(); | |
670 | ||
671 | /** Clears action triggers for given action. | |
672 | @param action | |
673 | Which action to trigger. See @link pgactions List of list of | |
674 | wxPropertyGrid actions@endlink. | |
675 | */ | |
676 | void ClearActionTriggers( int action ); | |
677 | ||
678 | /** Forces updating the value of property from the editor control. | |
679 | ||
680 | Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using | |
681 | ProcessEvent, meaning your event handlers will be called immediately. | |
682 | ||
683 | @return | |
684 | Returns true if anything was changed. | |
685 | */ | |
686 | virtual bool CommitChangesFromEditor( wxUint32 flags = 0 ); | |
687 | ||
688 | /** | |
689 | Two step creation. | |
690 | ||
691 | Whenever the control is created without any parameters, use Create to | |
692 | actually create it. Don't access the control's public methods before | |
693 | this is called @see @link wndflags Additional Window Styles@endlink | |
694 | */ | |
695 | bool Create( wxWindow *parent, wxWindowID id = wxID_ANY, | |
696 | const wxPoint& pos = wxDefaultPosition, | |
697 | const wxSize& size = wxDefaultSize, | |
698 | long style = wxPG_DEFAULT_STYLE, | |
699 | const wxChar* name = wxPropertyGridNameStr ); | |
700 | ||
701 | /** | |
702 | Call when editor widget's contents is modified. | |
703 | ||
704 | For example, this is called when changes text in wxTextCtrl (used in | |
705 | wxStringProperty and wxIntProperty). | |
706 | ||
707 | @remarks | |
708 | This function should only be called by custom properties. | |
709 | ||
710 | @see wxPGProperty::OnEvent() | |
711 | */ | |
712 | void EditorsValueWasModified() { m_iFlags |= wxPG_FL_VALUE_MODIFIED; } | |
713 | ||
714 | /** Reverse of EditorsValueWasModified(). | |
715 | ||
716 | @remarks | |
717 | This function should only be called by custom properties. | |
718 | */ | |
719 | void EditorsValueWasNotModified() | |
720 | { | |
721 | m_iFlags &= ~(wxPG_FL_VALUE_MODIFIED); | |
722 | } | |
723 | ||
724 | /** | |
725 | Enables or disables (shows/hides) categories according to parameter | |
726 | enable. | |
727 | */ | |
728 | bool EnableCategories( bool enable ); | |
729 | ||
730 | /** Scrolls and/or expands items to ensure that the given item is visible. | |
731 | Returns true if something was actually done. | |
732 | */ | |
733 | bool EnsureVisible( wxPGPropArg id ); | |
734 | ||
735 | /** | |
736 | Reduces column sizes to minimum possible that contents are still | |
737 | visibly (naturally some margin space will be applied as well). | |
738 | ||
739 | @return | |
740 | Minimum size for the grid to still display everything. | |
741 | ||
742 | @remarks | |
743 | Does not work well with wxPG_SPLITTER_AUTO_CENTER window style. | |
744 | ||
745 | This function only works properly if grid size prior to call was already | |
746 | fairly large. | |
747 | ||
748 | Note that you can also get calculated column widths by calling | |
749 | GetState->GetColumnWidth() immediately after this function returns. | |
750 | */ | |
751 | wxSize FitColumns() | |
752 | { | |
753 | wxSize sz = m_pState->DoFitColumns(); | |
754 | return sz; | |
755 | } | |
756 | ||
757 | /** | |
758 | Returns wxWindow that the properties are painted on, and which should | |
759 | be used as the parent for editor controls. | |
760 | */ | |
761 | wxPanel* GetPanel() const | |
762 | { | |
763 | return m_canvas; | |
764 | } | |
765 | ||
766 | /** Returns current category caption background colour. */ | |
767 | wxColour GetCaptionBackgroundColour() const { return m_colCapBack; } | |
768 | ||
769 | wxFont& GetCaptionFont() { return m_captionFont; } | |
770 | ||
771 | const wxFont& GetCaptionFont() const { return m_captionFont; } | |
772 | ||
773 | /** Returns current category caption text colour. */ | |
774 | wxColour GetCaptionForegroundColour() const { return m_colCapFore; } | |
775 | ||
776 | /** Returns current cell background colour. */ | |
777 | wxColour GetCellBackgroundColour() const { return m_colPropBack; } | |
778 | ||
779 | /** Returns current cell text colour when disabled. */ | |
780 | wxColour GetCellDisabledTextColour() const { return m_colDisPropFore; } | |
781 | ||
782 | /** Returns current cell text colour. */ | |
783 | wxColour GetCellTextColour() const { return m_colPropFore; } | |
784 | ||
6b03a638 JS |
785 | /** |
786 | Returns number of columns currently on grid. | |
787 | */ | |
1c4293cb VZ |
788 | int GetColumnCount() const |
789 | { | |
790 | return m_pState->m_colWidths.size(); | |
791 | } | |
792 | ||
793 | /** Returns colour of empty space below properties. */ | |
794 | wxColour GetEmptySpaceColour() const { return m_colEmptySpace; } | |
795 | ||
796 | /** Returns height of highest characters of used font. */ | |
797 | int GetFontHeight() const { return m_fontHeight; } | |
798 | ||
799 | /** Returns pointer to itself. Dummy function that enables same kind | |
800 | of code to use wxPropertyGrid and wxPropertyGridManager. | |
801 | */ | |
802 | wxPropertyGrid* GetGrid() { return this; } | |
803 | ||
804 | /** Returns rectangle of custom paint image. | |
805 | */ | |
806 | wxRect GetImageRect( wxPGProperty* p, int item ) const; | |
807 | ||
808 | /** Returns size of the custom paint image in front of property. | |
809 | If no argument is given, returns preferred size. | |
810 | */ | |
811 | wxSize GetImageSize( wxPGProperty* p = NULL, int item = -1 ) const; | |
812 | ||
813 | //@{ | |
814 | /** Returns last item which could be iterated using given flags. | |
815 | @param flags | |
816 | See @ref propgrid_iterator_flags. | |
817 | */ | |
818 | wxPGProperty* GetLastItem( int flags = wxPG_ITERATE_DEFAULT ) | |
819 | { | |
820 | return m_pState->GetLastItem(flags); | |
821 | } | |
822 | ||
823 | const wxPGProperty* GetLastItem( int flags = wxPG_ITERATE_DEFAULT ) const | |
824 | { | |
825 | return m_pState->GetLastItem(flags); | |
826 | } | |
827 | //@} | |
828 | ||
829 | /** Returns colour of lines between cells. */ | |
830 | wxColour GetLineColour() const { return m_colLine; } | |
831 | ||
832 | /** Returns background colour of margin. */ | |
833 | wxColour GetMarginColour() const { return m_colMargin; } | |
834 | ||
835 | /** Returns cell background colour of a property. */ | |
836 | wxColour GetPropertyBackgroundColour( wxPGPropArg id ) const; | |
837 | ||
838 | /** Returns cell background colour of a property. */ | |
839 | wxColour GetPropertyTextColour( wxPGPropArg id ) const; | |
840 | ||
841 | /** Returns "root property". It does not have name, etc. and it is not | |
842 | visible. It is only useful for accessing its children. | |
843 | */ | |
844 | wxPGProperty* GetRoot() const { return m_pState->m_properties; } | |
845 | ||
846 | /** Returns height of a single grid row (in pixels). */ | |
847 | int GetRowHeight() const { return m_lineHeight; } | |
848 | ||
849 | /** Returns currently selected property. */ | |
6b03a638 | 850 | wxPGProperty* GetSelectedProperty() const { return GetSelection(); } |
1c4293cb VZ |
851 | |
852 | /** Returns currently selected property. */ | |
853 | wxPGProperty* GetSelection() const | |
854 | { | |
855 | return m_selected; | |
856 | } | |
857 | ||
858 | /** Returns current selection background colour. */ | |
859 | wxColour GetSelectionBackgroundColour() const { return m_colSelBack; } | |
860 | ||
861 | /** Returns current selection text colour. */ | |
862 | wxColour GetSelectionForegroundColour() const { return m_colSelFore; } | |
863 | ||
864 | /** Returns current splitter x position. */ | |
865 | int GetSplitterPosition() const | |
866 | { return m_pState->DoGetSplitterPosition(0); } | |
867 | ||
868 | /** Returns wxTextCtrl active in currently selected property, if any. Takes | |
869 | into account wxOwnerDrawnComboBox. | |
870 | */ | |
871 | wxTextCtrl* GetEditorTextCtrl() const; | |
872 | ||
873 | wxPGValidationInfo& GetValidationInfo() | |
874 | { | |
875 | return m_validationInfo; | |
876 | } | |
877 | ||
878 | /** Returns current vertical spacing. */ | |
879 | int GetVerticalSpacing() const { return (int)m_vspacing; } | |
880 | ||
881 | /** Returns true if editor's value was marked modified. | |
882 | */ | |
883 | bool IsEditorsValueModified() const | |
884 | { return ( m_iFlags & wxPG_FL_VALUE_MODIFIED ) ? true : false; } | |
885 | ||
886 | /** Returns information about arbitrary position in the grid. | |
887 | ||
888 | For wxPropertyGridHitTestResult definition, see | |
889 | wxPropertyGridPageState::HitTest(). | |
890 | */ | |
891 | wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const; | |
892 | ||
893 | /** Returns true if any property has been modified by the user. */ | |
894 | bool IsAnyModified() const { return (m_pState->m_anyModified>0); } | |
895 | ||
896 | /** | |
897 | Returns true if updating is frozen (ie Freeze() called but not yet | |
898 | Thaw() ). | |
899 | */ | |
900 | bool IsFrozen() const { return (m_frozen>0)?true:false; } | |
901 | ||
902 | /** Redraws given property. | |
903 | */ | |
904 | virtual void RefreshProperty( wxPGProperty* p ); | |
905 | ||
906 | #ifndef SWIG | |
907 | /** Registers a new editor class. | |
908 | @return | |
909 | Pointer to the editor class instance that should be used. | |
910 | */ | |
911 | static wxPGEditor* RegisterEditorClass( wxPGEditor* editor, | |
1c4293cb VZ |
912 | bool noDefCheck = false ); |
913 | #endif | |
914 | ||
915 | /** Resets all colours to the original system values. | |
916 | */ | |
917 | void ResetColours(); | |
918 | ||
919 | /** | |
920 | Selects a property. | |
921 | Editor widget is automatically created, but not focused unless focus is | |
922 | true. This will generate wxEVT_PG_SELECT event. | |
923 | @param id | |
924 | Property to select. | |
925 | @return | |
926 | True if selection finished successfully. Usually only fails if | |
927 | current value in editor is not valid. | |
928 | @see wxPropertyGrid::Unselect | |
929 | */ | |
930 | bool SelectProperty( wxPGPropArg id, bool focus = false ) | |
931 | { | |
932 | wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false) | |
933 | return DoSelectProperty(p,focus?wxPG_SEL_FOCUS:0); | |
934 | } | |
935 | ||
1c4293cb VZ |
936 | /** Sets category caption background colour. */ |
937 | void SetCaptionBackgroundColour(const wxColour& col); | |
938 | ||
939 | /** Sets category caption text colour. */ | |
940 | void SetCaptionTextColour(const wxColour& col); | |
941 | ||
942 | /** Sets default cell background colour - applies to property cells. | |
943 | Note that appearance of editor widgets may not be affected. | |
944 | */ | |
945 | void SetCellBackgroundColour(const wxColour& col); | |
946 | ||
947 | /** Sets cell text colour for disabled properties. | |
948 | */ | |
949 | void SetCellDisabledTextColour(const wxColour& col); | |
950 | ||
951 | /** Sets default cell text colour - applies to property name and value text. | |
952 | Note that appearance of editor widgets may not be affected. | |
953 | */ | |
954 | void SetCellTextColour(const wxColour& col); | |
955 | ||
956 | /** Set number of columns (2 or more). | |
957 | */ | |
958 | void SetColumnCount( int colCount ) | |
959 | { | |
960 | m_pState->SetColumnCount(colCount); | |
961 | Refresh(); | |
962 | } | |
963 | ||
964 | /** | |
965 | Sets the 'current' category - Append will add non-category properties | |
966 | under it. | |
967 | */ | |
968 | void SetCurrentCategory( wxPGPropArg id ) | |
969 | { | |
970 | wxPG_PROP_ARG_CALL_PROLOG() | |
30595b81 JS |
971 | wxPropertyCategory* pc = wxDynamicCast(p, wxPropertyCategory); |
972 | wxASSERT(pc); | |
1c4293cb VZ |
973 | m_pState->m_currentCategory = pc; |
974 | } | |
975 | ||
976 | /** Sets colour of empty space below properties. */ | |
977 | void SetEmptySpaceColour(const wxColour& col); | |
978 | ||
979 | /** Sets colour of lines between cells. */ | |
980 | void SetLineColour(const wxColour& col); | |
981 | ||
982 | /** Sets background colour of margin. */ | |
983 | void SetMarginColour(const wxColour& col); | |
984 | ||
1c4293cb VZ |
985 | /** Sets background colour of property and all its children. Colours of |
986 | captions are not affected. Background brush cache is optimized for often | |
987 | set colours to be set last. | |
988 | */ | |
989 | void SetPropertyBackgroundColour( wxPGPropArg id, const wxColour& col ); | |
990 | ||
991 | /** Resets text and background colours of given property. | |
992 | */ | |
993 | void SetPropertyColoursToDefault( wxPGPropArg id ); | |
994 | ||
995 | /** Sets text colour of property and all its children. | |
996 | */ | |
997 | void SetPropertyTextColour( wxPGPropArg id, | |
998 | const wxColour& col, | |
999 | bool recursively = true ); | |
1000 | ||
1001 | /** | |
1002 | Sets selection background colour - applies to selected property name | |
1003 | background. | |
1004 | */ | |
1005 | void SetSelectionBackgroundColour(const wxColour& col); | |
1006 | ||
1007 | /** | |
1008 | Sets selection foreground colour - applies to selected property name | |
1009 | text. | |
1010 | */ | |
1011 | void SetSelectionTextColour(const wxColour& col); | |
1012 | ||
1013 | /** Sets x coordinate of the splitter. | |
1014 | @remarks | |
1015 | Splitter position cannot exceed grid size, and therefore setting it | |
1016 | during form creation may fail as initial grid size is often smaller | |
1017 | than desired splitter position, especially when sizers are being used. | |
1018 | */ | |
1019 | void SetSplitterPosition( int newxpos, int col = 0 ) | |
1020 | { | |
1021 | DoSetSplitterPosition_(newxpos, true, col); | |
1022 | m_iFlags |= wxPG_FL_SPLITTER_PRE_SET; | |
1023 | } | |
1024 | ||
1025 | /** Set virtual width for this particular page. Width -1 indicates that the | |
1026 | virtual width should be disabled. */ | |
1027 | void SetVirtualWidth( int width ); | |
1028 | ||
6b03a638 JS |
1029 | /** |
1030 | Moves splitter as left as possible, while still allowing all | |
1c4293cb | 1031 | labels to be shown in full. |
6b03a638 JS |
1032 | |
1033 | @param privateChildrenToo | |
1034 | If @false, will still allow private children to be cropped. | |
1c4293cb | 1035 | */ |
6b03a638 | 1036 | void SetSplitterLeft( bool privateChildrenToo = false ) |
1c4293cb | 1037 | { |
6b03a638 | 1038 | m_pState->SetSplitterLeft(privateChildrenToo); |
1c4293cb VZ |
1039 | } |
1040 | ||
1041 | /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font | |
1042 | height. Value of 2 should be default on most platforms. | |
1c4293cb VZ |
1043 | */ |
1044 | void SetVerticalSpacing( int vspacing ) | |
1045 | { | |
1046 | m_vspacing = (unsigned char)vspacing; | |
1047 | CalculateFontAndBitmapStuff( vspacing ); | |
1048 | if ( !m_pState->m_itemsAdded ) Refresh(); | |
1049 | } | |
1050 | ||
1051 | /** Shows an brief error message that is related to a property. */ | |
1052 | void ShowPropertyError( wxPGPropArg id, const wxString& msg ) | |
1053 | { | |
1054 | wxPG_PROP_ARG_CALL_PROLOG() | |
1055 | DoShowPropertyError(p, msg); | |
1056 | } | |
1057 | ||
1058 | /** Sorts all items at all levels (except sub-properties). */ | |
1059 | void Sort(); | |
1060 | ||
1061 | /** Sorts children of a category. | |
1062 | */ | |
1063 | void SortChildren( wxPGPropArg id ); | |
1064 | ||
1065 | ///////////////////////////////////////////////////////////////// | |
1066 | // | |
1067 | // Following methods do not need to be (currently) documented | |
1068 | // | |
1069 | ///////////////////////////////////////////////////////////////// | |
1070 | ||
1071 | bool HasVirtualWidth() const | |
1072 | { return (m_iFlags & wxPG_FL_HAS_VIRTUAL_WIDTH) ? true : false; } | |
1073 | ||
1074 | const wxPGCommonValue* GetCommonValue( unsigned int i ) const | |
1075 | { | |
1076 | return (wxPGCommonValue*) m_commonValues[i]; | |
1077 | } | |
1078 | ||
1079 | /** Returns number of common values. | |
1080 | */ | |
1081 | unsigned int GetCommonValueCount() const | |
1082 | { | |
1083 | return m_commonValues.size(); | |
1084 | } | |
1085 | ||
1086 | /** Returns label of given common value. | |
1087 | */ | |
1088 | wxString GetCommonValueLabel( unsigned int i ) const | |
1089 | { | |
1090 | wxASSERT( GetCommonValue(i) ); | |
1091 | return GetCommonValue(i)->GetLabel(); | |
1092 | } | |
1093 | ||
1094 | /** | |
1095 | Returns index of common value that will truly change value to | |
1096 | unspecified. | |
1097 | */ | |
1098 | int GetUnspecifiedCommonValue() const { return m_cvUnspecified; } | |
1099 | ||
1100 | /** Set index of common value that will truly change value to unspecified. | |
1101 | Using -1 will set none to have such effect. | |
1102 | Default is 0. | |
1103 | */ | |
1104 | void SetUnspecifiedCommonValue( int index ) { m_cvUnspecified = index; } | |
1105 | ||
1106 | /** | |
1107 | Shortcut for creating dialog-caller button. Used, for example, by | |
1108 | wxFontProperty. | |
1109 | @remarks | |
1110 | This should only be called by properties. | |
1111 | */ | |
1112 | wxWindow* GenerateEditorButton( const wxPoint& pos, const wxSize& sz ); | |
1113 | ||
1114 | /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually | |
1115 | fits as one). Call after control has been created (but before | |
1116 | shown). | |
1117 | */ | |
1118 | void FixPosForTextCtrl( wxWindow* ctrl, | |
1119 | const wxPoint& offset = wxPoint(0, 0) ); | |
1120 | ||
1121 | /** Shortcut for creating text editor widget. | |
1122 | @param pos | |
1123 | Same as pos given for CreateEditor. | |
1124 | @param sz | |
1125 | Same as sz given for CreateEditor. | |
1126 | @param value | |
1127 | Initial text for wxTextCtrl. | |
1128 | @param secondary | |
1129 | If right-side control, such as button, also created, then create it | |
1130 | first and pass it as this parameter. | |
1131 | @param extraStyle | |
1132 | Extra style flags to pass for wxTextCtrl. | |
1133 | @remarks | |
1134 | Note that this should generally be called only by new classes derived | |
1135 | from wxPGProperty. | |
1136 | */ | |
1137 | wxWindow* GenerateEditorTextCtrl( const wxPoint& pos, | |
1138 | const wxSize& sz, | |
1139 | const wxString& value, | |
1140 | wxWindow* secondary, | |
1141 | int extraStyle = 0, | |
1142 | int maxLen = 0 ); | |
1143 | ||
1144 | /* Generates both textctrl and button. | |
1145 | */ | |
1146 | wxWindow* GenerateEditorTextCtrlAndButton( const wxPoint& pos, | |
1147 | const wxSize& sz, wxWindow** psecondary, int limited_editing, | |
1148 | wxPGProperty* property ); | |
1149 | ||
1150 | /** Generates position for a widget editor dialog box. | |
1151 | @param p | |
1152 | Property for which dialog is positioned. | |
1153 | @param sz | |
1154 | Known or over-approximated size of the dialog. | |
1155 | @return | |
1156 | Position for dialog. | |
1157 | */ | |
1158 | wxPoint GetGoodEditorDialogPosition( wxPGProperty* p, | |
1159 | const wxSize& sz ); | |
1160 | ||
1161 | // Converts escape sequences in src_str to newlines, | |
1162 | // tabs, etc. and copies result to dst_str. | |
1163 | static wxString& ExpandEscapeSequences( wxString& dst_str, | |
1164 | wxString& src_str ); | |
1165 | ||
1166 | // Converts newlines, tabs, etc. in src_str to escape | |
1167 | // sequences, and copies result to dst_str. | |
1168 | static wxString& CreateEscapeSequences( wxString& dst_str, | |
1169 | wxString& src_str ); | |
1170 | ||
1171 | /** | |
1172 | Returns rectangle that fully contains properties between and including | |
1173 | p1 and p2. | |
1174 | */ | |
1175 | wxRect GetPropertyRect( const wxPGProperty* p1, | |
1176 | const wxPGProperty* p2 ) const; | |
1177 | ||
1178 | /** Returns pointer to current active primary editor control (NULL if none). | |
1c4293cb VZ |
1179 | */ |
1180 | wxWindow* GetEditorControl() const; | |
1181 | ||
1c4293cb VZ |
1182 | wxWindow* GetPrimaryEditor() const |
1183 | { | |
1184 | return GetEditorControl(); | |
1185 | } | |
1186 | ||
1187 | /** | |
1188 | Returns pointer to current active secondary editor control (NULL if | |
1189 | none). | |
1190 | */ | |
1191 | wxWindow* GetEditorControlSecondary() const | |
1192 | { | |
1193 | return m_wndEditor2; | |
1194 | } | |
1195 | ||
1196 | #ifndef SWIG | |
1197 | ||
1198 | /** | |
1199 | Generates contents for string dst based on the contents of | |
1200 | wxArrayString src. | |
1201 | ||
1202 | Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and | |
1203 | so on. Set flags to 1 inorder to convert backslashes to double-back- | |
1204 | slashes and "(preDelims)"'s to "(preDelims)". | |
1205 | */ | |
1206 | static void ArrayStringToString( wxString& dst, const wxArrayString& src, | |
1207 | wxChar preDelim, wxChar postDelim, | |
1208 | int flags ); | |
1209 | ||
1210 | // Mostly useful for page switching. | |
1211 | void SwitchState( wxPropertyGridPageState* pNewState ); | |
1212 | ||
1213 | /** Pass this function to Connect calls in propertyclass::CreateEditor. | |
1214 | */ | |
1215 | void OnCustomEditorEvent( wxCommandEvent &event ); | |
1216 | ||
1217 | long GetInternalFlags() const { return m_iFlags; } | |
1218 | void SetInternalFlag( long flag ) { m_iFlags |= flag; } | |
1219 | void ClearInternalFlag( long flag ) { m_iFlags &= ~(flag); } | |
1220 | void IncFrozen() { m_frozen++; } | |
1221 | void DecFrozen() { m_frozen--; } | |
1222 | ||
1223 | void OnComboItemPaint( wxPGCustomComboControl* pCb,int item,wxDC& dc, | |
1224 | wxRect& rect,int flags ); | |
1225 | ||
1c4293cb VZ |
1226 | /** Standardized double-to-string conversion. |
1227 | */ | |
1228 | static void DoubleToString( wxString& target, | |
1229 | double value, | |
1230 | int precision, | |
1231 | bool removeZeroes, | |
1232 | wxString* precTemplate ); | |
1233 | ||
1234 | /** | |
1235 | Call this from wxPGProperty::OnEvent() to cause property value to be | |
1236 | changed after the function returns (with true as return value). | |
1237 | ValueChangeInEvent() must be used if you wish the application to be | |
1238 | able to use wxEVT_PG_CHANGING to potentially veto the given value. | |
1239 | */ | |
1240 | void ValueChangeInEvent( wxVariant variant ) | |
1241 | { | |
1242 | m_changeInEventValue = variant; | |
1243 | m_iFlags |= wxPG_FL_VALUE_CHANGE_IN_EVENT; | |
1244 | } | |
1245 | ||
1246 | /** Returns true if given event is from first of an array of buttons | |
1247 | (as can be in case when wxPGMultiButton is used). | |
1248 | */ | |
1249 | bool IsMainButtonEvent( const wxEvent& event ) | |
1250 | { | |
1251 | return (event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED) | |
1252 | && (m_wndSecId == event.GetId()); | |
1253 | } | |
1254 | ||
1255 | /** Pending value is expected to be passed in PerformValidation(). | |
1256 | */ | |
1257 | virtual bool DoPropertyChanged( wxPGProperty* p, | |
1258 | unsigned int selFlags = 0 ); | |
1259 | ||
1260 | /** | |
1261 | Runs all validation functionality (includes sending wxEVT_PG_CHANGING). | |
1262 | Returns true if all tests passed. | |
1263 | */ | |
1264 | virtual bool PerformValidation( wxPGProperty* p, wxVariant& pendingValue ); | |
1265 | ||
1266 | /** Called when validation for given property fails. | |
1267 | @param invalidValue | |
1268 | Value which failed in validation. | |
1269 | @return | |
1270 | Return true if user is allowed to change to another property even | |
1271 | if current has invalid value. | |
1272 | @remarks | |
1273 | To add your own validation failure behavior, override | |
1274 | wxPropertyGrid::DoOnValidationFailure(). | |
1275 | */ | |
1276 | bool OnValidationFailure( wxPGProperty* property, wxVariant& invalidValue ) | |
1277 | { | |
1278 | bool res = DoOnValidationFailure(property, invalidValue); | |
1279 | property->SetFlag(wxPG_PROP_INVALID_VALUE); | |
1280 | return res; | |
1281 | } | |
1282 | ||
1283 | /** Called to indicate property and editor has valid value now. | |
1284 | */ | |
1285 | void OnValidationFailureReset( wxPGProperty* property ) | |
1286 | { | |
1287 | if ( property && property->HasFlag(wxPG_PROP_INVALID_VALUE) ) | |
1288 | { | |
1289 | DoOnValidationFailureReset(property); | |
1290 | property->ClearFlag(wxPG_PROP_INVALID_VALUE); | |
1291 | } | |
1292 | m_validationInfo.m_failureMessage.clear(); | |
1293 | } | |
1294 | ||
1295 | /** Override in derived class to display error messages in custom manner | |
1296 | (these message usually only result from validation failure). | |
1297 | */ | |
1298 | virtual void DoShowPropertyError( wxPGProperty* property, | |
1299 | const wxString& msg ); | |
1300 | ||
1301 | /** Override to customize property validation failure behavior. | |
1302 | @param invalidValue | |
1303 | Value which failed in validation. | |
1304 | @return | |
1305 | Return true if user is allowed to change to another property even | |
1306 | if current has invalid value. | |
1307 | */ | |
1308 | virtual bool DoOnValidationFailure( wxPGProperty* property, | |
1309 | wxVariant& invalidValue ); | |
1310 | ||
1311 | /** Override to customize resetting of property validation failure status. | |
1312 | @remarks | |
1313 | Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set. | |
1314 | */ | |
1315 | virtual void DoOnValidationFailureReset( wxPGProperty* property ); | |
1316 | ||
1317 | int GetSpacingY() const { return m_spacingy; } | |
1318 | ||
1319 | /** | |
1320 | Must be called in wxPGEditor::CreateControls() if primary editor window | |
1321 | is wxTextCtrl, just before textctrl is created. | |
1322 | @param text | |
1323 | Initial text value of created wxTextCtrl. | |
1324 | */ | |
1325 | void SetupTextCtrlValue( const wxString text ) { m_prevTcValue = text; } | |
1326 | ||
1327 | /** | |
1328 | Unfocuses or closes editor if one was open, but does not deselect | |
1329 | property. | |
1330 | */ | |
1331 | bool UnfocusEditor(); | |
1332 | ||
1333 | protected: | |
1334 | ||
1335 | /** | |
1336 | wxPropertyGridPageState used by the grid is created here. | |
1337 | ||
1338 | If grid is used in wxPropertyGridManager, there is no point overriding | |
1339 | this - instead, set custom wxPropertyGridPage classes. | |
1340 | */ | |
1341 | virtual wxPropertyGridPageState* CreateState() const; | |
1342 | ||
1343 | #ifndef DOXYGEN | |
1344 | public: | |
1345 | ||
1346 | // Control font changer helper. | |
1347 | void SetCurControlBoldFont(); | |
1348 | ||
1349 | // | |
1350 | // Public methods for semi-public use | |
1351 | // (not protected for optimization) | |
1352 | // | |
1353 | bool DoSelectProperty( wxPGProperty* p, unsigned int flags = 0 ); | |
1354 | ||
1355 | // Overridden functions. | |
1356 | virtual bool Destroy(); | |
1357 | virtual wxSize DoGetBestSize() const; | |
1358 | // Returns property at given y coordinate (relative to grid's top left). | |
1359 | wxPGProperty* GetItemAtY( int y ) const { return DoGetItemAtY(y); } | |
1360 | ||
1361 | virtual void Refresh( bool eraseBackground = true, | |
1362 | const wxRect *rect = (const wxRect *) NULL ); | |
1363 | virtual bool SetFont( const wxFont& font ); | |
1364 | #if wxPG_SUPPORT_TOOLTIPS | |
1365 | void SetToolTip( const wxString& tipString ); | |
1366 | #endif | |
1367 | virtual void Freeze(); | |
1368 | virtual void SetExtraStyle( long exStyle ); | |
1369 | virtual void Thaw(); | |
1370 | ||
1371 | ||
1372 | protected: | |
1373 | ||
1374 | #ifndef wxPG_ICON_WIDTH | |
1375 | wxBitmap *m_expandbmp, *m_collbmp; | |
1376 | #endif | |
1377 | ||
1378 | wxCursor *m_cursorSizeWE; | |
1379 | ||
1380 | /** wxWindow pointers to editor control(s). */ | |
1381 | wxWindow *m_wndEditor; | |
1382 | wxWindow *m_wndEditor2; | |
1383 | ||
1384 | /** wxPGCanvas instance. */ | |
1385 | wxPanel *m_canvas; | |
1386 | ||
1387 | #if wxPG_DOUBLE_BUFFER | |
1388 | wxBitmap *m_doubleBuffer; | |
1389 | #endif | |
1390 | ||
1c4293cb VZ |
1391 | /** Local time ms when control was created. */ |
1392 | wxLongLong m_timeCreated; | |
1393 | ||
1394 | /** wxPGProperty::OnEvent can change value by setting this. */ | |
1395 | wxVariant m_changeInEventValue; | |
1396 | ||
1397 | /** Id of m_wndEditor2, or its first child, if any. */ | |
1398 | int m_wndSecId; | |
1399 | ||
1400 | /** Extra Y spacing between the items. */ | |
1401 | int m_spacingy; | |
1402 | ||
1403 | /** Control client area width; updated on resize. */ | |
1404 | int m_width; | |
1405 | ||
1406 | /** Control client area height; updated on resize. */ | |
1407 | int m_height; | |
1408 | ||
1409 | /** Current non-client width (needed when auto-centering). */ | |
1410 | int m_ncWidth; | |
1411 | ||
1412 | /** Non-client width (auto-centering helper). */ | |
1413 | //int m_fWidth; | |
1414 | ||
1415 | /** Previously recorded scroll start position. */ | |
1416 | int m_prevVY; | |
1417 | ||
1418 | /** | |
1419 | The gutter spacing in front and back of the image. | |
1420 | This determines the amount of spacing in front of each item | |
1421 | */ | |
1422 | int m_gutterWidth; | |
1423 | ||
1424 | /** Includes separator line. */ | |
1425 | int m_lineHeight; | |
1426 | ||
1427 | /** Gutter*2 + image width. */ | |
1428 | int m_marginWidth; | |
1429 | ||
1430 | // y spacing for expand/collapse button. | |
1431 | int m_buttonSpacingY; | |
1432 | ||
1433 | /** Extra margin for expanded sub-group items. */ | |
1434 | int m_subgroup_extramargin; | |
1435 | ||
1436 | /** | |
1437 | The image width of the [+] icon. | |
1438 | ||
1439 | This is also calculated in the gutter | |
1440 | */ | |
1441 | int m_iconWidth; | |
1442 | ||
1443 | #ifndef wxPG_ICON_WIDTH | |
1444 | ||
1445 | /** | |
1446 | The image height of the [+] icon. | |
1447 | ||
1448 | This is calculated as minimal size and to align | |
1449 | */ | |
1450 | int m_iconHeight; | |
1451 | #endif | |
1452 | ||
1453 | /** Current cursor id. */ | |
1454 | int m_curcursor; | |
1455 | ||
1456 | /** | |
1457 | This captionFont is made equal to the font of the wxScrolledWindow. | |
1458 | ||
1459 | As extra the bold face is set on it when this is wanted by the user | |
1460 | (see flags) | |
1461 | */ | |
1462 | wxFont m_captionFont; | |
1463 | ||
1464 | int m_fontHeight; // Height of the font. | |
1465 | ||
1c4293cb VZ |
1466 | /** m_splitterx when drag began. */ |
1467 | int m_startingSplitterX; | |
1468 | ||
1469 | /** | |
1470 | Index to splitter currently being dragged (0=one after the first | |
1471 | column). | |
1472 | */ | |
1473 | int m_draggedSplitter; | |
1474 | ||
1475 | /** Changed property, calculated in PerformValidation(). */ | |
1476 | wxPGProperty* m_chgInfo_changedProperty; | |
1477 | ||
1478 | /** | |
1479 | Lowest property for which editing happened, but which does not have | |
1480 | aggregate parent | |
1481 | */ | |
1482 | wxPGProperty* m_chgInfo_baseChangedProperty; | |
1483 | ||
1484 | /** Changed property value, calculated in PerformValidation(). */ | |
1485 | wxVariant m_chgInfo_pendingValue; | |
1486 | ||
1487 | /** Passed to SetValue. */ | |
1488 | wxVariant m_chgInfo_valueList; | |
1489 | ||
1490 | /** Validation information. */ | |
1491 | wxPGValidationInfo m_validationInfo; | |
1492 | ||
1493 | /** Actions and keys that trigger them. */ | |
1494 | wxPGHashMapI2I m_actionTriggers; | |
1495 | ||
1496 | // | |
1497 | // Temporary values | |
1498 | // | |
1499 | ||
1500 | /** Bits are used to indicate which colours are customized. */ | |
1501 | unsigned short m_coloursCustomized; | |
1502 | ||
1503 | /** x - m_splitterx. */ | |
1504 | signed char m_dragOffset; | |
1505 | ||
1506 | /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */ | |
1507 | unsigned char m_dragStatus; | |
1508 | ||
1509 | /** 0 = margin, 1 = label, 2 = value. */ | |
1510 | unsigned char m_mouseSide; | |
1511 | ||
1512 | /** True when editor control is focused. */ | |
1513 | unsigned char m_editorFocused; | |
1514 | ||
1515 | /** 1 if m_latsCaption is also the bottommost caption. */ | |
1516 | //unsigned char m_lastCaptionBottomnest; | |
1517 | ||
1518 | /** Set to 1 when graphics frozen. */ | |
1519 | unsigned char m_frozen; | |
1520 | ||
1521 | unsigned char m_vspacing; | |
1522 | ||
1c4293cb VZ |
1523 | // Used to track when Alt/Ctrl+Key was consumed. |
1524 | unsigned char m_keyComboConsumed; | |
1525 | ||
1526 | /** 1 if in DoPropertyChanged() */ | |
1527 | unsigned char m_inDoPropertyChanged; | |
1528 | ||
1529 | /** 1 if in CommitChangesFromEditor() */ | |
1530 | unsigned char m_inCommitChangesFromEditor; | |
1531 | ||
1532 | /** 1 if in DoSelectProperty() */ | |
1533 | unsigned char m_inDoSelectProperty; | |
1534 | ||
1535 | wxPGVFBFlags m_permanentValidationFailureBehavior; // Set by app | |
1536 | ||
1537 | /** Internal flags - see wxPG_FL_XXX constants. */ | |
1538 | wxUint32 m_iFlags; | |
1539 | ||
1540 | /** When drawing next time, clear this many item slots at the end. */ | |
1541 | int m_clearThisMany; | |
1542 | ||
1543 | /** Pointer to selected property. Note that this is duplicated in | |
1544 | m_state for better transiency between pages so that the selected | |
1545 | item can be retained. | |
1546 | */ | |
1547 | wxPGProperty* m_selected; | |
1548 | ||
1549 | // pointer to property that has mouse hovering | |
1550 | wxPGProperty* m_propHover; | |
1551 | ||
1552 | // EventObject for wxPropertyGridEvents | |
1553 | wxWindow* m_eventObject; | |
1554 | ||
1555 | // What (global) window is currently focused (needed to resolve event | |
1556 | // handling mess). | |
1557 | wxWindow* m_curFocused; | |
1558 | ||
1559 | // wxPGTLWHandler | |
1560 | wxEvtHandler* m_tlwHandler; | |
1561 | ||
1562 | // Top level parent | |
1563 | wxWindow* m_tlp; | |
1564 | ||
1565 | // y coordinate of property that mouse hovering | |
1566 | int m_propHoverY; | |
1567 | // Which column's editor is selected (usually 1)? | |
1568 | int m_selColumn; | |
1569 | ||
1570 | // x relative to splitter (needed for resize). | |
1571 | int m_ctrlXAdjust; | |
1572 | ||
1573 | // lines between cells | |
1574 | wxColour m_colLine; | |
1575 | // property labels and values are written in this colour | |
1576 | wxColour m_colPropFore; | |
1577 | // or with this colour when disabled | |
1578 | wxColour m_colDisPropFore; | |
1579 | // background for m_colPropFore | |
1580 | wxColour m_colPropBack; | |
1581 | // text color for captions | |
1582 | wxColour m_colCapFore; | |
1583 | // background color for captions | |
1584 | wxColour m_colCapBack; | |
1585 | // foreground for selected property | |
1586 | wxColour m_colSelFore; | |
1587 | // background for selected property (actually use background color when | |
1588 | // control out-of-focus) | |
1589 | wxColour m_colSelBack; | |
1590 | // background colour for margin | |
1591 | wxColour m_colMargin; | |
1592 | // background colour for empty space below the grid | |
1593 | wxColour m_colEmptySpace; | |
1594 | ||
1c4293cb VZ |
1595 | // NB: These *cannot* be moved to globals. |
1596 | ||
1597 | // Array of background colour brushes. | |
1598 | wxArrayPtrVoid m_arrBgBrushes; | |
f7a094e1 | 1599 | |
1c4293cb VZ |
1600 | // Array of foreground colours. |
1601 | wxArrayPtrVoid m_arrFgCols; | |
1602 | ||
1603 | // labels when properties use common values | |
f7a094e1 JS |
1604 | wxVector<wxPGCommonValue*> m_commonValues; |
1605 | ||
1c4293cb VZ |
1606 | // Which cv selection really sets value to unspecified? |
1607 | int m_cvUnspecified; | |
1608 | ||
1609 | // Used to skip excess text editor events | |
1610 | wxString m_prevTcValue; | |
1611 | ||
1612 | protected: | |
1613 | ||
1614 | // Sets some members to defaults (called constructors). | |
1615 | void Init1(); | |
1616 | ||
1617 | // Initializes some members (called by Create and complex constructor). | |
1618 | void Init2(); | |
1619 | ||
1620 | void OnPaint(wxPaintEvent &event ); | |
1621 | ||
1622 | // main event receivers | |
1623 | void OnMouseMove( wxMouseEvent &event ); | |
1624 | void OnMouseMoveBottom( wxMouseEvent &event ); | |
1625 | void OnMouseClick( wxMouseEvent &event ); | |
1626 | void OnMouseRightClick( wxMouseEvent &event ); | |
1627 | void OnMouseDoubleClick( wxMouseEvent &event ); | |
1628 | void OnMouseUp( wxMouseEvent &event ); | |
1629 | void OnKey( wxKeyEvent &event ); | |
1630 | void OnKeyUp( wxKeyEvent &event ); | |
1c4293cb VZ |
1631 | void OnResize( wxSizeEvent &event ); |
1632 | ||
1633 | // event handlers | |
1634 | bool HandleMouseMove( int x, unsigned int y, wxMouseEvent &event ); | |
1635 | bool HandleMouseClick( int x, unsigned int y, wxMouseEvent &event ); | |
1636 | bool HandleMouseRightClick( int x, unsigned int y, wxMouseEvent &event ); | |
1637 | bool HandleMouseDoubleClick( int x, unsigned int y, wxMouseEvent &event ); | |
1638 | bool HandleMouseUp( int x, unsigned int y, wxMouseEvent &event ); | |
1639 | void HandleKeyEvent( wxKeyEvent &event ); | |
1640 | // Handle TAB and ESCAPE in control | |
1641 | bool HandleChildKey( wxKeyEvent& event ); | |
1642 | ||
1643 | void OnMouseEntry( wxMouseEvent &event ); | |
1644 | ||
1645 | void OnIdle( wxIdleEvent &event ); | |
1646 | void OnFocusEvent( wxFocusEvent &event ); | |
1647 | void OnChildFocusEvent( wxChildFocusEvent& event ); | |
1648 | ||
1649 | bool OnMouseCommon( wxMouseEvent &event, int* px, int *py ); | |
1650 | bool OnMouseChildCommon( wxMouseEvent &event, int* px, int *py ); | |
1651 | ||
1652 | // sub-control event handlers | |
1653 | void OnMouseClickChild( wxMouseEvent &event ); | |
1654 | void OnMouseRightClickChild( wxMouseEvent &event ); | |
1655 | void OnMouseMoveChild( wxMouseEvent &event ); | |
1656 | void OnMouseUpChild( wxMouseEvent &event ); | |
1657 | void OnChildKeyDown( wxKeyEvent &event ); | |
1658 | void OnChildKeyUp( wxKeyEvent &event ); | |
1659 | ||
1660 | void OnCaptureChange( wxMouseCaptureChangedEvent &event ); | |
1661 | ||
1662 | void OnScrollEvent( wxScrollWinEvent &event ); | |
1663 | ||
1664 | void OnSysColourChanged( wxSysColourChangedEvent &event ); | |
1665 | ||
1666 | protected: | |
1667 | ||
1668 | /** | |
1669 | Adjust the centering of the bitmap icons (collapse / expand) when the | |
1670 | caption font changes. | |
1671 | ||
1672 | They need to be centered in the middle of the font, so a bit of deltaY | |
1673 | adjustment is needed. On entry, m_captionFont must be set to window | |
1674 | font. It will be modified properly. | |
1675 | */ | |
1676 | void CalculateFontAndBitmapStuff( int vspacing ); | |
1677 | ||
1678 | wxRect GetEditorWidgetRect( wxPGProperty* p, int column ) const; | |
1679 | ||
1680 | void CorrectEditorWidgetSizeX(); | |
1681 | ||
1682 | /** Called in RecalculateVirtualSize() to reposition control | |
1683 | on virtual height changes. | |
1684 | */ | |
1685 | void CorrectEditorWidgetPosY(); | |
1686 | ||
1687 | #ifdef __WXDEBUG__ | |
1688 | void _log_items(); | |
1689 | void OnScreenNote( const wxChar* format, ... ); | |
1690 | #endif | |
1691 | ||
1692 | /** Deselect current selection, if any. Returns true if success | |
1693 | (ie. validator did not intercept). */ | |
1694 | bool DoClearSelection(); | |
1695 | ||
1696 | int DoDrawItems( wxDC& dc, | |
1697 | const wxPGProperty* first_item, | |
1698 | const wxPGProperty* last_item, | |
1699 | const wxRect* clip_rect, | |
1700 | bool isBuffered ) const; | |
1701 | ||
1702 | void DoSetPropertyValueUnspecified( wxPGProperty* p ); | |
1703 | ||
1704 | /** Draws an expand/collapse (ie. +/-) button. | |
1705 | */ | |
1706 | virtual void DrawExpanderButton( wxDC& dc, const wxRect& rect, | |
1707 | wxPGProperty* property ) const; | |
1708 | ||
1709 | /** Draws items from topitemy to bottomitemy */ | |
1710 | void DrawItems( wxDC& dc, unsigned int topitemy, unsigned int bottomitemy, | |
1711 | const wxRect* clip_rect = (const wxRect*) NULL ); | |
1712 | ||
1713 | void DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 ); | |
1714 | ||
1715 | void DrawItem( wxPGProperty* p ) | |
1716 | { | |
1717 | DrawItems(p,p); | |
1718 | } | |
1719 | ||
1720 | virtual void DrawItemAndChildren( wxPGProperty* p ); | |
1721 | ||
1722 | /** | |
1723 | Draws item, children, and consequtive parents as long as category is | |
1724 | not met. | |
1725 | */ | |
1726 | void DrawItemAndValueRelated( wxPGProperty* p ); | |
1727 | ||
1728 | // Translate wxKeyEvent to wxPG_ACTION_XXX | |
1729 | int KeyEventToActions(wxKeyEvent &event, int* pSecond) const; | |
1730 | ||
1731 | int KeyEventToAction(wxKeyEvent &event) const | |
1732 | { | |
1733 | return KeyEventToActions(event, NULL); | |
1734 | } | |
1735 | ||
1736 | void ImprovedClientToScreen( int* px, int* py ); | |
1737 | ||
1738 | // Called by focus event handlers. newFocused is the window that becomes | |
1739 | // focused. | |
1740 | void HandleFocusChange( wxWindow* newFocused ); | |
1741 | ||
1742 | /** Reloads all non-customized colours from system settings. */ | |
1743 | void RegainColours(); | |
1744 | ||
1745 | bool DoEditorValidate(); | |
1746 | ||
1747 | wxPGProperty* DoGetItemAtY( int y ) const; | |
1748 | ||
1749 | void DoSetSplitterPosition_( int newxpos, | |
1750 | bool refresh = true, | |
1751 | int splitterIndex = 0, | |
1752 | bool allPages = false ); | |
1753 | ||
1754 | void FreeEditors(); | |
1755 | ||
1756 | virtual bool DoExpand( wxPGProperty* p, bool sendEvent = false ); | |
1757 | ||
1758 | virtual bool DoCollapse( wxPGProperty* p, bool sendEvent = false ); | |
1759 | ||
1760 | // Returns nearest paint visible property (such that will be painted unless | |
1761 | // window is scrolled or resized). If given property is paint visible, then | |
1762 | // it itself will be returned. | |
1763 | wxPGProperty* GetNearestPaintVisible( wxPGProperty* p ) const; | |
1764 | ||
1765 | static void RegisterDefaultEditors(); | |
1766 | ||
1767 | // Sets m_bgColIndex to this property and all its children. | |
1768 | void SetBackgroundColourIndex( wxPGProperty* p, int index ); | |
1769 | ||
1770 | // Sets m_fgColIndex to this property and all its children. | |
1771 | void SetTextColourIndex( wxPGProperty* p, int index, int flags ); | |
1772 | ||
1773 | int CacheColour( const wxColour& colour ); | |
1774 | ||
d9fb481c | 1775 | // Sets up basic event handling for child control |
28fb19ef | 1776 | void SetupChildEventHandling( wxWindow* wnd ); |
1c4293cb VZ |
1777 | |
1778 | void CustomSetCursor( int type, bool override = false ); | |
1779 | ||
1780 | virtual bool ProcessEvent(wxEvent& event); | |
1781 | virtual void SetWindowStyleFlag( long style ); | |
1782 | ||
1783 | /** | |
1784 | Repositions scrollbar and underlying panel according to changed virtual | |
1785 | size. | |
1786 | */ | |
1787 | void RecalculateVirtualSize( int forceXPos = -1 ); | |
1788 | ||
1789 | void PrepareAfterItemsAdded(); | |
1790 | ||
1791 | bool SendEvent( int eventType, | |
1792 | wxPGProperty* p, | |
1793 | wxVariant* pValue = NULL, | |
1794 | unsigned int selFlags = 0 ); | |
1795 | ||
0ca422ef | 1796 | void SetFocusOnCanvas(); |
c29e714c | 1797 | |
1c4293cb VZ |
1798 | bool DoHideProperty( wxPGProperty* p, bool hide, int flags ); |
1799 | ||
1800 | private: | |
1801 | ||
1766bf34 | 1802 | bool ButtonTriggerKeyTest( int action, wxKeyEvent& event ); |
1c4293cb VZ |
1803 | |
1804 | #endif // DOXYGEN_SHOULD_SKIP_THIS | |
1805 | ||
1806 | private: | |
1807 | DECLARE_EVENT_TABLE() | |
1808 | #endif // #ifndef SWIG | |
1809 | }; | |
1810 | ||
1811 | // ----------------------------------------------------------------------- | |
1812 | // | |
1813 | // Bunch of inlines that need to resolved after all classes have been defined. | |
1814 | // | |
1815 | ||
1816 | #ifndef SWIG | |
1817 | inline bool wxPropertyGridPageState::IsDisplayed() const | |
1818 | { | |
1819 | return ( this == m_pPropGrid->GetState() ); | |
1820 | } | |
1821 | ||
1822 | inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const | |
1823 | { | |
1824 | return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight()); | |
1825 | } | |
1826 | #endif | |
1827 | ||
1828 | inline int wxPGProperty::GetDisplayedCommonValueCount() const | |
1829 | { | |
1830 | if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE) ) | |
1831 | { | |
1832 | wxPropertyGrid* pg = GetGrid(); | |
1833 | if ( pg ) | |
1834 | return pg->GetCommonValueCount(); | |
1835 | } | |
1836 | return 0; | |
1837 | } | |
1838 | ||
1839 | inline void wxPGProperty::SetEditor( const wxString& editorName ) | |
1840 | { | |
1841 | m_customEditor = wxPropertyGridInterface::GetEditorByName(editorName); | |
1842 | } | |
1843 | ||
1844 | inline void wxPGProperty::SetName( const wxString& newName ) | |
1845 | { | |
1846 | GetGrid()->SetPropertyName(this, newName); | |
1847 | } | |
1848 | ||
1849 | inline bool wxPGProperty::Hide( bool hide, int flags ) | |
1850 | { | |
1851 | return GetGrid()->HideProperty(this, hide, flags); | |
1852 | } | |
1853 | ||
1854 | inline bool wxPGProperty::SetMaxLength( int maxLen ) | |
1855 | { | |
1856 | return GetGrid()->SetPropertyMaxLength(this,maxLen); | |
1857 | } | |
1858 | ||
1859 | // ----------------------------------------------------------------------- | |
1860 | ||
1861 | ||
1862 | #ifndef SWIG | |
1863 | ||
1864 | #define wxPG_BASE_EVT_PRE_ID 1775 | |
1865 | ||
1866 | BEGIN_DECLARE_EVENT_TYPES() | |
1867 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_SELECTED, wxPG_BASE_EVT_PRE_ID) | |
1868 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_CHANGING, wxPG_BASE_EVT_PRE_ID+1) | |
1869 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_CHANGED, wxPG_BASE_EVT_PRE_ID+2) | |
1870 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_HIGHLIGHTED, wxPG_BASE_EVT_PRE_ID+3) | |
1871 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_RIGHT_CLICK, wxPG_BASE_EVT_PRE_ID+4) | |
1872 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_PAGE_CHANGED, wxPG_BASE_EVT_PRE_ID+5) | |
1873 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_ITEM_COLLAPSED, wxPG_BASE_EVT_PRE_ID+6) | |
1874 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_ITEM_EXPANDED, wxPG_BASE_EVT_PRE_ID+7) | |
1875 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID, wxEVT_PG_DOUBLE_CLICK, wxPG_BASE_EVT_PRE_ID+8) | |
1876 | END_DECLARE_EVENT_TYPES() | |
1877 | #else | |
1878 | enum { | |
1879 | wxEVT_PG_SELECTED = wxPG_BASE_EVT_PRE_ID, | |
1880 | wxEVT_PG_CHANGING, | |
1881 | wxEVT_PG_CHANGED, | |
1882 | wxEVT_PG_HIGHLIGHTED, | |
1883 | wxEVT_PG_RIGHT_CLICK, | |
1884 | wxEVT_PG_PAGE_CHANGED, | |
1885 | wxEVT_PG_ITEM_COLLAPSED, | |
1886 | wxEVT_PG_ITEM_EXPANDED, | |
1887 | wxEVT_PG_DOUBLE_CLICK | |
1888 | }; | |
1889 | #endif | |
1890 | ||
1891 | ||
1892 | #define wxPG_BASE_EVT_TYPE wxEVT_PG_SELECTED | |
1893 | #define wxPG_MAX_EVT_TYPE (wxPG_BASE_EVT_TYPE+30) | |
1894 | ||
1895 | ||
1896 | #ifndef SWIG | |
1897 | typedef void (wxEvtHandler::*wxPropertyGridEventFunction)(wxPropertyGridEvent&); | |
1898 | ||
1899 | #define EVT_PG_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1900 | #define EVT_PG_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1901 | #define EVT_PG_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1902 | #define EVT_PG_HIGHLIGHTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1903 | #define EVT_PG_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1904 | #define EVT_PG_DOUBLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1905 | #define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1906 | #define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1907 | #define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ), | |
1908 | ||
1909 | #define wxPropertyGridEventHandler(A) \ | |
1910 | ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A) | |
1911 | ||
1912 | #endif | |
1913 | ||
1914 | ||
1915 | /** @class wxPropertyGridEvent | |
1916 | ||
1917 | A propertygrid event holds information about events associated with | |
1918 | wxPropertyGrid objects. | |
1919 | ||
1920 | @library{wxpropgrid} | |
1921 | @category{propgrid} | |
1922 | */ | |
1923 | class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent : public wxCommandEvent | |
1924 | { | |
1925 | public: | |
1926 | ||
1927 | /** Constructor. */ | |
1928 | wxPropertyGridEvent(wxEventType commandType=0, int id=0); | |
1929 | #ifndef SWIG | |
1930 | /** Copy constructor. */ | |
1931 | wxPropertyGridEvent(const wxPropertyGridEvent& event); | |
1932 | #endif | |
1933 | /** Destructor. */ | |
1934 | ~wxPropertyGridEvent(); | |
1935 | ||
1936 | /** Copyer. */ | |
1937 | virtual wxEvent* Clone() const; | |
1938 | ||
1939 | wxPGProperty* GetMainParent() const | |
1940 | { | |
1941 | wxASSERT(m_property); | |
1942 | return m_property->GetMainParent(); | |
1943 | } | |
1944 | ||
1945 | /** Returns id of associated property. */ | |
1946 | wxPGProperty* GetProperty() const | |
1947 | { | |
1948 | return m_property; | |
1949 | } | |
1950 | ||
1951 | wxPGValidationInfo& GetValidationInfo() | |
1952 | { | |
1953 | wxASSERT(m_validationInfo); | |
1954 | return *m_validationInfo; | |
1955 | } | |
1956 | ||
1c4293cb VZ |
1957 | /** Returns true if you can veto the action that the event is signaling. |
1958 | */ | |
1959 | bool CanVeto() const { return m_canVeto; } | |
1960 | ||
1961 | /** | |
1962 | Call this from your event handler to veto action that the event is | |
1963 | signaling. | |
1964 | ||
1965 | You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns | |
1966 | true. | |
1967 | @remarks | |
1968 | Currently only wxEVT_PG_CHANGING supports vetoing. | |
1969 | */ | |
1970 | void Veto( bool veto = true ) { m_wasVetoed = veto; } | |
1971 | ||
1972 | /** Returns value that is about to be set for wxEVT_PG_CHANGING. | |
1973 | */ | |
1974 | const wxVariant& GetValue() const | |
1975 | { | |
1976 | wxASSERT_MSG( m_validationInfo, | |
1977 | "Only call GetValue from a handler " | |
1978 | "of event type that supports it" ); | |
2a8312bc | 1979 | return m_validationInfo->GetValue(); |
1c4293cb VZ |
1980 | } |
1981 | ||
1982 | /** | |
1983 | Set override validation failure behavior. | |
1984 | ||
1985 | Only effective if Veto was also called, and only allowed if event type | |
1986 | is wxEVT_PG_CHANGING. | |
1987 | */ | |
2a8312bc | 1988 | void SetValidationFailureBehavior( wxPGVFBFlags flags ) |
1c4293cb VZ |
1989 | { |
1990 | wxASSERT( GetEventType() == wxEVT_PG_CHANGING ); | |
2a8312bc | 1991 | m_validationInfo->SetFailureBehavior( flags ); |
1c4293cb VZ |
1992 | } |
1993 | ||
1994 | /** Sets custom failure message for this time only. Only applies if | |
1995 | wxPG_VFB_SHOW_MESSAGE is set in validation failure flags. | |
1996 | */ | |
1997 | void SetValidationFailureMessage( const wxString& message ) | |
1998 | { | |
1999 | wxASSERT( GetEventType() == wxEVT_PG_CHANGING ); | |
2a8312bc | 2000 | m_validationInfo->SetFailureMessage( message ); |
1c4293cb VZ |
2001 | } |
2002 | ||
2003 | #ifndef SWIG | |
2004 | wxPGVFBFlags GetValidationFailureBehavior() const | |
2005 | { | |
2006 | wxASSERT( GetEventType() == wxEVT_PG_CHANGING ); | |
2a8312bc | 2007 | return m_validationInfo->GetFailureBehavior(); |
1c4293cb VZ |
2008 | } |
2009 | ||
2010 | void SetCanVeto( bool canVeto ) { m_canVeto = canVeto; } | |
2011 | bool WasVetoed() const { return m_wasVetoed; } | |
2012 | ||
2013 | /** Changes the associated property. */ | |
2014 | void SetProperty( wxPGProperty* p ) { m_property = p; } | |
2015 | ||
2016 | void SetPropertyGrid( wxPropertyGrid* pg ) { m_pg = pg; } | |
2017 | ||
2018 | void SetupValidationInfo() | |
2019 | { | |
2020 | wxASSERT(m_pg); | |
2021 | wxASSERT( GetEventType() == wxEVT_PG_CHANGING ); | |
2022 | m_validationInfo = &m_pg->GetValidationInfo(); | |
2023 | } | |
2024 | ||
2025 | private: | |
2026 | void Init(); | |
2027 | DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent) | |
2028 | ||
2029 | wxPGProperty* m_property; | |
2030 | wxPropertyGrid* m_pg; | |
2031 | wxPGValidationInfo* m_validationInfo; | |
2032 | ||
2033 | bool m_canVeto; | |
2034 | bool m_wasVetoed; | |
2035 | ||
2036 | #endif | |
2037 | }; | |
2038 | ||
2039 | ||
2040 | // ----------------------------------------------------------------------- | |
2041 | ||
2042 | /** @class wxPropertyGridPopulator | |
2043 | @ingroup classes | |
2044 | Allows populating wxPropertyGrid from arbitrary text source. | |
2045 | */ | |
2046 | class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator | |
2047 | { | |
2048 | public: | |
2049 | /** Default constructor. | |
2050 | */ | |
2051 | wxPropertyGridPopulator(); | |
2052 | ||
2053 | /** Destructor. */ | |
2054 | virtual ~wxPropertyGridPopulator(); | |
2055 | ||
2056 | void SetState( wxPropertyGridPageState* state ); | |
2057 | ||
2058 | void SetGrid( wxPropertyGrid* pg ); | |
2059 | ||
2060 | /** Appends a new property under bottommost parent. | |
2061 | @param propClass | |
2062 | Property class as string. | |
2063 | */ | |
2064 | wxPGProperty* Add( const wxString& propClass, | |
2065 | const wxString& propLabel, | |
2066 | const wxString& propName, | |
2067 | const wxString* propValue, | |
2068 | wxPGChoices* pChoices = NULL ); | |
2069 | ||
2070 | /** | |
2071 | Pushes property to the back of parent array (ie it becomes bottommost | |
2072 | parent), and starts scanning/adding children for it. | |
2073 | ||
2074 | When finished, parent array is returned to the original state. | |
2075 | */ | |
2076 | void AddChildren( wxPGProperty* property ); | |
2077 | ||
2078 | /** Adds attribute to the bottommost property. | |
2079 | @param type | |
2080 | Allowed values: "string", (same as string), "int", "bool". Empty string | |
2081 | mean autodetect. | |
2082 | */ | |
2083 | bool AddAttribute( const wxString& name, | |
2084 | const wxString& type, | |
2085 | const wxString& value ); | |
2086 | ||
2087 | /** Called once in AddChildren. | |
2088 | */ | |
2089 | virtual void DoScanForChildren() = 0; | |
2090 | ||
2091 | /** | |
2092 | Returns id of parent property for which children can currently be | |
2093 | added. | |
2094 | */ | |
2095 | wxPGProperty* GetCurParent() const | |
2096 | { | |
2097 | return (wxPGProperty*) m_propHierarchy[m_propHierarchy.size()-1]; | |
2098 | } | |
2099 | ||
2100 | wxPropertyGridPageState* GetState() { return m_state; } | |
2101 | const wxPropertyGridPageState* GetState() const { return m_state; } | |
2102 | ||
2103 | /** Like wxString::ToLong, except allows N% in addition of N. | |
2104 | */ | |
2105 | static bool ToLongPCT( const wxString& s, long* pval, long max ); | |
2106 | ||
2107 | /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into | |
2108 | wxPGChoices. Registers parsed result using idString (if not empty). | |
2109 | Also, if choices with given id already registered, then don't parse but | |
2110 | return those choices instead. | |
2111 | */ | |
2112 | wxPGChoices ParseChoices( const wxString& choicesString, | |
2113 | const wxString& idString ); | |
2114 | ||
2115 | /** Implement in derived class to do custom process when an error occurs. | |
2116 | Default implementation uses wxLogError. | |
2117 | */ | |
2118 | virtual void ProcessError( const wxString& msg ); | |
2119 | ||
2120 | protected: | |
2121 | ||
2122 | /** Used property grid. */ | |
2123 | wxPropertyGrid* m_pg; | |
2124 | ||
2125 | /** Used property grid state. */ | |
2126 | wxPropertyGridPageState* m_state; | |
2127 | ||
2128 | /** Tree-hierarchy of added properties (that can have children). */ | |
2129 | wxArrayPGProperty m_propHierarchy; | |
2130 | ||
2131 | /** Hashmap for string-id to wxPGChoicesData mapping. */ | |
2132 | wxPGHashMapS2P m_dictIdChoices; | |
2133 | }; | |
2134 | ||
2135 | // ----------------------------------------------------------------------- | |
2136 | ||
2137 | // | |
2138 | // Undefine macros that are not needed outside propertygrid sources | |
2139 | // | |
2140 | #ifndef __wxPG_SOURCE_FILE__ | |
2141 | #undef wxPG_FL_DESC_REFRESH_REQUIRED | |
2142 | #undef wxPG_FL_SCROLLBAR_DETECTED | |
2143 | #undef wxPG_FL_CREATEDSTATE | |
2144 | #undef wxPG_FL_NOSTATUSBARHELP | |
2145 | #undef wxPG_FL_SCROLLED | |
2146 | #undef wxPG_FL_FOCUS_INSIDE_CHILD | |
2147 | #undef wxPG_FL_FOCUS_INSIDE | |
2148 | #undef wxPG_FL_MOUSE_INSIDE_CHILD | |
2149 | #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE | |
2150 | #undef wxPG_FL_PRIMARY_FILLS_ENTIRE | |
2151 | #undef wxPG_FL_VALUE_MODIFIED | |
2152 | #undef wxPG_FL_MOUSE_INSIDE | |
2153 | #undef wxPG_FL_FOCUSED | |
2154 | #undef wxPG_FL_MOUSE_CAPTURED | |
2155 | #undef wxPG_FL_INITIALIZED | |
2156 | #undef wxPG_FL_ACTIVATION_BY_CLICK | |
2157 | #undef wxPG_FL_DONT_CENTER_SPLITTER | |
2158 | #undef wxPG_SUPPORT_TOOLTIPS | |
2159 | #undef wxPG_DOUBLE_BUFFER | |
2160 | #undef wxPG_ICON_WIDTH | |
2161 | #undef wxPG_USE_RENDERER_NATIVE | |
2162 | // Following are needed by the manager headers | |
2163 | // #undef const wxString& | |
2164 | #endif | |
2165 | ||
2166 | // Doxygen special | |
2167 | #ifdef DOXYGEN | |
2168 | #include "wx/propgrid/editor.h" | |
2169 | #include "wx/propgrid/manager.h" | |
2170 | #endif | |
2171 | ||
2172 | // ----------------------------------------------------------------------- | |
2173 | ||
f4bc1aa2 JS |
2174 | #endif |
2175 | ||
1c4293cb VZ |
2176 | #endif // _WX_PROPGRID_PROPGRID_H_ |
2177 |