X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/939d936402b4ac38310531ed39b4fd05afe29531..ac10ea91c9bff4a8daae3313063867647c1e1079:/include/wx/propgrid/props.h diff --git a/include/wx/propgrid/props.h b/include/wx/propgrid/props.h index 6e42c2813a..965de7dc7a 100644 --- a/include/wx/propgrid/props.h +++ b/include/wx/propgrid/props.h @@ -4,7 +4,7 @@ // Author: Jaakko Salli // Modified by: // Created: 2007-03-28 -// RCS-ID: $Id: +// RCS-ID: $Id$ // Copyright: (c) Jaakko Salli // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// @@ -22,287 +22,13 @@ class wxArrayEditorDialog; // ----------------------------------------------------------------------- -// -// Additional property class declaration helper macros -// - // // Property class implementation helper macros. // -#define WX_PG_DECLARE_BASIC_TYPE_METHODS() \ - virtual wxString GetValueAsString( int argFlags = 0 ) const; \ - virtual bool StringToValue( wxVariant& variant, \ - const wxString& text, \ - int argFlags = 0 ) const; - -#define WX_PG_DECLARE_CHOICE_METHODS() \ - virtual bool IntToValue( wxVariant& variant, \ - int number, int argFlags = 0 ) const; \ - -#define WX_PG_DECLARE_EVENT_METHODS() \ - virtual bool OnEvent( wxPropertyGrid* propgrid, \ - wxWindow* primary, wxEvent& event ); - -#define WX_PG_DECLARE_PARENTAL_METHODS() \ - virtual void ChildChanged( wxVariant& thisValue, \ - int childIndex, wxVariant& childValue ) const; \ - virtual void RefreshChildren(); - -#define WX_PG_DECLARE_CUSTOM_PAINT_METHODS() \ - virtual wxSize OnMeasureImage( int item ) const; \ - virtual void OnCustomPaint( wxDC& dc, \ - const wxRect& rect, wxPGPaintData& paintdata ); - -#define WX_PG_DECLARE_ATTRIBUTE_METHODS() \ - virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); - -#define WX_PG_DECLARE_VALIDATOR_METHODS() \ - virtual wxValidator* DoGetValidator() const; - -// Adds constructor function as well. -#define WX_PG_IMPLEMENT_PROPERTY_CLASS2(NAME,CLASSNAME,\ - UPCLASS,T,T_AS_ARG,EDITOR) \ +#define WX_PG_IMPLEMENT_PROPERTY_CLASS(NAME, UPCLASS, T, T_AS_ARG, EDITOR) \ IMPLEMENT_DYNAMIC_CLASS(NAME, UPCLASS) \ -WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(NAME,T,EDITOR) - -// A regular property -#define WX_PG_IMPLEMENT_PROPERTY_CLASS(NAME,UPNAME,T,T_AS_ARG,EDITOR) \ -WX_PG_IMPLEMENT_PROPERTY_CLASS2(NAME,NAME,UPNAME,T,T_AS_ARG,EDITOR) - -#define WX_PG_DECLARE_DERIVED_PROPERTY_CLASS(CLASSNAME) \ -DECLARE_DYNAMIC_CLASS(CLASSNAME) - -// Derived property class is one that inherits from an existing working property -// class, but assumes same value and editor type. -#define WX_PG_IMPLEMENT_DERIVED_PROPERTY_CLASS(NAME,UPNAME,T_AS_ARG) \ -IMPLEMENT_DYNAMIC_CLASS(NAME, UPNAME) - -// ----------------------------------------------------------------------- - -#define wxPG_NO_ESCAPE wxPG_PROP_NO_ESCAPE // No escape sequences -#define wxPG_ESCAPE 0 // Escape sequences - -#define WX_PG_DECLARE_STRING_PROPERTY_WITH_DECL(NAME, DECL) \ -DECL NAME : public wxLongStringProperty \ -{ \ - WX_PG_DECLARE_DERIVED_PROPERTY_CLASS(NAME) \ -public: \ - NAME( const wxString& name = wxPG_LABEL, \ - const wxString& label = wxPG_LABEL, \ - const wxString& value = wxEmptyString); \ - virtual ~NAME(); \ - virtual bool OnButtonClick( wxPropertyGrid* propgrid, wxString& value ); \ - WX_PG_DECLARE_VALIDATOR_METHODS() \ -}; - -#define WX_PG_DECLARE_STRING_PROPERTY(NAME) \ -WX_PG_DECLARE_STRING_PROPERTY_WITH_DECL(NAME, class) \ - -#define WX_PG_IMPLEMENT_STRING_PROPERTY_WITH_VALIDATOR(NAME, FLAGS) \ -WX_PG_IMPLEMENT_DERIVED_PROPERTY_CLASS(NAME,wxLongStringProperty,\ - const wxString&) \ -NAME::NAME( const wxString& name, \ - const wxString& label, \ - const wxString& value ) \ - : wxLongStringProperty(name,label,value) \ -{ \ - m_flags |= FLAGS; \ -} \ -NAME::~NAME() { } - -#define WX_PG_IMPLEMENT_STRING_PROPERTY(NAME, FLAGS) \ -WX_PG_IMPLEMENT_STRING_PROPERTY_WITH_VALIDATOR(NAME,FLAGS) \ -wxValidator* NAME::DoGetValidator () const \ -{ return (wxValidator*) NULL; } - -// ----------------------------------------------------------------------- - -#define WX_PG_DECLARE_CUSTOM_FLAGS_PROPERTY_WITH_DECL(CLASSNAME,DECL) \ -DECL CLASSNAME : public wxFlagsProperty \ -{ \ - WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \ -public: \ - CLASSNAME( const wxString& label = wxPG_LABEL, \ - const wxString& name = wxPG_LABEL, \ - long value = -1 ); \ - virtual ~CLASSNAME(); \ -}; - -#define WX_PG_DECLARE_CUSTOM_FLAGS_PROPERTY(CLASSNAME) \ -WX_PG_DECLARE_CUSTOM_FLAGS_PROPERTY_WITH_DECL(CLASSNAME, class) - -// This will create interface for wxFlagsProperty derived class -// named CLASSNAME. -#define WX_PG_IMPLEMENT_CUSTOM_FLAGS_PROPERTY(CLASSNAME,LABELS,VALUES,DEFVAL) \ -WX_PG_IMPLEMENT_PROPERTY_CLASS(CLASSNAME,wxFlagsProperty,long_##CLASSNAME,\ - long,TextCtrl) \ -CLASSNAME::CLASSNAME( const wxString& label, \ - const wxString& name, \ - long value ) \ - : wxFlagsProperty(label,name,LABELS,VALUES,value!=-1?value:DEFVAL) \ -{ \ - m_flags |= wxPG_PROP_STATIC_CHOICES; \ -} \ -CLASSNAME::~CLASSNAME() { } - - -// ----------------------------------------------------------------------- - -#define WX_PG_DECLARE_CUSTOM_ENUM_PROPERTY_WITH_DECL(CLASSNAME, DECL) \ -class CLASSNAME : public wxEnumProperty \ -{ \ - WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \ -public: \ - CLASSNAME( const wxString& label = wxPG_LABEL, \ - const wxString& name = wxPG_LABEL, \ - int value = -1 ); \ - virtual ~CLASSNAME(); \ -}; - -#define WX_PG_DECLARE_CUSTOM_ENUM_PROPERTY(CLASSNAME) \ -WX_PG_DECLARE_CUSTOM_ENUM_PROPERTY_WITH_DECL(CLASSNAME, class) - -#define WX_PG_IMPLEMENT_CUSTOM_ENUM_PROPERTY(CLASSNAME,LABELS,VALUES,DEFVAL) \ -WX_PG_IMPLEMENT_PROPERTY_CLASS(CLASSNAME, wxEnumProperty, long_##CLASSNAME, \ - int, Choice) \ -CLASSNAME::CLASSNAME( const wxString& label, const wxString& name, int value ) \ - : wxEnumProperty(label,name,LABELS,VALUES,value!=-1?value:DEFVAL) \ -{ \ - m_flags |= wxPG_PROP_STATIC_CHOICES; \ -} \ -CLASSNAME::~CLASSNAME() { } - - -// ----------------------------------------------------------------------- - -#define WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY_WITH_DECL(CLASSNAME, DECL) \ -DECL CLASSNAME : public wxSystemColourProperty \ -{ \ - DECLARE_DYNAMIC_CLASS(CLASSNAME) \ -public: \ - CLASSNAME( const wxString& label = wxPG_LABEL, \ - const wxString& name = wxPG_LABEL, \ - const wxColourPropertyValue& value = wxColourPropertyValue() ); \ - virtual ~CLASSNAME(); \ - virtual wxColour GetColour( int index ) const; \ -}; - -#define WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY(CLASSNAME) \ -WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY_WITH_DECL(CLASSNAME, class) - -#define WX_PG_IMPLEMENT_CUSTOM_COLOUR_PROPERTY(CLASSNAME,\ - LABELS,VALUES,COLOURS) \ -static wxPGChoices gs_##CLASSNAME##_choicesCache; \ -WX_PG_IMPLEMENT_DERIVED_PROPERTY_CLASS(CLASSNAME, wxSystemColourProperty, \ - const wxColourPropertyValue&) \ -CLASSNAME::CLASSNAME( const wxString& label, const wxString& name, \ - const wxColourPropertyValue& value ) \ - : wxSystemColourProperty(label, name, LABELS, VALUES, \ - &gs_##CLASSNAME##_choicesCache, value ) \ -{ \ - m_flags |= wxPG_PROP_TRANSLATE_CUSTOM; \ -} \ -CLASSNAME::~CLASSNAME () { } \ -wxColour CLASSNAME::GetColour ( int index ) const \ -{ \ - if ( !m_choices.HasValue(index) ) \ - { \ - wxASSERT( index < (int)m_choices.GetCount() ); \ - return COLOURS[index]; \ - } \ - return COLOURS[m_choices.GetValue(index)]; \ -} - -// ----------------------------------------------------------------------- - -#define WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR_WITH_DECL(CLASSNAME,\ - DECL) \ -DECL CLASSNAME : public wxSystemColourProperty \ -{ \ - WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \ -public: \ - CLASSNAME( const wxString& label = wxPG_LABEL, \ - const wxString& name = wxPG_LABEL, \ - const wxColour& value = wxColour() ); \ - virtual ~CLASSNAME(); \ - virtual wxString GetValueAsString( int argFlags ) const; \ - virtual wxColour GetColour( int index ) const; \ - virtual wxVariant DoTranslateVal( wxColourPropertyValue& v ) const; \ - void Init( wxColour colour ); \ -}; - -#define WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR(CLASSNAME) \ -WX_PG_DECLARE_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR_WITH_DECL(CLASSNAME, class) - -#define WX_PG_IMPLEMENT_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR2(CLASSNAME, \ - LABELS, \ - VALUES, \ - COLOURS, \ - EDITOR) \ -static wxPGChoices gs_##CLASSNAME##_choicesCache; \ -WX_PG_IMPLEMENT_PROPERTY_CLASS(CLASSNAME, wxSystemColourProperty, \ - wxColour, const wxColour&,EDITOR) \ -CLASSNAME::CLASSNAME( const wxString& label, \ - const wxString& name, \ - const wxColour& value ) \ - : wxSystemColourProperty(label, name, LABELS, VALUES, \ - &gs_##CLASSNAME##_choicesCache, value ) \ -{ \ - if ( &value ) \ - Init( value ); \ - else \ - Init( *wxWHITE ); \ - m_flags |= wxPG_PROP_TRANSLATE_CUSTOM; \ -} \ -CLASSNAME::~CLASSNAME() { } \ -void CLASSNAME::Init( wxColour colour ) \ -{ \ - if ( !colour.Ok() ) \ - colour = *wxWHITE; \ - wxVariant variant; \ - variant << colour; \ - m_value = variant; \ - int ind = ColToInd(colour); \ - if ( ind < 0 ) \ - ind = m_choices.GetCount() - 1; \ - SetIndex( ind ); \ -} \ -wxString CLASSNAME::GetValueAsString( int argFlags ) const \ -{ \ - const wxPGEditor* editor = GetEditorClass(); \ - if ( editor != wxPG_EDITOR(Choice) && \ - editor != wxPG_EDITOR(ChoiceAndButton) && \ - editor != wxPG_EDITOR(ComboBox) ) \ - argFlags |= wxPG_PROPERTY_SPECIFIC; \ - return wxSystemColourProperty::GetValueAsString(argFlags); \ -} \ -wxColour CLASSNAME::GetColour( int index ) const \ -{ \ - if ( !m_choices.HasValue(index) ) \ - { \ - wxASSERT( index < (int)GetItemCount() ); \ - return COLOURS[index]; \ - } \ - return COLOURS[m_choices.GetValue(index)]; \ -} \ -wxVariant CLASSNAME::DoTranslateVal( wxColourPropertyValue& v ) const \ -{ \ - wxVariant variant; \ - variant << v.m_colour; \ - return variant; \ -} - - -#define WX_PG_IMPLEMENT_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR(CLASSNAME, \ - LABELS, \ - VALUES, \ - COLOURS) \ -WX_PG_IMPLEMENT_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR2(CLASSNAME, \ - LABELS, \ - VALUES, \ - COLOURS, \ - Choice) +WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(NAME, T, EDITOR) // ----------------------------------------------------------------------- @@ -315,13 +41,15 @@ WX_PG_IMPLEMENT_CUSTOM_COLOUR_PROPERTY_USES_WXCOLOUR2(CLASSNAME, \ // Common function exit #define WX_PG_DOGETVALIDATOR_EXIT(VALIDATOR) \ s_ptr = VALIDATOR; \ - wxPGGlobalVars->m_arrValidators.Add( (void*) VALIDATOR ); \ + wxPGGlobalVars->m_arrValidators.push_back( VALIDATOR ); \ return VALIDATOR; // ----------------------------------------------------------------------- #ifndef SWIG +#include "wx/textctrl.h" + /** @class wxPGInDialogValidator @ingroup classes Creates and manages a temporary wxTextCtrl for validation purposes. @@ -378,8 +106,12 @@ public: const wxString& value = wxEmptyString ); virtual ~wxStringProperty(); - WX_PG_DECLARE_BASIC_TYPE_METHODS() - WX_PG_DECLARE_ATTRIBUTE_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; + + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); /** This is updated so "" special value can be handled. */ @@ -464,7 +196,10 @@ public: wxIntProperty( const wxString& label, const wxString& name, const wxLongLong& value ); - WX_PG_DECLARE_BASIC_TYPE_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const; virtual bool IntToValue( wxVariant& variant, @@ -515,8 +250,11 @@ public: wxUIntProperty( const wxString& label, const wxString& name, const wxULongLong& value ); - WX_PG_DECLARE_BASIC_TYPE_METHODS() - WX_PG_DECLARE_ATTRIBUTE_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const; virtual bool IntToValue( wxVariant& variant, @@ -549,8 +287,11 @@ public: double value = 0.0 ); virtual ~wxFloatProperty(); - WX_PG_DECLARE_BASIC_TYPE_METHODS() - WX_PG_DECLARE_ATTRIBUTE_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const; @@ -589,9 +330,13 @@ public: bool value = false ); virtual ~wxBoolProperty(); - WX_PG_DECLARE_BASIC_TYPE_METHODS() - WX_PG_DECLARE_CHOICE_METHODS() - WX_PG_DECLARE_ATTRIBUTE_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; + virtual bool IntToValue( wxVariant& variant, + int number, int argFlags = 0 ) const; + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); }; #endif // !SWIG @@ -615,7 +360,7 @@ public: const wxString& name = wxPG_LABEL ); virtual void OnSetValue(); - virtual wxString GetValueAsString( int argFlags ) const; + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const; @@ -808,7 +553,7 @@ public: virtual ~wxFlagsProperty (); virtual void OnSetValue(); - virtual wxString GetValueAsString( int argFlags ) const; + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; virtual bool StringToValue( wxVariant& variant, const wxString& text, int flags ) const; @@ -886,23 +631,26 @@ public: virtual ~wxFileProperty (); virtual void OnSetValue(); - virtual wxString GetValueAsString( int argFlags ) const; + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const; virtual wxPGEditorDialogAdapter* GetEditorDialog() const; - - WX_PG_DECLARE_ATTRIBUTE_METHODS() + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); static wxValidator* GetClassValidator(); virtual wxValidator* DoGetValidator() const; + /** + Returns filename to file represented by current value. + */ + wxFileName GetFileName() const; + protected: wxString m_wildcard; wxString m_basePath; // If set, then show path relative to it wxString m_initialPath; // If set, start the file dialog here wxString m_dlgTitle; // If set, used as title for file dialog - wxFileName m_filename; // used as primary storage int m_indFilter; // index to the selected filter }; @@ -938,12 +686,12 @@ public: const wxString& value = wxEmptyString ); virtual ~wxLongStringProperty(); - virtual wxString GetValueAsString( int argFlags = 0 ) const; + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const; - - WX_PG_DECLARE_EVENT_METHODS() + virtual bool OnEvent( wxPropertyGrid* propgrid, + wxWindow* primary, wxEvent& event ); // Shows string editor dialog. Value to be edited should be read from // value, and if dialog is not cancelled, it should be stored back and true @@ -981,8 +729,8 @@ public: const wxString& value = wxEmptyString ); virtual ~wxDirProperty(); - WX_PG_DECLARE_ATTRIBUTE_METHODS() - WX_PG_DECLARE_VALIDATOR_METHODS() + virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); + virtual wxValidator* DoGetValidator() const; virtual bool OnButtonClick ( wxPropertyGrid* propGrid, wxString& value ); @@ -1017,8 +765,12 @@ public: virtual ~wxArrayStringProperty(); virtual void OnSetValue(); - WX_PG_DECLARE_BASIC_TYPE_METHODS() - WX_PG_DECLARE_EVENT_METHODS() + virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const; + virtual bool StringToValue( wxVariant& variant, + const wxString& text, + int argFlags = 0 ) const; + virtual bool OnEvent( wxPropertyGrid* propgrid, + wxWindow* primary, wxEvent& event ); virtual void GenerateValueAsString(); @@ -1059,7 +811,7 @@ public: \ virtual bool OnEvent( wxPropertyGrid* propgrid, \ wxWindow* primary, wxEvent& event ); \ virtual bool OnCustomStringEdit( wxWindow* parent, wxString& value ); \ - WX_PG_DECLARE_VALIDATOR_METHODS() \ + virtual wxValidator* DoGetValidator() const; \ }; #define WX_PG_DECLARE_ARRAYSTRING_PROPERTY_WITH_VALIDATOR(PROPNAM) \ @@ -1129,8 +881,8 @@ wxValidator* PROPNAME::DoGetValidator () const \ // wxArrayEditorDialog // ----------------------------------------------------------------------- -#include "wx/textctrl.h" #include "wx/button.h" +#include "wx/dialog.h" #include "wx/listbox.h" #define wxAEDIALOG_STYLE \