1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Property list classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 (1) Optional popup-help for each item, and an optional Help button
19 (2) Align Ok, Cancel, Help buttons properly.
21 (3) Consider retrieving the rectangle on the panel that can be
22 drawn into (where the value listbox is) and giving an example
23 of editing graphically. May be too fancy.
25 (4) Deriveable types for wxPropertyValue => may need to reorganise
26 wxPropertyValue to use inheritance rather than present all-types-in-one
29 (5) Optional popup panel for value list, perhaps.
31 (6) Floating point checking routine still crashes with Floating
32 point error for zany input.
34 (7) Property sheet with choice (or listbox) to select alternative
35 sheets... multiple views per panel, only one active. For this
36 we really need a wxChoice that can be dynamically set: XView
37 may be a problem; Motif?
39 (8) More example validators, e.g. colour selector.
42 #ifndef _WX_PROPLIST_H_
43 #define _WX_PROPLIST_H_
46 #pragma interface "proplist.h"
51 #define wxPROP_BUTTON_CLOSE 1
52 #define wxPROP_BUTTON_OK 2
53 #define wxPROP_BUTTON_CANCEL 4
54 #define wxPROP_BUTTON_CHECK_CROSS 8
55 #define wxPROP_BUTTON_HELP 16
56 #define wxPROP_DYNAMIC_VALUE_FIELD 32
57 #define wxPROP_PULLDOWN 64
58 #define wxPROP_SHOWVALUES 128
60 // Show OK/Cancel buttons on X-based systems where window management is
62 #if defined(__WXMOTIF__) || defined(__WXGTK__)
63 #define wxPROP_BUTTON_DEFAULT wxPROP_BUTTON_OK | wxPROP_BUTTON_CANCEL | wxPROP_BUTTON_CHECK_CROSS | wxPROP_PULLDOWN
65 #define wxPROP_BUTTON_DEFAULT wxPROP_BUTTON_CHECK_CROSS | wxPROP_PULLDOWN | wxPROP_SHOWVALUES
68 #define wxID_PROP_CROSS 3000
69 #define wxID_PROP_CHECK 3001
70 #define wxID_PROP_EDIT 3002
71 #define wxID_PROP_TEXT 3003
72 #define wxID_PROP_SELECT 3004
73 #define wxID_PROP_VALUE_SELECT 3005
75 // Mediates between a physical panel and the property sheet
76 class WXDLLEXPORT wxPropertyListView
: public wxPropertyView
78 DECLARE_DYNAMIC_CLASS(wxPropertyListView
)
80 wxPropertyListView(wxPanel
*propPanel
= NULL
, long flags
= wxPROP_BUTTON_DEFAULT
);
81 ~wxPropertyListView(void);
83 // Associates and shows the view
84 virtual void ShowView(wxPropertySheet
*propertySheet
, wxPanel
*panel
);
86 // Update this view of the viewed object, called e.g. by
88 virtual bool OnUpdateView(void);
90 wxString
MakeNameValueString(wxString name
, wxString value
);
92 // Update a single line in the list of properties
93 virtual bool UpdatePropertyDisplayInList(wxProperty
*property
);
95 // Update the whole list
96 virtual bool UpdatePropertyList(bool clearEditArea
= TRUE
);
98 // Find the wxListBox index corresponding to this property
99 virtual int FindListIndexForProperty(wxProperty
*property
);
101 // Select and show string representation in editor the given
102 // property. NULL resets to show no property.
103 virtual bool ShowProperty(wxProperty
*property
, bool select
= TRUE
);
104 virtual bool EditProperty(wxProperty
*property
);
106 // Update the display from the property
107 virtual bool DisplayProperty(wxProperty
*property
);
108 // Update the property from the display
109 virtual bool RetrieveProperty(wxProperty
*property
);
111 // Find appropriate validator and load property into value controls
112 virtual bool BeginShowingProperty(wxProperty
*property
);
113 // Find appropriate validator and unload property from value controls
114 virtual bool EndShowingProperty(wxProperty
*property
);
116 // Begin detailed editing (e.g. using value listbox)
117 virtual void BeginDetailedEditing(void);
119 // End detailed editing (e.g. using value listbox)
120 virtual void EndDetailedEditing(void);
122 // Called by the property listbox
123 void OnPropertySelect(wxCommandEvent
& event
);
125 // Called by the value listbox
126 void OnValueListSelect(wxCommandEvent
& event
);
128 virtual bool CreateControls(void);
129 virtual void ShowTextControl(bool show
);
130 virtual void ShowListBoxControl(bool show
);
131 virtual void EnableCheck(bool show
);
132 virtual void EnableCross(bool show
);
134 void OnOk(wxCommandEvent
& event
);
135 void OnCancel(wxCommandEvent
& event
);
136 void OnHelp(wxCommandEvent
& event
);
137 void OnPropertyDoubleClick(wxCommandEvent
& event
);
138 // virtual void OnDoubleClick(void);
140 void OnCheck(wxCommandEvent
& event
);
141 void OnCross(wxCommandEvent
& event
);
142 void OnEdit(wxCommandEvent
& event
);
143 void OnText(wxCommandEvent
& event
);
145 inline virtual wxListBox
*GetPropertyScrollingList() const { return m_propertyScrollingList
; }
146 inline virtual wxListBox
*GetValueList() const { return m_valueList
; }
147 inline virtual wxTextCtrl
*GetValueText() const { return m_valueText
; }
148 inline virtual wxButton
*GetConfirmButton() const { return m_confirmButton
; }
149 inline virtual wxButton
*GetCancelButton() const { return m_cancelButton
; }
150 inline virtual wxButton
*GetEditButton() const { return m_editButton
; }
151 inline virtual bool GetDetailedEditing(void) const { return m_detailedEditing
; }
153 inline virtual void AssociatePanel(wxPanel
*win
) { m_propertyWindow
= win
; }
154 inline virtual wxPanel
*GetPanel(void) const { return m_propertyWindow
; }
156 inline virtual void SetManagedWindow(wxWindow
*win
) { m_managedWindow
= win
; }
157 inline virtual wxWindow
*GetManagedWindow(void) const { return m_managedWindow
; }
159 inline virtual wxButton
*GetWindowCloseButton() const { return m_windowCloseButton
; }
160 inline virtual wxButton
*GetWindowCancelButton() const { return m_windowCancelButton
; }
161 inline virtual wxButton
*GetHelpButton() const { return m_windowHelpButton
; }
166 static bool sm_dialogCancelled
;
169 wxListBox
* m_propertyScrollingList
;
170 wxListBox
* m_valueList
; // Should really be a combobox, but we don't have one.
171 wxTextCtrl
* m_valueText
;
172 wxButton
* m_confirmButton
; // A tick, as in VB
173 wxButton
* m_cancelButton
; // A cross, as in VB
174 wxButton
* m_editButton
; // Invokes the custom validator, if any
175 wxSizer
* m_middleSizer
;
177 bool m_detailedEditing
; // E.g. using listbox for choices
179 wxPanel
* m_propertyWindow
; // Panel that the controls will appear on
180 wxWindow
* m_managedWindow
; // Frame or dialog
182 wxButton
* m_windowCloseButton
; // Or OK
183 wxButton
* m_windowCancelButton
;
184 wxButton
* m_windowHelpButton
;
186 DECLARE_EVENT_TABLE()
188 virtual void ShowView(wxPropertySheet
*propertySheet
, wxWindow
*window
)
189 { wxPropertyView::ShowView(propertySheet
, window
); };
192 class WXDLLEXPORT wxPropertyTextEdit
: public wxTextCtrl
194 DECLARE_CLASS(wxPropertyTextEdit
)
196 wxPropertyTextEdit(wxPropertyListView
*v
, wxWindow
*parent
, const wxWindowID id
,
197 const wxString
& value
, const wxPoint
& pos
= wxDefaultPosition
,
198 const wxSize
& size
= wxDefaultSize
, long style
= 0, const wxString
& name
= "text");
199 void OnSetFocus(void);
200 void OnKillFocus(void);
202 wxPropertyListView
* m_view
;
205 #define wxPROP_ALLOW_TEXT_EDITING 1
208 * The type of validator used for property lists (Visual Basic style)
211 class WXDLLEXPORT wxPropertyListValidator
: public wxPropertyValidator
213 DECLARE_DYNAMIC_CLASS(wxPropertyListValidator
)
216 wxPropertyListValidator(long flags
= wxPROP_ALLOW_TEXT_EDITING
): wxPropertyValidator(flags
) { }
217 ~wxPropertyListValidator(void) {}
219 // Called when the property is selected or deselected: typically displays the value
220 // in the edit control (having chosen a suitable control to display: (non)editable text or listbox)
221 virtual bool OnSelect(bool select
, wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
223 // Called when the property is double clicked. Extra functionality can be provided, such as
224 // cycling through possible values.
225 inline virtual bool OnDoubleClick(
226 wxProperty
*WXUNUSED(property
), wxPropertyListView
*WXUNUSED(view
), wxWindow
*WXUNUSED(parentWindow
) )
229 // Called when the value listbox is selected. Default behaviour is to copy
230 // string to text control, and retrieve the value into the property.
231 virtual bool OnValueListSelect(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
233 // Called when the property value is edited using standard text control
234 inline virtual bool OnPrepareControls(
235 wxProperty
*WXUNUSED(property
), wxPropertyListView
*WXUNUSED(view
), wxWindow
*WXUNUSED(parentWindow
) )
238 virtual bool OnClearControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
240 // Called when the property is edited in detail
241 inline virtual bool OnPrepareDetailControls(
242 wxProperty
*WXUNUSED(property
), wxPropertyListView
*WXUNUSED(view
), wxWindow
*WXUNUSED(parentWindow
) )
245 // Called if focus lost, IF we're in a modeless property editing situation.
246 inline virtual bool OnClearDetailControls(
247 wxProperty
*WXUNUSED(property
), wxPropertyListView
*WXUNUSED(view
), wxWindow
*WXUNUSED(parentWindow
) )
250 // Called when the edit (...) button is pressed. The default implementation
251 // calls view->BeginDetailedEditing; the filename validator (for example) overrides
252 // this function to show the file selector.
253 virtual void OnEdit(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
255 // Called when TICK is pressed or focus is lost.
256 // Return FALSE if value didn't check out; signal to restore old value.
257 inline virtual bool OnCheckValue(
258 wxProperty
*WXUNUSED(property
), wxPropertyListView
*WXUNUSED(view
), wxWindow
*WXUNUSED(parentWindow
) )
261 // Called when TICK is pressed or focus is lost or view wants to update
262 // the property list.
263 // Does the transferance from the property editing area to the property itself
264 virtual bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
266 virtual bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
270 * A default dialog box class to use.
273 class WXDLLEXPORT wxPropertyListDialog
: public wxDialog
275 DECLARE_CLASS(wxPropertyListDialog
)
277 wxPropertyListDialog(wxPropertyListView
*v
, wxWindow
*parent
, const wxString
& title
,
278 const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
279 long style
= wxDEFAULT_DIALOG_STYLE
, const wxString
& name
= "dialogBox");
280 void OnCloseWindow(wxCloseEvent
& event
);
281 void OnDefaultAction(wxControl
*item
);
282 void OnCancel(wxCommandEvent
& event
);
284 // Extend event processing to search the view's event table
285 virtual bool ProcessEvent(wxEvent
& event
);
288 wxPropertyListView
* m_view
;
290 DECLARE_EVENT_TABLE()
294 * A default panel class to use.
297 class WXDLLEXPORT wxPropertyListPanel
: public wxPanel
299 DECLARE_CLASS(wxPropertyListPanel
)
301 wxPropertyListPanel(wxPropertyListView
*v
, wxWindow
*parent
, const wxPoint
& pos
= wxDefaultPosition
,
302 const wxSize
& size
= wxDefaultSize
,
303 long style
= 0, const wxString
& name
= "panel"):
304 wxPanel(parent
, -1, pos
, size
, style
, name
)
308 ~wxPropertyListPanel();
309 void OnDefaultAction(wxControl
*item
);
311 inline void SetView(wxPropertyListView
* v
) { m_view
= v
; }
312 inline wxPropertyListView
* GetView() const { return m_view
; }
314 // Extend event processing to search the view's event table
315 virtual bool ProcessEvent(wxEvent
& event
);
318 void OnSize(wxSizeEvent
& event
);
321 wxPropertyListView
* m_view
;
323 DECLARE_EVENT_TABLE()
327 * A default frame class to use.
330 class WXDLLEXPORT wxPropertyListFrame
: public wxFrame
332 DECLARE_CLASS(wxPropertyListFrame
)
334 wxPropertyListFrame(wxPropertyListView
*v
, wxFrame
*parent
, const wxString
& title
,
335 const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
336 long style
= wxDEFAULT_FRAME_STYLE
, const wxString
& name
= "frame"):
337 wxFrame(parent
, -1, title
, pos
, size
, style
, name
)
340 m_propertyPanel
= NULL
;
342 void OnCloseWindow(wxCloseEvent
& event
);
344 // Must call this to create panel and associate view
345 virtual bool Initialize(void);
346 virtual wxPropertyListPanel
*OnCreatePanel(wxFrame
*parent
, wxPropertyListView
*v
);
347 inline virtual wxPropertyListPanel
*GetPropertyPanel(void) const { return m_propertyPanel
; }
348 inline wxPropertyListView
* GetView() const { return m_view
; }
351 wxPropertyListView
* m_view
;
352 wxPropertyListPanel
* m_propertyPanel
;
354 DECLARE_EVENT_TABLE()
358 * Some default validators
361 class WXDLLEXPORT wxRealListValidator
: public wxPropertyListValidator
363 DECLARE_DYNAMIC_CLASS(wxRealListValidator
)
365 // 0.0, 0.0 means no range
366 wxRealListValidator(float min
= 0.0, float max
= 0.0, long flags
= wxPROP_ALLOW_TEXT_EDITING
):wxPropertyListValidator(flags
)
368 m_realMin
= min
; m_realMax
= max
;
370 ~wxRealListValidator(void) {}
372 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
374 // Called when TICK is pressed or focus is lost.
375 // Return FALSE if value didn't check out; signal to restore old value.
376 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
378 // Called when TICK is pressed or focus is lost or view wants to update
379 // the property list.
380 // Does the transfer from the property editing area to the property itself
381 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
388 class WXDLLEXPORT wxIntegerListValidator
: public wxPropertyListValidator
390 DECLARE_DYNAMIC_CLASS(wxIntegerListValidator
)
392 // 0, 0 means no range
393 wxIntegerListValidator(long min
= 0, long max
= 0, long flags
= wxPROP_ALLOW_TEXT_EDITING
):wxPropertyListValidator(flags
)
395 m_integerMin
= min
; m_integerMax
= max
;
397 ~wxIntegerListValidator(void) {}
399 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
401 // Called when TICK is pressed or focus is lost.
402 // Return FALSE if value didn't check out; signal to restore old value.
403 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
405 // Called when TICK is pressed or focus is lost or view wants to update
406 // the property list.
407 // Does the transfer from the property editing area to the property itself
408 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
415 class WXDLLEXPORT wxBoolListValidator
: public wxPropertyListValidator
417 DECLARE_DYNAMIC_CLASS(wxBoolListValidator
)
420 wxBoolListValidator(long flags
= 0):wxPropertyListValidator(flags
)
423 ~wxBoolListValidator(void) {}
425 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
426 bool OnPrepareDetailControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
427 bool OnClearDetailControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
429 // Called when TICK is pressed or focus is lost.
430 // Return FALSE if value didn't check out; signal to restore old value.
431 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
433 // Called when TICK is pressed or focus is lost or view wants to update
434 // the property list.
435 // Does the transfer from the property editing area to the property itself
436 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
437 bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
439 // Called when the property is double clicked. Extra functionality can be provided,
440 // cycling through possible values.
441 virtual bool OnDoubleClick(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
444 class WXDLLEXPORT wxStringListValidator
: public wxPropertyListValidator
446 DECLARE_DYNAMIC_CLASS(wxStringListValidator
)
448 wxStringListValidator(wxStringList
*list
= NULL
, long flags
= 0);
450 ~wxStringListValidator(void)
456 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
457 bool OnPrepareDetailControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
458 bool OnClearDetailControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
460 // Called when TICK is pressed or focus is lost.
461 // Return FALSE if value didn't check out; signal to restore old value.
462 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
464 // Called when TICK is pressed or focus is lost or view wants to update
465 // the property list.
466 // Does the transfer from the property editing area to the property itself
467 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
468 bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
470 // Called when the property is double clicked. Extra functionality can be provided,
471 // cycling through possible values.
472 bool OnDoubleClick(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
475 wxStringList
* m_strings
;
478 class WXDLLEXPORT wxFilenameListValidator
: public wxPropertyListValidator
480 DECLARE_DYNAMIC_CLASS(wxFilenameListValidator
)
482 wxFilenameListValidator(wxString message
= "Select a file", wxString wildcard
= wxALL_FILES_PATTERN
, long flags
= 0);
484 ~wxFilenameListValidator(void);
486 // Called when TICK is pressed or focus is lost.
487 // Return FALSE if value didn't check out; signal to restore old value.
488 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
490 // Called when TICK is pressed or focus is lost or view wants to update
491 // the property list.
492 // Does the transferance from the property editing area to the property itself
493 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
494 bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
496 bool OnDoubleClick(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
498 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
500 // Called when the edit (...) button is pressed.
501 void OnEdit(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
504 wxString m_filenameWildCard
;
505 wxString m_filenameMessage
;
509 class WXDLLEXPORT wxColourListValidator
: public wxPropertyListValidator
511 DECLARE_DYNAMIC_CLASS(wxColourListValidator
)
514 wxColourListValidator(long flags
= 0);
516 ~wxColourListValidator(void);
518 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
519 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
520 bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
522 bool OnDoubleClick(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
524 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
526 // Called when the edit (...) button is pressed.
527 void OnEdit(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
530 class WXDLLEXPORT wxListOfStringsListValidator
: public wxPropertyListValidator
532 DECLARE_DYNAMIC_CLASS(wxListOfStringsListValidator
)
535 wxListOfStringsListValidator(long flags
= 0);
537 ~wxListOfStringsListValidator(void)
541 bool OnPrepareControls(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
543 // Called when TICK is pressed or focus is lost.
544 // Return FALSE if value didn't check out; signal to restore old value.
545 bool OnCheckValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
547 // Called when TICK is pressed or focus is lost or view wants to update
548 // the property list.
549 // Does the transfer from the property editing area to the property itself
550 bool OnRetrieveValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
551 bool OnDisplayValue(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
553 // Called when the property is double clicked.
554 bool OnDoubleClick(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);
556 bool EditStringList(wxWindow
*parent
, wxStringList
*stringList
, const wxChar
*title
= wxT("String List Editor"));
558 // Called when the edit (...) button is pressed.
559 void OnEdit(wxProperty
*property
, wxPropertyListView
*view
, wxWindow
*parentWindow
);