]> git.saurik.com Git - wxWidgets.git/blobdiff - samples/propgrid/propgrid.cpp
Implementations of wxPGProperty::ChildChanged() must now return changed value of...
[wxWidgets.git] / samples / propgrid / propgrid.cpp
index 26dbfd835d00dae2923e68f52b3ae8135d0a1db6..f373edb4746909a80e0017b6d609dfd3c1bb3e6d 100644 (file)
@@ -19,7 +19,7 @@
 //
 // * Currently there is no example of a custom property editor. However,
 //   SpinCtrl editor sample is well-commented. It can be found in
-//   contrib/src/propgrid/advprops.cpp.
+//   src/propgrid/advprops.cpp.
 //
 // * To find code that populates the grid with properties, search for
 //   string "::Populate".
 // * To find code that handles property grid changes, search for string
 //   "::OnPropertyGridChange".
 //
-// * At the end of file there is example code for using the owner-drawn combo
-//   box independently outside the wxPropertyGrid.
-//
-//
 
 // For compilers that support precompilation, includes "wx/wx.h".
 #include "wx/wxprec.h"
@@ -72,6 +68,9 @@
 
 #include <wx/artprov.h>
 
+#ifndef __WXMSW__
+    #include "../sample.xpm"
+#endif
 
 // -----------------------------------------------------------------------
 // wxSampleMultiButtonEditor
@@ -135,21 +134,21 @@ bool wxSampleMultiButtonEditor::OnEvent( wxPropertyGrid* propGrid,
 
         if ( event.GetId() == buttons->GetButtonId(0) )
         {
-            // Do something when first button is pressed
+            // Do something when the first button is pressed
             wxLogDebug("First button pressed");
-            return true;
+            return false;  // Return false since value did not change
         }
         if ( event.GetId() == buttons->GetButtonId(1) )
         {
-            // Do something when second button is pressed
-            wxLogDebug("Second button pressed");
-            return true;
+            // Do something when the second button is pressed
+            wxMessageBox("Second button pressed");
+            return false;  // Return false since value did not change
         }
         if ( event.GetId() == buttons->GetButtonId(2) )
         {
-            // Do something when third button is pressed
-            wxLogDebug("Third button pressed");
-            return true;
+            // Do something when the third button is pressed
+            wxMessageBox("Third button pressed");
+            return false;  // Return false since value did not change
         }
     }
     return wxPGTextCtrlEditor::OnEvent(propGrid, property, ctrl, event);
