utils/wxprop/src/proplist.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        proplist.h
   3 // Purpose:     Property list classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12  /*
  13
  14  TO DO:
  15
  16  (1) Optional popup-help for each item, and an optional Help button
  17    for dialog.
  18
  19  (2) Align Ok, Cancel, Help buttons properly.
  20
  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.
  24
  25  (4) Deriveable types for wxPropertyValue => may need to reorganise
  26  wxPropertyValue to use inheritance rather than present all-types-in-one
  27  scheme.
  28
  29  (5) Optional popup panel for value list, perhaps.
  30
  31  (6) Floating point checking routine still crashes with Floating
  32  point error for zany input.
  33
  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?
  38
  39  (8) More example validators, e.g. colour selector.
  40   */
  41
  42 #ifndef _PROPLIST_H_
  43 #define _PROPLIST_H_
  44
  45 #ifdef __GNUG__
  46 #pragma interface "proplist.h"
  47 #endif
  48
  49 #include "prop.h"
  50
  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
  59
  60 #ifdef __XVIEW__
  61 #define wxPROP_BUTTON_DEFAULT wxPROP_BUTTON_OK | wxPROP_BUTTON_CANCEL | wxPROP_BUTTON_CHECK_CROSS | wxPROP_PULLDOWN
  62 #else
  63 #define wxPROP_BUTTON_DEFAULT wxPROP_BUTTON_CHECK_CROSS | wxPROP_PULLDOWN | wxPROP_SHOWVALUES
  64 #endif
  65
  66 #define wxID_PROP_CROSS     3000
  67 #define wxID_PROP_CHECK     3001
  68 #define wxID_PROP_EDIT      3002
  69 #define wxID_PROP_TEXT      3003
  70 #define wxID_PROP_SELECT    3004
  71 #define wxID_PROP_VALUE_SELECT  3005
  72
  73 // Mediates between a physical panel and the property sheet
  74 class wxPropertyListView: public wxPropertyView
  75 {
  76  DECLARE_DYNAMIC_CLASS(wxPropertyListView)
  77  protected:
  78   wxListBox *propertyScrollingList;
  79   wxListBox *valueList;     // Should really be a combobox, but we don't have one.
  80   wxTextCtrl *valueText;
  81   wxButton *confirmButton;  // A tick, as in VB
  82   wxButton *cancelButton;   // A cross, as in VB
  83   wxButton *editButton;     // Invokes the custom validator, if any
  84
  85   bool detailedEditing;     // E.g. using listbox for choices
  86
  87   static wxBitmap *tickBitmap;
  88   static wxBitmap *crossBitmap;
  89
  90   wxPanel *propertyWindow; // Panel that the controls will appear on
  91   wxWindow *managedWindow; // Frame or dialog
  92
  93   wxButton *windowCloseButton; // Or OK
  94   wxButton *windowCancelButton;
  95   wxButton *windowHelpButton;
  96  public:
  97   static bool dialogCancelled;
  98
  99   wxPropertyListView(wxPanel *propPanel = NULL, long flags = wxPROP_BUTTON_DEFAULT);
 100   ~wxPropertyListView(void);
 101
 102   // Associates and shows the view
 103   virtual void ShowView(wxPropertySheet *propertySheet, wxPanel *panel);
 104
 105   // Update this view of the viewed object, called e.g. by
 106   // the object itself.
 107   virtual bool OnUpdateView(void);
 108
 109   wxString MakeNameValueString(wxString name, wxString value);
 110
 111   // Update a single line in the list of properties
 112   virtual bool UpdatePropertyDisplayInList(wxProperty *property);
 113
 114   // Update the whole list
 115   virtual bool UpdatePropertyList(bool clearEditArea = TRUE);
 116
 117   // Find the wxListBox index corresponding to this property
 118   virtual int FindListIndexForProperty(wxProperty *property);
 119
 120   // Select and show string representation in editor the given
 121   // property. NULL resets to show no property.
 122   virtual bool ShowProperty(wxProperty *property, bool select = TRUE);
 123   virtual bool EditProperty(wxProperty *property);
 124
 125   // Update the display from the property
 126   virtual bool DisplayProperty(wxProperty *property);
 127   // Update the property from the display
 128   virtual bool RetrieveProperty(wxProperty *property);
 129
 130   // Find appropriate validator and load property into value controls
 131   virtual bool BeginShowingProperty(wxProperty *property);
 132   // Find appropriate validator and unload property from value controls
 133   virtual bool EndShowingProperty(wxProperty *property);
 134
 135   // Begin detailed editing (e.g. using value listbox)
 136   virtual void BeginDetailedEditing(void);
 137
 138   // End detailed editing (e.g. using value listbox)
 139   virtual void EndDetailedEditing(void);
 140
 141   // Called by the property listbox
 142   void OnPropertySelect(wxCommandEvent& event);
 143
 144   // Called by the value listbox
 145   void OnValueListSelect(wxCommandEvent& event);
 146
 147   virtual bool CreateControls(void);
 148   virtual void ShowTextControl(bool show);
 149   virtual void ShowListBoxControl(bool show);
 150   virtual void EnableCheck(bool show);
 151   virtual void EnableCross(bool show);
 152
 153   void OnOk(wxCommandEvent& event);
 154   void OnCancel(wxCommandEvent& event);
 155   void OnHelp(wxCommandEvent& event);
 156   void OnPropertyDoubleClick(wxCommandEvent& event);
 157 //  virtual void OnDoubleClick(void);
 158
 159   void OnCheck(wxCommandEvent& event);
 160   void OnCross(wxCommandEvent& event);
 161   void OnEdit(wxCommandEvent& event);
 162   void OnText(wxCommandEvent& event);
 163
 164   inline virtual wxListBox *GetPropertyScrollingList() { return propertyScrollingList; }
 165   inline virtual wxListBox *GetValueList() { return valueList; }
 166   inline virtual wxTextCtrl *GetValueText() { return valueText; }
 167   inline virtual wxButton *GetConfirmButton() { return confirmButton; }
 168   inline virtual wxButton *GetCancelButton() { return cancelButton; }
 169   inline virtual wxButton *GetEditButton() { return editButton; }
 170   inline virtual bool GetDetailedEditing(void) { return detailedEditing; }
 171
 172   inline virtual void AssociatePanel(wxPanel *win) { propertyWindow = win; }
 173   inline virtual wxPanel *GetPanel(void) { return propertyWindow; }
 174
 175   inline virtual void SetManagedWindow(wxWindow *win) { managedWindow = win; }
 176   inline virtual wxWindow *GetManagedWindow(void) { return managedWindow; }
 177
 178   inline virtual wxButton *GetWindowCloseButton() { return windowCloseButton; }
 179   inline virtual wxButton *GetWindowCancelButton() { return windowCancelButton; }
 180   inline virtual wxButton *GetHelpButton() { return windowHelpButton; }
 181
 182   bool OnClose(void);
 183
 184 DECLARE_EVENT_TABLE()
 185 };
 186
 187 class wxPropertyTextEdit: public wxTextCtrl
 188 {
 189  DECLARE_CLASS(wxPropertyTextEdit)
 190  public:
 191   wxPropertyListView *view;
 192   wxPropertyTextEdit(wxPropertyListView *v, wxWindow *parent, const wxWindowID id,
 193     const wxString& value, const wxPoint& pos = wxDefaultPosition,
 194     const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = "text");
 195   void OnSetFocus(void);
 196   void OnKillFocus(void);
 197 };
 198
 199 #define wxPROP_ALLOW_TEXT_EDITING           1
 200
 201 /*
 202  * The type of validator used for property lists (Visual Basic style)
 203  */
 204
 205 class wxPropertyListValidator: public wxPropertyValidator
 206 {
 207   DECLARE_DYNAMIC_CLASS(wxPropertyListValidator)
 208  protected:
 209  public:
 210    wxPropertyListValidator(long flags = wxPROP_ALLOW_TEXT_EDITING): wxPropertyValidator(flags) { }
 211    ~wxPropertyListValidator(void) {}
 212
 213    // Called when the property is selected or deselected: typically displays the value
 214    // in the edit control (having chosen a suitable control to display: (non)editable text or listbox)
 215    virtual bool OnSelect(bool select, wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 216
 217    // Called when the property is double clicked. Extra functionality can be provided, such as
 218    // cycling through possible values.
 219    inline virtual bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)
 220    { return TRUE; }
 221
 222    // Called when the value listbox is selected. Default behaviour is to copy
 223    // string to text control, and retrieve the value into the property.
 224    virtual bool OnValueListSelect(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 225
 226    // Called when the property value is edited using standard text control
 227    virtual bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)
 228    {
 229      return TRUE;
 230    }
 231
 232    virtual bool OnClearControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 233
 234       // Called when the property is edited in detail
 235    virtual bool OnPrepareDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)
 236    {
 237      return TRUE;
 238    }
 239
 240    // Called if focus lost, IF we're in a modeless property editing situation.
 241    virtual bool OnClearDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)
 242    {
 243      return TRUE;
 244    }
 245
 246    // Called when the edit (...) button is pressed. The default implementation
 247    // calls view->BeginDetailedEditing; the filename validator (for example) overrides
 248    // this function to show the file selector.
 249    virtual void OnEdit(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 250
 251    // Called when TICK is pressed or focus is lost.
 252    // Return FALSE if value didn't check out; signal to restore old value.
 253    virtual bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)
 254    { return TRUE; }
 255
 256    // Called when TICK is pressed or focus is lost or view wants to update
 257    // the property list.
 258    // Does the transferance from the property editing area to the property itself
 259    virtual bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 260
 261    virtual bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 262 };
 263
 264 /*
 265  * A default dialog box class to use.
 266  */
 267
 268 class wxPropertyListDialog: public wxDialog
 269 {
 270   DECLARE_CLASS(wxPropertyListDialog)
 271  private:
 272   wxPropertyListView *view;
 273  public:
 274   wxPropertyListDialog(wxPropertyListView *v, wxWindow *parent, const wxString& title,
 275     const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 276     long style = wxDEFAULT_DIALOG_STYLE, const wxString& name = "dialogBox");
 277   bool OnClose(void);
 278   void OnDefaultAction(wxControl *item);
 279   void OnCancel(wxCommandEvent& event);
 280
 281   // Extend event processing to search the view's event table
 282   virtual bool ProcessEvent(wxEvent& event);
 283
 284 DECLARE_EVENT_TABLE()
 285 };
 286
 287 /*
 288  * A default panel class to use.
 289  */
 290
 291 class wxPropertyListPanel: public wxPanel
 292 {
 293   DECLARE_CLASS(wxPropertyListPanel)
 294  private:
 295   wxPropertyListView *view;
 296  public:
 297   wxPropertyListPanel(wxPropertyListView *v, wxWindow *parent, const wxPoint& pos = wxDefaultPosition,
 298     const wxSize& size = wxDefaultSize,
 299     long style = 0, const wxString& name = "panel"):
 300      wxPanel(parent, -1, pos, size, style, name)
 301   {
 302     view = v;
 303   }
 304   void OnDefaultAction(wxControl *item);
 305
 306   // Extend event processing to search the view's event table
 307   virtual bool ProcessEvent(wxEvent& event);
 308 };
 309
 310 /*
 311  * A default frame class to use.
 312  */
 313
 314 class wxPropertyListFrame: public wxFrame
 315 {
 316   DECLARE_CLASS(wxPropertyListFrame)
 317  private:
 318   wxPropertyListView *view;
 319   wxPanel *propertyPanel;
 320  public:
 321   wxPropertyListFrame(wxPropertyListView *v, wxFrame *parent, const wxString& title,
 322     const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 323     long style = wxDEFAULT_FRAME, const wxString& name = "frame"):
 324      wxFrame(parent, -1, title, pos, size, style, name)
 325   {
 326     view = v;
 327     propertyPanel = NULL;
 328   }
 329   bool OnClose(void);
 330
 331   // Must call this to create panel and associate view
 332   virtual bool Initialize(void);
 333   virtual wxPanel *OnCreatePanel(wxFrame *parent, wxPropertyListView *v);
 334   inline virtual wxPanel *GetPropertyPanel(void) { return propertyPanel; }
 335 };
 336
 337 /*
 338  * Some default validators
 339  */
 340
 341 class wxRealListValidator: public wxPropertyListValidator
 342 {
 343   DECLARE_DYNAMIC_CLASS(wxRealListValidator)
 344  protected:
 345   float realMin;
 346   float realMax;
 347  public:
 348    // 0.0, 0.0 means no range
 349    wxRealListValidator(float min = 0.0, float max = 0.0, long flags = wxPROP_ALLOW_TEXT_EDITING):wxPropertyListValidator(flags)
 350    {
 351      realMin = min; realMax = max;
 352    }
 353    ~wxRealListValidator(void) {}
 354
 355    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 356
 357    // Called when TICK is pressed or focus is lost.
 358    // Return FALSE if value didn't check out; signal to restore old value.
 359    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 360
 361    // Called when TICK is pressed or focus is lost or view wants to update
 362    // the property list.
 363    // Does the transfer from the property editing area to the property itself
 364    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 365 };
 366
 367 class wxIntegerListValidator: public wxPropertyListValidator
 368 {
 369   DECLARE_DYNAMIC_CLASS(wxIntegerListValidator)
 370  protected:
 371   long integerMin;
 372   long integerMax;
 373  public:
 374    // 0, 0 means no range
 375    wxIntegerListValidator(long min = 0, long max = 0, long flags = wxPROP_ALLOW_TEXT_EDITING):wxPropertyListValidator(flags)
 376    {
 377      integerMin = min; integerMax = max;
 378    }
 379    ~wxIntegerListValidator(void) {}
 380
 381    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 382
 383    // Called when TICK is pressed or focus is lost.
 384    // Return FALSE if value didn't check out; signal to restore old value.
 385    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 386
 387    // Called when TICK is pressed or focus is lost or view wants to update
 388    // the property list.
 389    // Does the transfer from the property editing area to the property itself
 390    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 391 };
 392
 393 class wxBoolListValidator: public wxPropertyListValidator
 394 {
 395   DECLARE_DYNAMIC_CLASS(wxBoolListValidator)
 396  protected:
 397  public:
 398    wxBoolListValidator(long flags = 0):wxPropertyListValidator(flags)
 399    {
 400    }
 401    ~wxBoolListValidator(void) {}
 402
 403    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 404    bool OnPrepareDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 405    bool OnClearDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 406
 407    // Called when TICK is pressed or focus is lost.
 408    // Return FALSE if value didn't check out; signal to restore old value.
 409    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 410
 411    // Called when TICK is pressed or focus is lost or view wants to update
 412    // the property list.
 413    // Does the transfer from the property editing area to the property itself
 414    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 415    bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 416
 417    // Called when the property is double clicked. Extra functionality can be provided,
 418    // cycling through possible values.
 419    virtual bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 420 };
 421
 422 class wxStringListValidator: public wxPropertyListValidator
 423 {
 424   DECLARE_DYNAMIC_CLASS(wxStringListValidator)
 425  protected:
 426   wxStringList *strings;
 427  public:
 428    wxStringListValidator(wxStringList *list = NULL, long flags = 0);
 429
 430    ~wxStringListValidator(void)
 431    {
 432      if (strings)
 433        delete strings;
 434    }
 435
 436    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 437    bool OnPrepareDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 438    bool OnClearDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 439
 440    // Called when TICK is pressed or focus is lost.
 441    // Return FALSE if value didn't check out; signal to restore old value.
 442    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 443
 444    // Called when TICK is pressed or focus is lost or view wants to update
 445    // the property list.
 446    // Does the transfer from the property editing area to the property itself
 447    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 448    bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 449
 450    // Called when the property is double clicked. Extra functionality can be provided,
 451    // cycling through possible values.
 452    bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 453 };
 454
 455 class wxFilenameListValidator: public wxPropertyListValidator
 456 {
 457   DECLARE_DYNAMIC_CLASS(wxFilenameListValidator)
 458  protected:
 459   wxString filenameWildCard;
 460   wxString filenameMessage;
 461
 462  public:
 463    wxFilenameListValidator(wxString message = "Select a file", wxString wildcard = "*.*", long flags = 0);
 464
 465    ~wxFilenameListValidator(void);
 466
 467    // Called when TICK is pressed or focus is lost.
 468    // Return FALSE if value didn't check out; signal to restore old value.
 469    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 470
 471    // Called when TICK is pressed or focus is lost or view wants to update
 472    // the property list.
 473    // Does the transferance from the property editing area to the property itself
 474    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 475    bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 476
 477    bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 478
 479    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 480
 481    // Called when the edit (...) button is pressed.
 482    void OnEdit(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 483 };
 484
 485 class wxColourListValidator: public wxPropertyListValidator
 486 {
 487   DECLARE_DYNAMIC_CLASS(wxColourListValidator)
 488  protected:
 489  public:
 490    wxColourListValidator(long flags = 0);
 491
 492    ~wxColourListValidator(void);
 493
 494    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 495    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 496    bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 497
 498    bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 499
 500    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 501
 502    // Called when the edit (...) button is pressed.
 503    void OnEdit(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 504 };
 505
 506 class wxListOfStringsListValidator: public wxPropertyListValidator
 507 {
 508   DECLARE_DYNAMIC_CLASS(wxListOfStringsListValidator)
 509  protected:
 510  public:
 511    wxListOfStringsListValidator(long flags = 0);
 512
 513    ~wxListOfStringsListValidator(void)
 514    {
 515    }
 516
 517    bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 518
 519    // Called when TICK is pressed or focus is lost.
 520    // Return FALSE if value didn't check out; signal to restore old value.
 521    bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 522
 523    // Called when TICK is pressed or focus is lost or view wants to update
 524    // the property list.
 525    // Does the transfer from the property editing area to the property itself
 526    bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 527    bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 528
 529    // Called when the property is double clicked.
 530    bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 531
 532    bool EditStringList(wxWindow *parent, wxStringList *stringList, const char *title = "String List Editor");
 533
 534    // Called when the edit (...) button is pressed.
 535    void OnEdit(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow);
 536 };
 537
 538 #endif
 539