CMakeLua/Source/WXDialog/PropertyList.h

   1 /*=========================================================================
   2
   3   Program:   WXDialog - wxWidgets X-platform GUI Front-End for CMake
   4   Module:    $RCSfile: PropertyList.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/06/30 19:54:14 $
   7   Version:   $Revision: 1.1 $
   8
   9   Author:    Jorgen Bodde
  10
  11   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  12   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  13
  14      This software is distributed WITHOUT ANY WARRANTY; without even
  15      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16      PURPOSE.  See the above copyright notices for more information.
  17
  18 =========================================================================*/
  19
  20 #ifndef __WXPROPERTYLIST_H
  21 #define __WXPROPERTYLIST_H
  22
  23
  24 #ifndef WX_PRECOMP
  25     #include "wx/wx.h"
  26 #endif
  27
  28 #include <wx/dynarray.h>
  29 #include <wx/grid.h>
  30
  31 #include "../cmStandardIncludes.h"
  32
  33 #ifdef __LINUX__
  34   #define MC_DEFAULT_WILDCARD "*"
  35 #else
  36   #define MC_DEFAULT_WILDCARD "*.*"
  37 #endif
  38
  39 #if 0
  40
  41 // the editor for string/text data
  42 class wxGridCellPathEditor : public wxGridCellEditor
  43 {
  44 public:
  45     wxGridCellPathEditor();
  46
  47     virtual void Create(wxWindow* parent,
  48                         wxWindowID id,
  49                         wxEvtHandler* evtHandler);
  50     virtual void SetSize(const wxRect& rect);
  51
  52     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
  53
  54     virtual bool IsAcceptedKey(wxKeyEvent& event);
  55     virtual void BeginEdit(int row, int col, wxGrid* grid);
  56     virtual bool EndEdit(int row, int col, wxGrid* grid);
  57
  58     virtual void Reset();
  59     virtual void StartingKey(wxKeyEvent& event);
  60     virtual void HandleReturn(wxKeyEvent& event);
  61
  62     // parameters string format is "max_width"
  63     virtual void SetParameters(const wxString& params);
  64
  65     virtual wxGridCellEditor *Clone() const
  66         { return new wxGridCellPathEditor; }
  67
  68     // DJC MAPTEK
  69     // added GetValue so we can get the value which is in the control
  70     virtual wxString GetValue() const;
  71 protected:
  72     wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; }
  73
  74     // parts of our virtual functions reused by the derived classes
  75     void DoBeginEdit(const wxString& startValue);
  76     void DoReset(const wxString& startValue);
  77
  78 private:
  79     size_t   m_maxChars;        // max number of chars allowed
  80     wxString m_startValue;
  81
  82     DECLARE_NO_COPY_CLASS(wxGridCellPathEditor)
  83 };
  84
  85 #endif
  86
  87 /////////////////////////////////////////////////////////////////////////////
  88 //wxPropertyItem Items
  89 class wxPropertyItem
  90 {
  91 public:
  92     wxPropertyItem(const wxString &propName, const wxString &curValue,
  93                    const wxString &helpString, int nItemType, const wxString &cmbItems)
  94         : m_NewValue(true)
  95         , m_HelpString(helpString)
  96         , m_Removed(false)
  97         , m_propName(propName)
  98         , m_curValue(curValue)
  99         , m_nItemType(nItemType)
 100         , m_cmbItems(cmbItems)
 101         , m_Advanced(false)
 102     {
 103       //m_NewValue = true;
 104       //m_HelpString = helpString;
 105       //m_Removed = false;
 106       //m_propName = propName;
 107       //m_curValue = curValue;
 108       //m_nItemType = nItemType;
 109       //m_cmbItems = cmbItems;
 110       //m_Advanced = false;
 111     }
 112
 113     const wxString &GetCurValue() const {
 114         return m_curValue;
 115     };
 116
 117     const wxString &GetPropName() const {
 118         return m_propName;
 119     };
 120
 121     void SetCurValue(const char *str) {
 122         m_curValue = str;
 123     };
 124
 125     void SetPropName(const char *str) {
 126         m_propName = str;
 127     };
 128
 129     void SetAdvanced(bool value) {
 130         m_Advanced = value;
 131     };
 132
 133     void SetHelpString(const char *str) {
 134         m_HelpString = str;
 135     };
 136
 137     bool GetAdvanced() const {
 138         return m_Advanced;
 139     };
 140
 141     void SetNewValue(bool value) {
 142             m_NewValue = value;
 143     };
 144
 145     bool GetNewValue() const {
 146         return m_NewValue;
 147     };
 148
 149     int GetItemType() const {
 150         return m_nItemType;
 151     };
 152
 153     const wxString &GetHelpString() const {
 154         return m_HelpString;
 155     };
 156
 157     // returns true when this property item is a filepath
 158     bool IsFilePath();
 159
 160     // returns true when this property item is a dir path
 161     bool IsDirPath();
 162
 163 private:
 164     wxString m_HelpString;
 165     wxString m_propName;
 166     wxString m_curValue;
 167     int m_nItemType;
 168     wxString m_cmbItems;
 169     bool m_NewValue;
 170     bool m_Removed;
 171     bool m_Advanced;
 172 };
 173
 174 WX_DEFINE_ARRAY(wxPropertyItem *, wxPropertyItems);
 175
 176 /////////////////////////////////////////////////////////////////////////////
 177 // wxPropertyList Grid
 178 class wxPropertyList : public wxGrid
 179 {
 180 // Construction
 181 public:
 182     wxPropertyList(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition,
 183                    const wxSize& size = wxDefaultSize, long style = wxWANTS_CHARS,
 184                    const wxString& name = wxPanelNameStr)
 185         : wxGrid(parent, id, pos, size, style, name)
 186     {
 187     };
 188
 189     enum ItemType
 190     {
 191         COMBO = 0,
 192         EDIT,
 193         COLOR,
 194         FONT,
 195         FILE,
 196         CHECKBOX,
 197         PATH
 198     };
 199
 200     virtual ~wxPropertyList();
 201
 202 public:
 203     bool GetShowAdvanced() const {
 204         return m_ShowAdvanced;
 205     };
 206
 207     void SetProjectGenerated(bool value) {
 208         m_generatedProjects = value;
 209     };
 210
 211     bool IsGenerated() {
 212         return m_generatedProjects;
 213     };
 214
 215     int AddItem(const wxString &txt);
 216
 217     void AddProperty(const char* name, const char* value, const char* helpString, int type,
 218                      const char* comboItems, bool reverseOrder, bool advanced);
 219
 220     void RemoveProperty(wxPropertyItem *pItem);
 221
 222     void HideControls();
 223     void ShowAdvanced();
 224     void HideAdvanced();
 225
 226     void RemoveAll();
 227
 228     wxPropertyItem* GetItem(size_t index) {
 229         wxCHECK(index < GetCount(), 0);
 230         return m_PropertyItems[index];
 231     };
 232
 233     size_t GetCount() const {
 234         return m_PropertyItems.Count();
 235     };
 236
 237     const wxPropertyItems &GetItems() {
 238         return m_PropertyItems;
 239     };
 240
 241     void SetShowAdvanced(bool value) {
 242         m_ShowAdvanced = value;
 243     };
 244
 245     bool UpdatePropertyItem(wxPropertyItem *pItem, int row);
 246
 247     /** Returns the row of the grid on which the item is found. -1 is returned when not found */
 248     int FindProperty(wxPropertyItem *pItem);
 249
 250     /** Returns true when the cache is still dirty, which means
 251         after a configuration run, there are still new items */
 252     bool IsCacheDirty() {
 253         // check if we have items that are new
 254         for(size_t i = 0; i < m_PropertyItems.Count(); i++)
 255         {
 256             //if((m_PropertyItems[i]->GetNewValue() && m_ShowAdvanced && m_PropertyItems[i]->GetAdvanced()) ||
 257             //   (m_PropertyItems[i]->GetNewValue() && !m_ShowAdvanced))
 258             if(m_PropertyItems[i]->GetNewValue())
 259                 return true;
 260         }
 261
 262         // return flag if generated cache or not
 263         return false;
 264     };
 265
 266     /** Returns the property item from the current row. 0 if no property item found */
 267     wxPropertyItem *GetPropertyItemFromRow(int row);
 268
 269     /** Finds the property by name and returns the property item */
 270     wxPropertyItem *FindPropertyByName(const wxString &name);
 271
 272     /** Sets the search filter. Making sure that the items currently displayed
 273         match this substring query */
 274     void SetQuery(const wxString &query) {
 275         m_strQuery = query;
 276         UpdateGridView();
 277     };
 278
 279     /** Returns the last used query. */
 280     const wxString &GetQuery() {
 281         return m_strQuery;
 282     };
 283
 284     /** Function that tries to browse for the item that is selected */
 285     void BrowseSelectedItem();
 286
 287     /** Returns true when the item is browsable (file or path) and only one item is
 288         selected */
 289     bool IsSelectedItemBrowsable(int row = -1);
 290
 291 private:
 292     // order = 0 sorted
 293     // order = 1 add to top
 294     // order = 2 add to bottom
 295     int AddPropItem(wxPropertyItem* pItem, int order);
 296
 297     /** Adds the property item to the grid. */
 298     int AddPropertyToGrid(wxPropertyItem *pItem, int order)    ;
 299
 300     /** Adds / removes all the items that are currently (not) matching the
 301         query filter */
 302     void UpdateGridView();
 303
 304     void OnSelectCell( wxGridEvent& event );
 305
 306     void OnCellChange( wxGridEvent& event );
 307
 308     void OnCellPopup( wxGridEvent& event );
 309
 310     void OnIgnoreCache( wxCommandEvent& event );
 311
 312     void OnDeleteCache( wxCommandEvent& event );
 313
 314     void OnSizeGrid( wxSizeEvent &event );
 315
 316     void OnBrowseItem( wxCommandEvent& event );
 317
 318     void OnKeyPressed( wxKeyEvent &event );
 319
 320     int m_curSel;
 321     int m_prevSel;
 322     int m_nDivider;
 323     int m_nDivTop;
 324     int m_nDivBtm;
 325     int m_nOldDivX;
 326     int m_nLastBox;
 327     bool m_bTracking;
 328     bool m_bDivIsSet;
 329     bool m_ShowAdvanced;
 330     // flag to indicate the last cache load has resulted
 331     // in generating a valid project
 332     bool m_generatedProjects;
 333     wxString m_strQuery;
 334     wxPropertyItems m_PropertyItems;
 335
 336     DECLARE_EVENT_TABLE()
 337 };
 338
 339 #endif