@@ -287,6 +286,7 @@ void wxAdvImageFileProperty::OnSetValue()
 
     if ( imagename.length() )
     {
+        wxFileName filename = GetFileName();
         size_t prevCount = g_myImageArray.GetCount();
         int index = ms_choices.Index(imagename);
 
@@ -294,7 +294,7 @@ void wxAdvImageFileProperty::OnSetValue()
         if ( index == wxNOT_FOUND )
         {
             ms_choices.Add( imagename );
-            g_myImageArray.Add( new wxMyImageInfo( m_filename.GetFullPath() ) );
+            g_myImageArray.Add( new wxMyImageInfo( filename.GetFullPath() ) );
 
             index = g_myImageArray.GetCount() - 1;
         }
@@ -303,8 +303,8 @@ void wxAdvImageFileProperty::OnSetValue()
         if ( !g_myImageArray[index].m_pThumbnail2 )
         {
             // Load if file exists.
-            if ( m_filename.FileExists() )
-                m_pImage = new wxImage( m_filename.GetFullPath() );
+            if ( filename.FileExists() )
+                m_pImage = new wxImage( filename.GetFullPath() );
         }
 
         m_index = index;
@@ -365,9 +365,10 @@ void wxAdvImageFileProperty::LoadThumbnails( size_t index )
 
     if ( !mii.m_pThumbnail2 )
     {
+        wxFileName filename = GetFileName();
 
         if ( !m_pImage || !m_pImage->Ok() ||
-             m_filename != mii.m_path
+             filename != mii.m_path
            )
         {
             if ( m_pImage )
@@ -476,9 +477,9 @@ wxVectorProperty::wxVectorProperty( const wxString& label,
     : wxPGProperty(label,name)
 {
     SetValue( WXVARIANT(value) );
-    AddChild( new wxFloatProperty(wxT("X"),wxPG_LABEL,value.x) );
-    AddChild( new wxFloatProperty(wxT("Y"),wxPG_LABEL,value.y) );
-    AddChild( new wxFloatProperty(wxT("Z"),wxPG_LABEL,value.z) );
+    AddPrivateChild( new wxFloatProperty(wxT("X"),wxPG_LABEL,value.x) );
+    AddPrivateChild( new wxFloatProperty(wxT("Y"),wxPG_LABEL,value.y) );
+    AddPrivateChild( new wxFloatProperty(wxT("Z"),wxPG_LABEL,value.z) );
 }
 
 wxVectorProperty::~wxVectorProperty() { }
@@ -492,7 +493,9 @@ void wxVectorProperty::RefreshChildren()
     Item(2)->SetValue( vector.z );
 }
 
-void wxVectorProperty::ChildChanged( wxVariant& thisValue, int childIndex, wxVariant& childValue ) const
+wxVariant wxVectorProperty::ChildChanged( wxVariant& thisValue,
+                                          int childIndex,
+                                          wxVariant& childValue ) const
 {
     wxVector3f vector;
     vector << thisValue;
@@ -502,7 +505,9 @@ void wxVectorProperty::ChildChanged( wxVariant& thisValue, int childIndex, wxVar
         case 1: vector.y = childValue.GetDouble(); break;
         case 2: vector.z = childValue.GetDouble(); break;
     }
-    thisValue << vector;
+    wxVariant newVariant;
+    newVariant << vector;
+    return newVariant;
 }
 
 
@@ -524,9 +529,9 @@ wxTriangleProperty::wxTriangleProperty( const wxString& label,
     : wxPGProperty(label,name)
 {
     SetValue( WXVARIANT(value) );
-    AddChild( new wxVectorProperty(wxT("A"),wxPG_LABEL,value.a) );
-    AddChild( new wxVectorProperty(wxT("B"),wxPG_LABEL,value.b) );
-    AddChild( new wxVectorProperty(wxT("C"),wxPG_LABEL,value.c) );
+    AddPrivateChild( new wxVectorProperty(wxT("A"),wxPG_LABEL,value.a) );
+    AddPrivateChild( new wxVectorProperty(wxT("B"),wxPG_LABEL,value.b) );
+    AddPrivateChild( new wxVectorProperty(wxT("C"),wxPG_LABEL,value.c) );
 }
 
 wxTriangleProperty::~wxTriangleProperty() { }
@@ -540,7 +545,9 @@ void wxTriangleProperty::RefreshChildren()
     Item(2)->SetValue( WXVARIANT(triangle.c) );
 }
 
-void wxTriangleProperty::ChildChanged( wxVariant& thisValue, int childIndex, wxVariant& childValue ) const
+wxVariant wxTriangleProperty::ChildChanged( wxVariant& thisValue,
+                                            int childIndex,
+                                            wxVariant& childValue ) const
 {
     wxTriangle triangle;
     triangle << thisValue;
@@ -551,7 +558,9 @@ void wxTriangleProperty::ChildChanged( wxVariant& thisValue, int childIndex, wxV
         case 1: triangle.b = vector; break;
         case 2: triangle.c = vector; break;
     }
-    thisValue << triangle;
+    wxVariant newVariant;
+    newVariant << triangle;
+    return newVariant;
 }
 
 
@@ -651,7 +660,8 @@ enum
     ID_COLOURSCHEME2,
     ID_COLOURSCHEME3,
     ID_CATCOLOURS,
-    ID_SETCOLOUR,
+    ID_SETBGCOLOUR,
+    ID_SETBGCOLOURRECUR,
     ID_STATICLAYOUT,
     ID_POPULATE1,
     ID_POPULATE2,
@@ -726,11 +736,13 @@ BEGIN_EVENT_TABLE(FormMain, wxFrame)
     EVT_MENU( ID_DELETEALL, FormMain::OnClearClick )
     EVT_MENU( ID_ENABLE, FormMain::OnEnableDisable )
     EVT_MENU( ID_HIDE, FormMain::OnHideShow )
+
     EVT_MENU( ID_ITERATE1, FormMain::OnIterate1Click )
     EVT_MENU( ID_ITERATE2, FormMain::OnIterate2Click )
     EVT_MENU( ID_ITERATE3, FormMain::OnIterate3Click )
     EVT_MENU( ID_ITERATE4, FormMain::OnIterate4Click )
-    EVT_MENU( ID_SETCOLOUR, FormMain::OnMisc )
+    EVT_MENU( ID_SETBGCOLOUR, FormMain::OnSetBackgroundColour )
+    EVT_MENU( ID_SETBGCOLOURRECUR, FormMain::OnSetBackgroundColour )
     EVT_MENU( ID_CLEARMODIF, FormMain::OnClearModifyStatusClick )
     EVT_MENU( ID_FREEZE, FormMain::OnFreezeClick )
     EVT_MENU( ID_DUMPLIST, FormMain::OnDumpList )
@@ -1366,8 +1378,9 @@ void FormMain::PopulateWithExamples ()
 
     pg->SetPropertyEditor( wxT("SpinCtrl"), wxPGEditor_SpinCtrl );
     pg->SetPropertyAttribute( wxT("SpinCtrl"), wxPG_ATTR_MIN, (long)-10 );  // Use constants instead of string
-    pg->SetPropertyAttribute( wxT("SpinCtrl"), wxPG_ATTR_MAX, (long)10 );   // for reduced binary size.
+    pg->SetPropertyAttribute( wxT("SpinCtrl"), wxPG_ATTR_MAX, (long)16384 );   // for reduced binary size.
     pg->SetPropertyAttribute( wxT("SpinCtrl"), wxT("Step"), (long)2 );
+    pg->SetPropertyAttribute( wxT("SpinCtrl"), wxT("MotionSpin"), true );
     //pg->SetPropertyAttribute( wxT("SpinCtrl"), wxT("Wrap"), true );
 
     pg->SetPropertyHelpString( wxT("SpinCtrl"),
@@ -1490,27 +1503,17 @@ void FormMain::PopulateWithExamples ()
                                   240) );
     pg->GetProperty(wxT("EnumProperty 2"))->AddChoice(wxT("Testing Extra"), 360);
 
-    // Add a second time to test that the caching works. Also use
-    // short form of constructor list + SetChoices.
-    prop = new wxEnumProperty(wxT("EnumProperty 3"), wxPG_LABEL);
-    pg->Append( prop );
-    prop->SetChoices(soc);
-    prop->SetValue(360);
-    pg->SetPropertyHelpString(prop,
-        wxT("Should have same choices as EnumProperty 2"));
-
-    pg->Append( new wxEnumProperty(wxT("EnumProperty 4"),wxPG_LABEL,
+    // Here we only display the original 'soc' choices
+    pg->Append( new wxEnumProperty(wxT("EnumProperty 3"),wxPG_LABEL,
         soc, 240 ) );
-    pg->SetPropertyHelpString(wxT("EnumProperty 4"),
-        wxT("Should have same choices as EnumProperty 2"));
 
-    pg->Append( new wxEnumProperty(wxT("EnumProperty 5"),wxPG_LABEL,
+    // 'soc' plus one exclusive extra choice "4th only"
+    pg->Append( new wxEnumProperty(wxT("EnumProperty 4"),wxPG_LABEL,
         soc, 240 ) );
-    pg->GetProperty(wxT("EnumProperty 5"))->SetChoicesExclusive();
-    pg->GetProperty(wxT("EnumProperty 5"))->AddChoice(wxT("5th only"), 360);
+    pg->GetProperty(wxT("EnumProperty 4"))->AddChoice(wxT("4th only"), 360);
 
-    pg->SetPropertyHelpString(wxT("EnumProperty 5"),
-        wxT("Should have one extra item when compared to EnumProperty 4"));
+    pg->SetPropertyHelpString(wxT("EnumProperty 4"),
+        wxT("Should have one extra item when compared to EnumProperty 3"));
 
     // Password property example.
     pg->Append( new wxStringProperty(wxT("Password"),wxPG_LABEL, wxT("password")) );
@@ -1534,6 +1537,40 @@ void FormMain::PopulateWithExamples ()
     // Set value after limiting so that it will be applied
     pg->SetPropertyValue( wxT("StringProperty"), wxT("some text") );
 
+    //
+    // Demonstrate "AutoComplete" attribute
+    pg->Append( new wxStringProperty( "StringProperty AutoComplete",
+                                      wxPG_LABEL ) );
+
+    wxArrayString autoCompleteStrings;
+    autoCompleteStrings.Add("One choice");
+    autoCompleteStrings.Add("Another choice");
+    autoCompleteStrings.Add("Another choice, yeah");
+    autoCompleteStrings.Add("Yet another choice");
+    autoCompleteStrings.Add("Yet another choice, bear with me");
+    pg->SetPropertyAttribute( "StringProperty AutoComplete",
+                              "AutoComplete",
+                              autoCompleteStrings );
+
+    pg->SetPropertyHelpString( "StringProperty AutoComplete",
+        "AutoComplete attribute has been set for this property "
+        "(try writing something beginning with 'a', 'o' or 'y').");
+
+    // Add string property with arbitrarily wide bitmap in front of it. We
+    // intentionally lower-than-typical row height here so that the ugly
+    // scaling code wont't be run.
+    pg->Append( new wxStringProperty( wxT("StringPropertyWithBitmap"),
+                wxPG_LABEL,
+                wxT("Test Text")) );
+    wxBitmap myTestBitmap(60, 15, 32);
+    wxMemoryDC mdc;
+    mdc.SelectObject(myTestBitmap);
+    mdc.Clear();
+    mdc.SetPen(*wxBLACK);
+    mdc.DrawLine(0, 0, 60, 15);
+    mdc.SelectObject(wxNullBitmap);
+    pg->SetPropertyImage( wxT("StringPropertyWithBitmap"), myTestBitmap );
 
     // this value array would be optional if values matched string indexes
     //long flags_prop_values[] = { wxICONIZE, wxCAPTION, wxMINIMIZE_BOX, wxMAXIMIZE_BOX };
@@ -1589,11 +1626,13 @@ void FormMain::PopulateWithExamples ()
 
 #if wxUSE_DATEPICKCTRL
     pg->SetPropertyAttribute( wxT("DateProperty"), wxPG_DATE_PICKER_STYLE,
-                              (long)(wxDP_DROPDOWN | wxDP_SHOWCENTURY) );
+                              (long)(wxDP_DROPDOWN |
+                                     wxDP_SHOWCENTURY |
+                                     wxDP_ALLOWNONE) );
 
     pg->SetPropertyHelpString( wxT("DateProperty"),
-        wxT("Attribute wxPG_DATE_PICKER_STYLE has been set to (long)(wxDP_DROPDOWN | wxDP_SHOWCENTURY).")
-        wxT("Also note that wxPG_ALLOW_WXADV needs to be defined inorder to use wxDatePickerCtrl.") );
+        wxT("Attribute wxPG_DATE_PICKER_STYLE has been set to (long)")
+        wxT("(wxDP_DROPDOWN | wxDP_SHOWCENTURY | wxDP_ALLOWNONE).") );
 #endif
 
 #endif
@@ -1656,6 +1695,10 @@ void FormMain::PopulateWithExamples ()
                                             wxPG_LABEL,
                                             300000) );
 
+    pg->AppendIn(carProp, new wxBoolProperty(wxT("Convertible"),
+                                             wxPG_LABEL,
+                                             false) );
+
     // Displayed value of "Car" property is now very close to this:
     // "Lamborghini Diablo SV; 5707 [300; 3.9; 8.6] 300000"
 
@@ -1683,11 +1726,22 @@ void FormMain::PopulateWithExamples ()
 
     //
     // Test how non-editable composite strings appear
-    pid = pg->Append( new wxStringProperty(wxT("wxWidgets Traits"), wxPG_LABEL, wxT("<composed>")) );
+    pid = new wxStringProperty(wxT("wxWidgets Traits"), wxPG_LABEL, wxT("<composed>"));
     pg->SetPropertyReadOnly(pid);
 
-    pg->AppendIn(pid, new wxStringProperty(wxT("Latest Release"), wxPG_LABEL, wxT("2.8.8")) );
-    pg->AppendIn(pid, new wxBoolProperty(wxT("Win API"), wxPG_LABEL, true) );
+    //
+    // For testing purposes, combine two methods of adding children
+    //
+
+    pid->AppendChild( new wxStringProperty(wxT("Latest Release"),
+                                           wxPG_LABEL,
+                                           wxT("2.8.10")));
+    pid->AppendChild( new wxBoolProperty(wxT("Win API"),
+                                         wxPG_LABEL,
+                                         true) );
+
+    pg->Append( pid );
+
     pg->AppendIn(pid, new wxBoolProperty(wxT("QT"), wxPG_LABEL, false) );
     pg->AppendIn(pid, new wxBoolProperty(wxT("Cocoa"), wxPG_LABEL, true) );
     pg->AppendIn(pid, new wxBoolProperty(wxT("BeOS"), wxPG_LABEL, false) );
@@ -1919,7 +1973,9 @@ void FormMain::InitPanel()
     if ( m_panel )
         m_panel->Destroy();
 
-    wxWindow* panel = new wxPanel(this,-1,wxPoint(0,0),wxSize(400,400));
+    wxWindow* panel = new wxPanel(this, wxID_ANY,
+                                  wxPoint(0, 0), wxSize(400, 400),
+                                  wxTAB_TRAVERSAL);
     m_panel = panel;
 
     // Column
@@ -1930,22 +1986,22 @@ void FormMain::InitPanel()
 
 void FormMain::FinalizePanel( bool wasCreated )
 {
+    // Button for tab traversal testing
+    m_topSizer->Add( new wxButton(m_panel, wxID_ANY,
+                     wxS("Should be able to move here with Tab")),
+                     0, wxEXPAND );
+
     m_panel->SetSizer( m_topSizer );
     m_topSizer->SetSizeHints( m_panel );
 
     wxBoxSizer* panelSizer = new wxBoxSizer( wxHORIZONTAL );
     panelSizer->Add( m_panel, 1, wxEXPAND|wxFIXED_MINSIZE );
+
     SetSizer( panelSizer );
     panelSizer->SetSizeHints( this );
 
     if ( wasCreated )
-    {
-        SetSize(
-            (wxSystemSettings::GetMetric(wxSYS_SCREEN_X)/10)*4,
-            (wxSystemSettings::GetMetric(wxSYS_SCREEN_Y)/10)*8
-            );
-        Centre();
-    }
+        FinalizeFramePosition();
 }
 
 void FormMain::PopulateGrid()
@@ -1984,7 +2040,6 @@ void FormMain::CreateGrid( int style, int extraStyle )
                 //wxPG_TOOLTIPS |
                 //wxPG_HIDE_CATEGORIES |
                 //wxPG_LIMITED_EDITING |
-                wxTAB_TRAVERSAL |
                 wxPG_TOOLBAR |
                 wxPG_DESCRIPTION;
 
@@ -2051,6 +2106,8 @@ FormMain::FormMain(const wxString& title, const wxPoint& pos, const wxSize& size
                (wxMINIMIZE_BOX|wxMAXIMIZE_BOX|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCAPTION|
                 wxTAB_TRAVERSAL|wxCLOSE_BOX|wxNO_FULL_REPAINT_ON_RESIZE) )
 {
+    SetIcon(wxICON(sample));
+
     m_propGrid = NULL;
     m_panel = NULL;
 
@@ -2080,7 +2137,6 @@ FormMain::FormMain(const wxString& title, const wxPoint& pos, const wxSize& size
                 //wxPG_TOOLTIPS |
                 //wxPG_HIDE_CATEGORIES |
                 //wxPG_LIMITED_EDITING |
-                wxTAB_TRAVERSAL |
                 wxPG_TOOLBAR |
                 wxPG_DESCRIPTION,
                 // extra style
@@ -2111,7 +2167,8 @@ FormMain::FormMain(const wxString& title, const wxPoint& pos, const wxSize& size
     menuTools1->Append(ID_DELETER, wxT("Delete Random") );
     menuTools1->Append(ID_DELETEALL, wxT("Delete All") );
     menuTools1->AppendSeparator();
-    menuTools1->Append(ID_SETCOLOUR, wxT("Set Bg Colour") );
+    menuTools1->Append(ID_SETBGCOLOUR, wxT("Set Bg Colour") );
+    menuTools1->Append(ID_SETBGCOLOURRECUR, wxT("Set Bg Colour (Recursively)") );
     menuTools1->Append(ID_UNSPECIFY, wxT("Set to Unspecified") );
     menuTools1->AppendSeparator();
     m_itemEnable = menuTools1->Append(ID_ENABLE, wxT("Enable"),
@@ -2199,15 +2256,19 @@ FormMain::FormMain(const wxString& title, const wxPoint& pos, const wxSize& size
     SetStatusText(wxEmptyString);
 #endif // wxUSE_STATUSBAR
 
+    FinalizeFramePosition();
+}
 
-    //
-    // Finalize
-    //
+void FormMain::FinalizeFramePosition()
+{
+    wxSize frameSize((wxSystemSettings::GetMetric(wxSYS_SCREEN_X)/10)*4,
+                     (wxSystemSettings::GetMetric(wxSYS_SCREEN_Y)/10)*8);
+
+    if ( frameSize.x > 500 )
+        frameSize.x = 500;
+
+    SetSize(frameSize);
 
-    SetSize(
-        (wxSystemSettings::GetMetric(wxSYS_SCREEN_X)/10)*4,
-        (wxSystemSettings::GetMetric(wxSYS_SCREEN_Y)/10)*8
-        );
     Centre();
 }
 
@@ -2577,6 +2638,30 @@ void FormMain::OnHideShow( wxCommandEvent& WXUNUSED(event) )
 
 // -----------------------------------------------------------------------
 
+#include "wx/colordlg.h"
+
+void
+FormMain::OnSetBackgroundColour( wxCommandEvent& event )
+{
+    wxPropertyGrid* pg = m_pPropGridManager->GetGrid();
+    wxPGProperty* prop = pg->GetSelection();
+    if ( !prop )
+    {
+        wxMessageBox(wxT("First select a property."));
+        return;
+    }
+
+    wxColour col = ::wxGetColourFromUser(this, *wxWHITE, "Choose colour");
+
+    if ( col.IsOk() )
+    {
+        bool recursively = (event.GetId()==ID_SETBGCOLOURRECUR) ? true : false;
+        pg->SetPropertyBackgroundColour(prop, col, recursively);
+    }
+}
+
+// -----------------------------------------------------------------------
+
 void FormMain::OnInsertPage( wxCommandEvent& WXUNUSED(event) )
 {
     m_pPropGridManager->AddPage(wxT("New Page"));
@@ -2857,11 +2942,7 @@ void FormMain::OnSelectStyle( wxCommandEvent& WXUNUSED(event) )
 
     CreateGrid( style, extraStyle );
 
-    SetSize(
-        (wxSystemSettings::GetMetric(wxSYS_SCREEN_X)/10)*4,
-        (wxSystemSettings::GetMetric(wxSYS_SCREEN_Y)/10)*8
-        );
-    Centre();
+    FinalizeFramePosition();
 }
 
 // -----------------------------------------------------------------------
@@ -3008,28 +3089,7 @@ void FormMain::OnMisc ( wxCommandEvent& event )
         if ( prop )
         {
             m_pPropGridManager->SetPropertyValueUnspecified(prop);
-        }
-    }
-    else if ( id == ID_SETCOLOUR )
-    {
-        wxPGProperty* prop = m_pPropGridManager->GetSelection();
-        if ( prop )
-        {
-            wxColourData data;
-            data.SetChooseFull(true);
-            int i;
-            for ( i = 0; i < 16; i++)
-            {
-                wxColour colour(i*16, i*16, i*16);
-                data.SetCustomColour(i, colour);
-            }
-
-            wxColourDialog dialog(this, &data);
-            if ( dialog.ShowModal() == wxID_OK )
-            {
-                wxColourData retData = dialog.GetColourData();
-                m_pPropGridManager->GetGrid()->SetPropertyBackgroundColour(prop,retData.GetColour());
-            }
+            prop->RefreshEditor();
         }
     }
 }