WX_EVENT_PROPERTY instead of WX_DELEGATE
[wxWidgets.git] / include / wx / xti.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/xti.hG
3 // Purpose: runtime metadata information (extended class info)
4 // Author: Stefan Csomor
5 // Modified by:
6 // Created: 27/07/03
7 // RCS-ID: $Id$
8 // Copyright: (c) 1997 Julian Smart
9 // (c) 2003 Stefan Csomor
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_XTIH__
14 #define _WX_XTIH__
15
16 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
17 #pragma interface "xti.h"
18 #endif
19
20 // We want to support properties, event sources and events sinks through
21 // explicit declarations, using templates and specialization to make the
22 // effort as painless as possible.
23 //
24 // This means we have the following domains :
25 //
26 // - Type Information for categorizing built in types as well as custom types
27 // this includes information about enums, their values and names
28 // - Type safe value storage : a kind of wxVariant, called right now wxxVariant
29 // which will be merged with wxVariant
30 // - Property Information and Property Accessors providing access to a class'
31 // values and exposed event delegates
32 // - Information about event handlers
33 // - extended Class Information for accessing all these
34
35 // ----------------------------------------------------------------------------
36 // headers
37 // ----------------------------------------------------------------------------
38
39 #include "wx/defs.h"
40 #include "wx/memory.h"
41 #include "wx/flags.h"
42 #include "wx/string.h"
43 #include "wx/arrstr.h"
44 #include "wx/hashmap.h"
45
46 #include <typeinfo>
47
48 // we will move this later to defs.h
49
50 #if !wxCHECK_GCC_VERSION( 3 , 4 )
51 # define wxUSE_MEMBER_TEMPLATES 0
52 #endif
53
54 #ifdef _MSC_VER
55 # if _MSC_VER <= 1200
56 # define wxUSE_MEMBER_TEMPLATES 0
57 # endif
58 #endif
59
60 #ifndef wxUSE_MEMBER_TEMPLATES
61 #define wxUSE_MEMBER_TEMPLATES 1
62 #endif
63
64 #if wxUSE_MEMBER_TEMPLATES
65 #define WX_TEMPLATED_MEMBER_CALL( method , type ) method<type>()
66 #define WX_TEMPLATED_MEMBER_FIX( type )
67 #else
68 #define WX_TEMPLATED_MEMBER_CALL( method , type ) method((type*)NULL)
69 #define WX_TEMPLATED_MEMBER_FIX( type ) type* =NULL
70 #endif
71
72 class WXDLLIMPEXP_BASE wxObject;
73 class WXDLLIMPEXP_BASE wxClassInfo;
74 class WXDLLIMPEXP_BASE wxDynamicClassInfo;
75 class WXDLLIMPEXP_BASE wxHashTable;
76 class WXDLLIMPEXP_BASE wxObjectRefData;
77 class WXDLLIMPEXP_BASE wxEvent;
78
79 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
80
81 // ----------------------------------------------------------------------------
82 // Enum Support
83 //
84 // In the header files there would no change from pure c++ code, in the
85 // implementation, an enum would have
86 // to be enumerated eg :
87 //
88 // WX_BEGIN_ENUM( wxFlavor )
89 // WX_ENUM_MEMBER( Vanilla )
90 // WX_ENUM_MEMBER( Chocolate )
91 // WX_ENUM_MEMBER( Strawberry )
92 // WX_END_ENUM( wxFlavor )
93 // ----------------------------------------------------------------------------
94
95 struct WXDLLIMPEXP_BASE wxEnumMemberData
96 {
97 const wxChar* m_name;
98 int m_value;
99 };
100
101 class WXDLLIMPEXP_BASE wxEnumData
102 {
103 public :
104 wxEnumData( wxEnumMemberData* data ) ;
105
106 // returns true if the member has been found and sets the int value
107 // pointed to accordingly (if ptr != null )
108 // if not found returns false, value left unchanged
109 bool HasEnumMemberValue( const wxChar *name , int *value = NULL ) const ;
110
111 // returns the value of the member, if not found in debug mode an
112 // assert is issued, in release 0 is returned
113 int GetEnumMemberValue(const wxChar *name ) const ;
114
115 // returns the name of the enum member having the passed in value
116 // returns an emtpy string if not found
117 const wxChar *GetEnumMemberName(int value) const ;
118
119 // returns the number of members in this enum
120 int GetEnumCount() const { return m_count ; }
121
122 // returns the value of the nth member
123 int GetEnumMemberValueByIndex( int n ) const ;
124
125 // returns the value of the nth member
126 const wxChar *GetEnumMemberNameByIndex( int n ) const ;
127 private :
128 wxEnumMemberData *m_members;
129 int m_count ;
130 };
131
132 #define WX_BEGIN_ENUM( e ) \
133 wxEnumMemberData s_enumDataMembers##e[] = {
134
135 #define WX_ENUM_MEMBER( v ) { wxT(#v), v } ,
136
137 #define WX_END_ENUM( e ) { NULL , 0 } } ; \
138 wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
139 wxEnumData *wxGetEnumData(e) { return &s_enumData##e ; } \
140 template<> void wxStringReadValue(const wxString& s , e &data ) \
141 { \
142 data = (e) s_enumData##e.GetEnumMemberValue(s) ; \
143 } \
144 template<> void wxStringWriteValue(wxString &s , const e &data ) \
145 { \
146 s = s_enumData##e.GetEnumMemberName((int)data) ; \
147 } \
148 void FromLong##e( long data , wxxVariant& result ) { result = wxxVariant((e)data) ;} \
149 void ToLong##e( const wxxVariant& data , long &result ) { result = (long) data.Get<e>() ;} \
150 wxEnumTypeInfo s_typeInfo##e(wxT_ENUM , &s_enumData##e , &wxToStringConverter<e> , &wxFromStringConverter<e> , &ToLong##e , &FromLong##e , typeid(e).name() ) ;
151
152 // ----------------------------------------------------------------------------
153 // Set Support
154 //
155 // in the header :
156 //
157 // enum wxFlavor
158 // {
159 // Vanilla,
160 // Chocolate,
161 // Strawberry,
162 // };
163 //
164 // typedef wxBitset<wxFlavor> wxCoupe ;
165 //
166 // in the implementation file :
167 //
168 // WX_BEGIN_ENUM( wxFlavor )
169 // WX_ENUM_MEMBER( Vanilla )
170 // WX_ENUM_MEMBER( Chocolate )
171 // WX_ENUM_MEMBER( Strawberry )
172 // WX_END_ENUM( wxFlavor )
173 //
174 // WX_IMPLEMENT_SET_STREAMING( wxCoupe , wxFlavor )
175 //
176 // implementation note : no partial specialization for streaming, but a delegation to a
177 // different class
178 //
179 // ----------------------------------------------------------------------------
180
181 // in order to remove dependancy on string tokenizer
182 void wxSetStringToArray( const wxString &s , wxArrayString &array ) ;
183
184 template<typename e>
185 void wxSetFromString(const wxString &s , wxBitset<e> &data )
186 {
187 wxEnumData* edata = wxGetEnumData((e) 0) ;
188 data.reset() ;
189
190 wxArrayString array ;
191 wxSetStringToArray( s , array ) ;
192 wxString flag;
193 for ( int i = 0 ; i < array.Count() ; ++i )
194 {
195 flag = array[i] ;
196 int ivalue ;
197 if ( edata->HasEnumMemberValue( flag , &ivalue ) )
198 {
199 data.set( (e) ivalue ) ;
200 }
201 }
202 }
203
204 template<typename e>
205 void wxSetToString( wxString &s , const wxBitset<e> &data )
206 {
207 wxEnumData* edata = wxGetEnumData((e) 0) ;
208 int count = edata->GetEnumCount() ;
209 int i ;
210 s.Clear() ;
211 for ( i = 0 ; i < count ; i++ )
212 {
213 e value = (e) edata->GetEnumMemberValueByIndex(i) ;
214 if ( data.test( value ) )
215 {
216 // this could also be done by the templated calls
217 if ( !s.IsEmpty() )
218 s +=wxT("|") ;
219 s += edata->GetEnumMemberNameByIndex(i) ;
220 }
221 }
222 }
223
224 #define WX_IMPLEMENT_SET_STREAMING(SetName,e) \
225 template<> void wxStringReadValue(const wxString &s , wxBitset<e> &data ) \
226 { \
227 wxSetFromString( s , data ) ; \
228 } \
229 template<> void wxStringWriteValue( wxString &s , const wxBitset<e> &data ) \
230 { \
231 wxSetToString( s , data ) ; \
232 } \
233 void FromLong##SetName( long data , wxxVariant& result ) { result = wxxVariant(SetName((unsigned long)data)) ;} \
234 void ToLong##SetName( const wxxVariant& data , long &result ) { result = (long) data.Get<SetName>().to_ulong() ;} \
235 wxEnumTypeInfo s_typeInfo##SetName(wxT_SET , &s_enumData##e , &wxToStringConverter<SetName> , &wxFromStringConverter<SetName> , &ToLong##SetName , &FromLong##SetName, typeid(SetName).name() ) ; \
236 }
237
238 template<typename e>
239 void wxFlagsFromString(const wxString &s , e &data )
240 {
241 wxEnumData* edata = wxGetEnumData((e*) 0) ;
242 data.m_data = 0 ;
243
244 wxArrayString array ;
245 wxSetStringToArray( s , array ) ;
246 wxString flag;
247 for ( size_t i = 0 ; i < array.Count() ; ++i )
248 {
249 flag = array[i] ;
250 int ivalue ;
251 if ( edata->HasEnumMemberValue( flag , &ivalue ) )
252 {
253 data.m_data |= ivalue ;
254 }
255 }
256 }
257
258 template<typename e>
259 void wxFlagsToString( wxString &s , const e& data )
260 {
261 wxEnumData* edata = wxGetEnumData((e*) 0) ;
262 int count = edata->GetEnumCount() ;
263 int i ;
264 s.Clear() ;
265 long dataValue = data.m_data ;
266 for ( i = 0 ; i < count ; i++ )
267 {
268 int value = edata->GetEnumMemberValueByIndex(i) ;
269 // make this to allow for multi-bit constants to work
270 if ( value && ( dataValue & value ) == value )
271 {
272 // clear the flags we just set
273 dataValue &= ~value ;
274 // this could also be done by the templated calls
275 if ( !s.IsEmpty() )
276 s +=wxT("|") ;
277 s += edata->GetEnumMemberNameByIndex(i) ;
278 }
279 }
280 }
281
282 #define WX_BEGIN_FLAGS( e ) \
283 wxEnumMemberData s_enumDataMembers##e[] = {
284
285 #define WX_FLAGS_MEMBER( v ) { wxT(#v), v } ,
286
287 #define WX_END_FLAGS( e ) { NULL , 0 } } ; \
288 wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
289 wxEnumData *wxGetEnumData(e*) { return &s_enumData##e ; } \
290 template<> void wxStringReadValue(const wxString &s , e &data ) \
291 { \
292 wxFlagsFromString<e>( s , data ) ; \
293 } \
294 template<> void wxStringWriteValue( wxString &s , const e& data ) \
295 { \
296 wxFlagsToString<e>( s , data ) ; \
297 } \
298 void FromLong##e( long data , wxxVariant& result ) { result = wxxVariant(e(data)) ;} \
299 void ToLong##e( const wxxVariant& data , long &result ) { result = (long) data.Get<e>().m_data ;} \
300 wxEnumTypeInfo s_typeInfo##e(wxT_SET , &s_enumData##e , &wxToStringConverter<e> , &wxFromStringConverter<e> , &ToLong##e , &FromLong##e, typeid(e).name() ) ;
301 // ----------------------------------------------------------------------------
302 // Type Information
303 // ----------------------------------------------------------------------------
304 //
305 //
306 // All data exposed by the RTTI is characterized using the following classes.
307 // The first characterization is done by wxTypeKind. All enums up to and including
308 // wxT_CUSTOM represent so called simple types. These cannot be divided any further.
309 // They can be converted to and from wxStrings, that's all.
310
311
312 enum wxTypeKind
313 {
314 wxT_VOID = 0, // unknown type
315 wxT_BOOL,
316 wxT_CHAR,
317 wxT_UCHAR,
318 wxT_INT,
319 wxT_UINT,
320 wxT_LONG,
321 wxT_ULONG,
322 wxT_FLOAT,
323 wxT_DOUBLE,
324 wxT_STRING, // must be wxString
325 wxT_SET, // must be wxBitset<> template
326 wxT_ENUM,
327 wxT_CUSTOM, // user defined type (e.g. wxPoint)
328
329 wxT_LAST_SIMPLE_TYPE_KIND = wxT_CUSTOM ,
330
331 wxT_OBJECT_PTR, // object reference
332 wxT_OBJECT , // embedded object
333 wxT_COLLECTION , // collection
334
335 wxT_DELEGATE , // for connecting against an event source
336
337 wxT_LAST_TYPE_KIND = wxT_DELEGATE // sentinel for bad data, asserts, debugging
338 };
339
340 class WXDLLIMPEXP_BASE wxxVariant ;
341 class WXDLLIMPEXP_BASE wxTypeInfo ;
342
343 WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxTypeInfo* , wxTypeInfoMap , class WXDLLIMPEXP_BASE ) ;
344
345 class WXDLLIMPEXP_BASE wxTypeInfo
346 {
347 public :
348 typedef void (*converterToString_t)( const wxxVariant& data , wxString &result ) ;
349 typedef void (*converterFromString_t)( const wxString& data , wxxVariant &result ) ;
350
351 wxTypeInfo(wxTypeKind kind,
352 converterToString_t to = NULL, converterFromString_t from = NULL,
353 const wxString &name = wxEmptyString):
354 m_toString(to), m_fromString(from), m_kind(kind), m_name(name)
355 {
356 Register();
357 }
358 #if wxUSE_UNICODE
359 wxTypeInfo(wxTypeKind kind,
360 converterToString_t to = NULL, converterFromString_t from = NULL,
361 const char *name = ""):
362 m_toString(to), m_fromString(from), m_kind(kind), m_name(wxString::FromAscii(name))
363 {
364 Register();
365 }
366 #endif
367
368 virtual ~wxTypeInfo()
369 {
370 Unregister() ;
371 }
372
373 // return the kind of this type (wxT_... constants)
374 wxTypeKind GetKind() const { return m_kind ; }
375
376 // returns the unique name of this type
377 const wxString& GetTypeName() const { return m_name ; }
378
379 // is this type a delegate type
380 bool IsDelegateType() const { return m_kind == wxT_DELEGATE ; }
381
382 // is this type a custom type
383 bool IsCustomType() const { return m_kind == wxT_CUSTOM ; }
384
385 // is this type an object type
386 bool IsObjectType() const { return m_kind == wxT_OBJECT || m_kind == wxT_OBJECT_PTR ; }
387
388 // can the content of this type be converted to and from strings ?
389 bool HasStringConverters() const { return m_toString != NULL && m_fromString != NULL ; }
390
391 // convert a wxxVariant holding data of this type into a string
392 void ConvertToString( const wxxVariant& data , wxString &result ) const
393
394 { wxASSERT_MSG( m_toString , wxT("String conversions not supported") ) ; (*m_toString)( data , result ) ; }
395
396 // convert a string into a wxxVariant holding the corresponding data in this type
397 void ConvertFromString( const wxString& data , wxxVariant &result ) const
398 { wxASSERT_MSG( m_fromString , wxT("String conversions not supported") ) ; (*m_fromString)( data , result ) ; }
399
400 #if wxUSE_UNICODE
401 static wxTypeInfo *FindType(const char *typeName) { return FindType( wxString::FromAscii(typeName) ) ; }
402 #endif
403 static wxTypeInfo *FindType(const wxChar *typeName);
404
405 private :
406
407 void Register();
408 void Unregister();
409
410 converterToString_t m_toString ;
411 converterFromString_t m_fromString ;
412
413 static wxTypeInfoMap* sm_typeTable ;
414
415 wxTypeKind m_kind;
416 wxString m_name;
417 };
418
419 class WXDLLIMPEXP_BASE wxBuiltInTypeInfo : public wxTypeInfo
420 {
421 public :
422 wxBuiltInTypeInfo( wxTypeKind kind , converterToString_t to = NULL , converterFromString_t from = NULL , const wxString &name = wxEmptyString ) :
423 wxTypeInfo( kind , to , from , name )
424 { wxASSERT_MSG( GetKind() < wxT_SET , wxT("Illegal Kind for Base Type") ) ; }
425 #if wxUSE_UNICODE
426 wxBuiltInTypeInfo( wxTypeKind kind , converterToString_t to , converterFromString_t from , const char *name ) :
427 wxTypeInfo( kind , to , from , name )
428 { wxASSERT_MSG( GetKind() < wxT_SET , wxT("Illegal Kind for Base Type") ) ; }
429 #endif
430 } ;
431
432 class WXDLLIMPEXP_BASE wxCustomTypeInfo : public wxTypeInfo
433 {
434 public :
435 wxCustomTypeInfo( const wxString &name , converterToString_t to , converterFromString_t from ) :
436 wxTypeInfo( wxT_CUSTOM , to , from , name )
437 {}
438 #if wxUSE_UNICODE
439 wxCustomTypeInfo( const char *name , converterToString_t to , converterFromString_t from ) :
440 wxTypeInfo( wxT_CUSTOM , to , from , name )
441 {}
442 #endif
443 } ;
444
445 class WXDLLIMPEXP_BASE wxEnumTypeInfo : public wxTypeInfo
446 {
447 public :
448 typedef void (*converterToLong_t)( const wxxVariant& data , long &result ) ;
449 typedef void (*converterFromLong_t)( long data , wxxVariant &result ) ;
450
451 wxEnumTypeInfo( wxTypeKind kind , wxEnumData* enumInfo , converterToString_t to , converterFromString_t from ,
452 converterToLong_t toLong , converterFromLong_t fromLong , const wxString &name ) :
453 wxTypeInfo( kind , to , from , name ) , m_toLong( toLong ) , m_fromLong( fromLong )
454 { wxASSERT_MSG( kind == wxT_ENUM || kind == wxT_SET , wxT("Illegal Kind for Enum Type")) ; m_enumInfo = enumInfo ;}
455
456 #if wxUSE_UNICODE
457 wxEnumTypeInfo( wxTypeKind kind , wxEnumData* enumInfo , converterToString_t to , converterFromString_t from ,
458 converterToLong_t toLong , converterFromLong_t fromLong , const char * name ) :
459 wxTypeInfo( kind , to , from , name ) , m_toLong( toLong ) , m_fromLong( fromLong )
460 { wxASSERT_MSG( kind == wxT_ENUM || kind == wxT_SET , wxT("Illegal Kind for Enum Type")) ; m_enumInfo = enumInfo ;}
461 #endif
462 const wxEnumData* GetEnumData() const { return m_enumInfo ; }
463
464 // convert a wxxVariant holding data of this type into a long
465 void ConvertToLong( const wxxVariant& data , long &result ) const
466
467 { wxASSERT_MSG( m_toLong , wxT("Long conversions not supported") ) ; (*m_toLong)( data , result ) ; }
468
469 // convert a long into a wxxVariant holding the corresponding data in this type
470 void ConvertFromLong( long data , wxxVariant &result ) const
471 { wxASSERT_MSG( m_fromLong , wxT("Long conversions not supported") ) ; (*m_fromLong)( data , result ) ; }
472
473 private :
474 converterToLong_t m_toLong ;
475 converterFromLong_t m_fromLong ;
476
477 wxEnumData *m_enumInfo; // Kind == wxT_ENUM or Kind == wxT_SET
478 } ;
479
480 class WXDLLIMPEXP_BASE wxClassTypeInfo : public wxTypeInfo
481 {
482 public :
483 wxClassTypeInfo( wxTypeKind kind , wxClassInfo* classInfo , converterToString_t to = NULL , converterFromString_t from = NULL , const wxString &name = wxEmptyString) ;
484 #if wxUSE_UNICODE
485 wxClassTypeInfo( wxTypeKind kind , wxClassInfo* classInfo , converterToString_t to , converterFromString_t from , const char *name ) ;
486 #endif
487 const wxClassInfo *GetClassInfo() const { return m_classInfo ; }
488 private :
489 wxClassInfo *m_classInfo; // Kind == wxT_OBJECT - could be NULL
490 } ;
491
492 class WXDLLIMPEXP_BASE wxCollectionTypeInfo : public wxTypeInfo
493 {
494 public :
495 wxCollectionTypeInfo( const wxString &elementName , converterToString_t to , converterFromString_t from , const wxString &name) :
496 wxTypeInfo( wxT_COLLECTION , to , from , name )
497 { m_elementTypeName = elementName ; m_elementType = NULL ;}
498 #if wxUSE_UNICODE
499 wxCollectionTypeInfo( const char *elementName , converterToString_t to , converterFromString_t from , const char *name ) :
500 wxTypeInfo( wxT_COLLECTION , to , from , name )
501 { m_elementTypeName = wxString::FromAscii( elementName ) ; m_elementType = NULL ;}
502 #endif
503 const wxTypeInfo* GetElementType() const
504 {
505 if ( m_elementType == NULL )
506 m_elementType = wxTypeInfo::FindType( m_elementTypeName ) ;
507 return m_elementType ; }
508 private :
509 mutable wxTypeInfo * m_elementType ;
510 wxString m_elementTypeName ;
511 } ;
512
513 // a delegate is an exposed event source
514
515 class WXDLLIMPEXP_BASE wxDelegateTypeInfo : public wxTypeInfo
516 {
517 public :
518 wxDelegateTypeInfo( int eventType , wxClassInfo* eventClass , converterToString_t to = NULL , converterFromString_t from = NULL ) ;
519 wxDelegateTypeInfo( int eventType , int lastEventType, wxClassInfo* eventClass , converterToString_t to = NULL , converterFromString_t from = NULL ) ;
520 int GetEventType() const { return m_eventType ; }
521 int GetLastEventType() const { return m_lastEventType ; }
522 const wxClassInfo* GetEventClass() const { return m_eventClass ; }
523 private :
524 const wxClassInfo *m_eventClass; // (extended will merge into classinfo)
525 int m_eventType ;
526 int m_lastEventType ;
527 } ;
528
529 template<typename T> const wxTypeInfo* wxGetTypeInfo( T * ) { return wxTypeInfo::FindType(typeid(T).name()) ; }
530
531 // this macro is for usage with custom, non-object derived classes and structs, wxPoint is such a custom type
532
533 #define WX_CUSTOM_TYPE_INFO( e , toString , fromString ) \
534 wxCustomTypeInfo s_typeInfo##e(typeid(e).name() , &toString , &fromString) ;
535
536 #define WX_COLLECTION_TYPE_INFO( element , collection ) \
537 wxCollectionTypeInfo s_typeInfo##collection( typeid(element).name() , NULL , NULL , typeid(collection).name() ) ;
538
539 // sometimes a compiler invents specializations that are nowhere called, use this macro to satisfy the refs
540
541 #define WX_ILLEGAL_TYPE_SPECIALIZATION( a )
542 /*
543 template<> const wxTypeInfo* wxGetTypeInfo( a * ) { assert(0) ; \
544 static wxBuiltInTypeInfo s_typeInfo( wxT_VOID ) ; return &s_typeInfo ; } \
545 template<> void wxStringReadValue(const wxString & , a & ) { assert(0) ; }\
546 template<> void wxStringWriteValue(wxString & , a const & ) { assert(0) ; }
547 */
548
549 // ----------------------------------------------------------------------------
550 // wxxVariant as typesafe data holder
551 // ----------------------------------------------------------------------------
552
553 class WXDLLIMPEXP_BASE wxxVariantData
554 {
555 public:
556 virtual ~wxxVariantData() {}
557
558 // return a heap allocated duplicate
559 virtual wxxVariantData* Clone() const = 0 ;
560
561 // returns the type info of the contentc
562 virtual const wxTypeInfo* GetTypeInfo() const = 0 ;
563 } ;
564
565 template<typename T> class wxxVariantDataT : public wxxVariantData
566 {
567 public:
568 wxxVariantDataT(const T& d) : m_data(d) {}
569 virtual ~wxxVariantDataT() {}
570
571 // get a ref to the stored data
572 T & Get() { return m_data; }
573
574 // get a const ref to the stored data
575 const T & Get() const { return m_data; }
576
577 // set the data
578 void Set(const T& d) { m_data = d; }
579
580 // return a heap allocated duplicate
581 virtual wxxVariantData* Clone() const { return new wxxVariantDataT<T>( Get() ) ; }
582
583 // returns the type info of the contentc
584 virtual const wxTypeInfo* GetTypeInfo() const { return wxGetTypeInfo( (T*) NULL ) ; }
585
586 private:
587 T m_data;
588 };
589
590 class WXDLLIMPEXP_BASE wxxVariant
591 {
592 public :
593 wxxVariant() { m_data = NULL ; }
594 wxxVariant( wxxVariantData* data , const wxString& name = wxT("") ) : m_data(data) , m_name(name) {}
595 wxxVariant( const wxxVariant &d ) { if ( d.m_data ) m_data = d.m_data->Clone() ; else m_data = NULL ; m_name = d.m_name ; }
596
597 template<typename T> wxxVariant( const T& data , const wxString& name = wxT("") ) :
598 m_data(new wxxVariantDataT<T>(data) ), m_name(name) {}
599
600 ~wxxVariant() { delete m_data ; }
601
602 // get a ref to the stored data
603 template<typename T> T& Get(WX_TEMPLATED_MEMBER_FIX(T))
604 {
605 wxxVariantDataT<T> *dataptr = dynamic_cast<wxxVariantDataT<T>*> (m_data) ;
606 wxASSERT_MSG( dataptr , wxT("Cast not possible") ) ;
607 return dataptr->Get() ;
608 }
609
610 // get a ref to the stored data
611 template<typename T> const T& Get(WX_TEMPLATED_MEMBER_FIX(T)) const
612 {
613 const wxxVariantDataT<T> *dataptr = dynamic_cast<const wxxVariantDataT<T>*> (m_data) ;
614 wxASSERT_MSG( dataptr , wxT("Cast not possible") ) ;
615 return dataptr->Get() ;
616 }
617
618 bool IsEmpty() const { return m_data == NULL ; }
619
620 template<typename T> bool HasData() const
621 {
622 const wxxVariantDataT<T> *dataptr = dynamic_cast<const wxxVariantDataT<T>*> (m_data) ;
623 return dataptr != NULL ;
624 }
625
626 // stores the data
627 template<typename T> void Set(const T& data) const
628 {
629 delete m_data ;
630 m_data = new wxxVariantDataT<T>(data) ;
631 }
632
633 wxxVariant& operator=(const wxxVariant &d)
634 {
635 m_data = d.m_data->Clone() ;
636 m_name = d.m_name ;
637 return *this ;
638 }
639
640 // gets the stored data casted to a wxObject* , returning NULL if cast is not possible
641 wxObject* GetAsObject() ;
642
643 // get the typeinfo of the stored object
644 const wxTypeInfo* GetTypeInfo() const { return m_data->GetTypeInfo() ; }
645
646 // returns this value as string
647 wxString GetAsString() const
648 {
649 wxString s ;
650 GetTypeInfo()->ConvertToString( *this , s ) ;
651 return s ;
652 }
653 const wxString& GetName() const { return m_name ; }
654 private :
655 wxxVariantData* m_data ;
656 wxString m_name ;
657 } ;
658
659 #include <wx/dynarray.h>
660
661 WX_DECLARE_OBJARRAY_WITH_DECL(wxxVariant, wxxVariantArray, class WXDLLIMPEXP_BASE);
662
663 // templated streaming, every type must have their specialization for these methods
664
665 template<typename T>
666 void wxStringReadValue( const wxString &s , T &data );
667
668 template<typename T>
669 void wxStringWriteValue( wxString &s , const T &data);
670
671 template<typename T>
672 void wxToStringConverter( const wxxVariant &v, wxString &s) { wxStringWriteValue( s , v.WX_TEMPLATED_MEMBER_CALL(Get , T) ) ; }
673
674 template<typename T>
675 void wxFromStringConverter( const wxString &s, wxxVariant &v) { T d ; wxStringReadValue( s , d ) ; v = wxxVariant(d) ; } \
676
677 // ----------------------------------------------------------------------------
678 // Property Support
679 //
680 // wxPropertyInfo is used to inquire of the property by name. It doesn't
681 // provide access to the property, only information about it. If you
682 // want access, look at wxPropertyAccessor.
683 // ----------------------------------------------------------------------------
684
685 class WXDLLIMPEXP_BASE wxSetter
686 {
687 public:
688 wxSetter( const wxString name ) { m_name = name ; }
689 virtual ~wxSetter() {}
690 virtual void Set( wxObject *object, const wxxVariant &variantValue ) const = 0;
691 const wxString& GetName() const { return m_name ; }
692 private:
693 wxString m_name;
694 };
695
696 class WXDLLIMPEXP_BASE wxGetter
697 {
698 public:
699 wxGetter( const wxString name ) { m_name = name ; }
700 virtual ~wxGetter() {}
701 virtual void Get( const wxObject *object , wxxVariant& result) const = 0;
702 const wxString& GetName() const { return m_name ; }
703 private:
704 wxString m_name;
705 };
706
707 class WXDLLIMPEXP_BASE wxCollectionGetter
708 {
709 public :
710 wxCollectionGetter( const wxString name ) { m_name = name ; }
711 virtual ~wxCollectionGetter() {}
712 virtual void Get( const wxObject *object , wxxVariantArray& result) const = 0;
713 const wxString& GetName() const { return m_name ; }
714 private :
715 wxString m_name ;
716 } ;
717
718 template<typename coll_t> void wxCollectionToVariantArray( const coll_t& coll , wxxVariantArray& result ) ;
719
720 class WXDLLIMPEXP_BASE wxAdder
721 {
722 public :
723 wxAdder( const wxString name ) { m_name = name ; }
724 virtual ~wxAdder() {}
725 virtual void Add( wxObject *object, const wxxVariant &variantValue ) const= 0;
726 const wxString& GetName() const { return m_name ; }
727 private :
728 wxString m_name ;
729 } ;
730
731
732
733 #define WX_SETTER( property, Klass, valueType, setterMethod ) \
734 class wxSetter##property : public wxSetter \
735 { \
736 public: \
737 wxSetter##property() : wxSetter( wxT(#setterMethod) ) {} \
738 ~wxSetter##property() {} \
739 void Set( wxObject *object, const wxxVariant &variantValue ) const \
740 { \
741 Klass *obj = dynamic_cast<Klass*>(object) ; \
742 if ( variantValue.HasData<valueType>() ) \
743 obj->setterMethod(variantValue.Get<valueType>()) ; \
744 else \
745 obj->setterMethod(*variantValue.Get<valueType*>()) ; \
746 } \
747 } ;
748
749 #define WX_GETTER( property, Klass, valueType , gettermethod ) \
750 class wxGetter##property : public wxGetter \
751 { \
752 public : \
753 wxGetter##property() : wxGetter( wxT(#gettermethod) ) {} \
754 ~wxGetter##property() {} \
755 void Get( const wxObject *object , wxxVariant &result) const \
756 { \
757 const Klass *obj = dynamic_cast<const Klass*>(object) ; \
758 result = wxxVariant( obj->gettermethod() ) ; \
759 } \
760 } ;
761
762 #define WX_ADDER( property, Klass, valueType , addermethod ) \
763 class wxAdder##property : public wxAdder \
764 { \
765 public: \
766 wxAdder##property() : wxAdder( wxT(#addermethod) ) {} \
767 ~wxAdder##property() {} \
768 void Add( wxObject *object, const wxxVariant &variantValue ) const \
769 { \
770 Klass *obj = dynamic_cast<Klass*>(object) ; \
771 if ( variantValue.HasData<valueType>() ) \
772 obj->addermethod(variantValue.Get<valueType>()) ; \
773 else \
774 obj->addermethod(*variantValue.Get<valueType*>()) ; \
775 } \
776 } ;
777
778 #define WX_COLLECTION_GETTER( property, Klass, valueType , gettermethod ) \
779 class wxCollectionGetter##property : public wxCollectionGetter \
780 { \
781 public : \
782 wxCollectionGetter##property() : wxCollectionGetter( wxT(#gettermethod) ) {} \
783 ~wxCollectionGetter##property() {} \
784 void Get( const wxObject *object , wxxVariantArray &result) const \
785 { \
786 const Klass *obj = dynamic_cast<const Klass*>(object) ; \
787 wxCollectionToVariantArray( obj->gettermethod() , result ) ; \
788 } \
789 } ;
790
791 class WXDLLIMPEXP_BASE wxPropertyAccessor
792 {
793 public :
794 wxPropertyAccessor( wxSetter *setter , wxGetter *getter , wxAdder *adder , wxCollectionGetter *collectionGetter )
795 { m_setter = setter ; m_getter = getter ; m_adder = adder ; m_collectionGetter = collectionGetter ;}
796
797 virtual ~wxPropertyAccessor() {}
798
799 // Setting a simple property (non-collection)
800 virtual void SetProperty(wxObject *object, const wxxVariant &value) const
801 { wxASSERT_MSG(m_setter,wxT("SetProperty called w/o valid setter") ) ; m_setter->Set( object , value ) ;}
802
803 // Getting a simple property (non-collection)
804 virtual void GetProperty(const wxObject *object, wxxVariant &result) const
805 { wxASSERT_MSG(m_getter,wxT("GetProperty called w/o valid getter") ) ; m_getter->Get( object , result ) ;}
806
807 // Adding an element to a collection property
808 virtual void AddToPropertyCollection(wxObject *object, const wxxVariant &value) const
809 { wxASSERT_MSG(m_adder,wxT("AddToPropertyCollection called w/o valid adder") ) ; m_adder->Add( object , value ) ;}
810
811 // Getting a collection property
812 virtual void GetPropertyCollection( const wxObject *obj, wxxVariantArray &result) const
813 { wxASSERT_MSG(m_collectionGetter,wxT("GetPropertyCollection called w/o valid collection getter") ) ; m_collectionGetter->Get( obj , result) ;}
814
815 virtual bool HasSetter() const { return m_setter != NULL ; }
816 virtual bool HasCollectionGetter() const { return m_collectionGetter != NULL ; }
817 virtual bool HasGetter() const { return m_getter != NULL ; }
818 virtual bool HasAdder() const { return m_adder != NULL ; }
819
820 virtual const wxString& GetCollectionGetterName() const
821 { return m_collectionGetter->GetName() ; }
822 virtual const wxString& GetGetterName() const
823 { return m_getter->GetName() ; }
824 virtual const wxString& GetSetterName() const
825 { return m_setter->GetName() ; }
826 virtual const wxString& GetAdderName() const
827 { return m_adder->GetName() ; }
828
829 protected :
830 wxSetter *m_setter ;
831 wxAdder *m_adder ;
832 wxGetter *m_getter ;
833 wxCollectionGetter* m_collectionGetter ;
834 };
835
836 class WXDLLIMPEXP_BASE wxGenericPropertyAccessor : public wxPropertyAccessor
837 {
838 public :
839 wxGenericPropertyAccessor( const wxString &propName ) ;
840 ~wxGenericPropertyAccessor() ;
841
842 void RenameProperty( const wxString &oldName , const wxString &newName )
843 {
844 wxASSERT( oldName == m_propertyName ) ; m_propertyName = newName ;
845 }
846 virtual bool HasSetter() const { return true ; }
847 virtual bool HasGetter() const { return true ; }
848 virtual bool HasAdder() const { return false ; }
849 virtual bool HasCollectionGetter() const { return false ; }
850
851 virtual const wxString& GetGetterName() const
852 { return m_getterName ; }
853 virtual const wxString& GetSetterName() const
854 { return m_setterName ; }
855
856 virtual void SetProperty(wxObject *object, const wxxVariant &value) const ;
857 virtual void GetProperty(const wxObject *object, wxxVariant &value) const ;
858
859 // Adding an element to a collection property
860 virtual void AddToPropertyCollection(wxObject *WXUNUSED(object), const wxxVariant &WXUNUSED(value)) const
861 { wxASSERT_MSG(0,wxT("AddToPropertyCollection called on a generic accessor") ) ;}
862
863 // Getting a collection property
864 virtual void GetPropertyCollection( const wxObject *WXUNUSED(obj), wxxVariantArray &WXUNUSED(result)) const
865 { wxASSERT_MSG(0,wxT("GetPropertyCollection called on a generic accessor") ) ;}
866 private :
867 struct wxGenericPropertyAccessorInternal ;
868 wxGenericPropertyAccessorInternal* m_data ;
869 wxString m_propertyName ;
870 wxString m_setterName ;
871 wxString m_getterName ;
872 } ;
873
874 typedef long wxPropertyInfoFlags ;
875 enum {
876 // will be removed in future releases
877 wxPROP_DEPRECATED = 0x00000001 ,
878 // object graph property, will be streamed with priority (after constructor properties)
879 wxPROP_OBJECT_GRAPH = 0x00000002 ,
880 // this will only be streamed out and in as enum/set, the internal representation is still a long
881 wxPROP_ENUM_STORE_LONG = 0x00000004 ,
882 // don't stream out this property, needed eg to avoid streaming out children that are always created by their parents
883 wxPROP_DONT_STREAM = 0x00000008 ,
884 } ;
885
886 class WXDLLIMPEXP_BASE wxPropertyInfo
887 {
888 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
889 public :
890 wxPropertyInfo(wxPropertyInfo* &iter,
891 wxClassInfo* itsClass,
892 const wxString& name,
893 const wxString& typeName,
894 wxPropertyAccessor *accessor,
895 wxxVariant dv,
896 wxPropertyInfoFlags flags = 0,
897 const wxString& helpString = wxEmptyString,
898 const wxString& groupString = wxEmptyString) :
899 m_itsClass(itsClass),
900 m_name(name),
901 m_typeInfo(NULL),
902 m_typeName(typeName) ,
903 m_collectionElementTypeInfo(NULL),
904 m_accessor(accessor),
905 m_defaultValue(dv),
906 m_flags(flags),
907 m_helpString(helpString),
908 m_groupString(groupString)
909 {
910 Insert(iter);
911 }
912
913 #if wxUSE_UNICODE
914 wxPropertyInfo(wxPropertyInfo* &iter,
915 wxClassInfo* itsClass,
916 const wxString& name,
917 const char* typeName,
918 wxPropertyAccessor *accessor,
919 wxxVariant dv,
920 wxPropertyInfoFlags flags = 0,
921 const wxString& helpString = wxEmptyString,
922 const wxString& groupString = wxEmptyString) :
923 m_itsClass(itsClass),
924 m_name(name),
925 m_typeInfo(NULL),
926 m_typeName(wxString::FromAscii(typeName)) ,
927 m_collectionElementTypeInfo(NULL),
928 m_accessor(accessor),
929 m_defaultValue(dv),
930 m_flags(flags),
931 m_helpString(helpString),
932 m_groupString(groupString)
933 {
934 Insert(iter);
935 }
936 #endif
937 wxPropertyInfo(wxPropertyInfo* &iter,
938 wxClassInfo* itsClass,
939 const wxString& name,
940 wxDelegateTypeInfo* type,
941 wxPropertyAccessor *accessor,
942 wxxVariant dv,
943 wxPropertyInfoFlags flags = 0,
944 const wxString& helpString = wxEmptyString,
945 const wxString& groupString = wxEmptyString) :
946 m_itsClass(itsClass),
947 m_name(name),
948 m_typeInfo(type),
949 m_collectionElementTypeInfo(NULL),
950 m_accessor(accessor),
951 m_defaultValue(dv),
952 m_flags(flags),
953 m_helpString(helpString),
954 m_groupString(groupString)
955 {
956 Insert(iter);
957 }
958
959 wxPropertyInfo(wxPropertyInfo* &iter,
960 wxClassInfo* itsClass, const wxString& name,
961 const wxString& collectionTypeName,
962 const wxString& elementTypeName,
963 wxPropertyAccessor *accessor,
964 wxPropertyInfoFlags flags = 0,
965 const wxString& helpString = wxEmptyString,
966 const wxString& groupString = wxEmptyString) :
967 m_itsClass(itsClass),
968 m_name(name),
969 m_typeInfo(NULL),
970 m_typeName(collectionTypeName) ,
971 m_collectionElementTypeInfo(NULL),
972 m_collectionElementTypeName(elementTypeName),
973 m_accessor(accessor) ,
974 m_flags(flags),
975 m_helpString(helpString),
976 m_groupString(groupString)
977 {
978 Insert(iter);
979 }
980
981 #if wxUSE_UNICODE
982 wxPropertyInfo(wxPropertyInfo* &iter,
983 wxClassInfo* itsClass, const wxString& name,
984 const char* collectionTypeName,
985 const char* elementTypeName,
986 wxPropertyAccessor *accessor,
987 wxPropertyInfoFlags flags = 0,
988 const wxString& helpString = wxEmptyString,
989 const wxString& groupString = wxEmptyString) :
990 m_itsClass(itsClass),
991 m_name(name),
992 m_typeInfo(NULL),
993 m_typeName(wxString::FromAscii(collectionTypeName)) ,
994 m_collectionElementTypeInfo(NULL),
995 m_collectionElementTypeName(wxString::FromAscii(elementTypeName)),
996 m_accessor(accessor) ,
997 m_flags(flags),
998 m_helpString(helpString),
999 m_groupString(groupString)
1000 {
1001 Insert(iter);
1002 }
1003 #endif
1004 ~wxPropertyInfo() ;
1005
1006 // return the class this property is declared in
1007 const wxClassInfo* GetDeclaringClass() const { return m_itsClass ; }
1008
1009 // return the name of this property
1010 const wxString& GetName() const { return m_name ; }
1011
1012 // returns the flags of this property
1013 wxPropertyInfoFlags GetFlags() const { return m_flags ;}
1014
1015 // returns the short help string of this property
1016 const wxString& GetHelpString() const { return m_helpString ; }
1017
1018 // returns the group string of this property
1019 const wxString& GetGroupString() const { return m_groupString ; }
1020
1021 // return the element type info of this property (for collections, otherwise NULL)
1022 const wxTypeInfo * GetCollectionElementTypeInfo() const
1023 {
1024 if ( m_collectionElementTypeInfo == NULL )
1025 m_collectionElementTypeInfo = wxTypeInfo::FindType(m_collectionElementTypeName) ;
1026 return m_collectionElementTypeInfo ;
1027 }
1028
1029 // return the type info of this property
1030 const wxTypeInfo * GetTypeInfo() const
1031 {
1032 if ( m_typeInfo == NULL )
1033 m_typeInfo = wxTypeInfo::FindType(m_typeName) ;
1034 return m_typeInfo ;
1035 }
1036
1037 // return the accessor for this property
1038 wxPropertyAccessor* GetAccessor() const { return m_accessor ; }
1039
1040 // returns NULL if this is the last property of this class
1041 wxPropertyInfo* GetNext() const { return m_next ; }
1042
1043 // returns the default value of this property, its kind may be wxT_VOID if it is not valid
1044 wxxVariant GetDefaultValue() const { return m_defaultValue ; }
1045 private :
1046 void Insert(wxPropertyInfo* &iter)
1047 {
1048 m_next = NULL ;
1049 if ( iter == NULL )
1050 iter = this ;
1051 else
1052 {
1053 wxPropertyInfo* i = iter ;
1054 while( i->m_next )
1055 i = i->m_next ;
1056
1057 i->m_next = this ;
1058 }
1059 }
1060
1061 wxClassInfo* m_itsClass ;
1062 wxString m_name ;
1063 mutable wxTypeInfo* m_typeInfo ;
1064 wxString m_typeName ;
1065 mutable wxTypeInfo* m_collectionElementTypeInfo ;
1066 wxString m_collectionElementTypeName ;
1067 wxPropertyAccessor* m_accessor ;
1068 wxxVariant m_defaultValue;
1069 wxPropertyInfoFlags m_flags ;
1070 wxString m_helpString ;
1071 wxString m_groupString ;
1072 // string representation of the default value
1073 // to be assigned by the designer to the property
1074 // when the component is dropped on the container.
1075 wxPropertyInfo* m_next ;
1076 };
1077
1078 WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxPropertyInfo* , wxPropertyInfoMap , class WXDLLIMPEXP_BASE ) ;
1079
1080 #define WX_BEGIN_PROPERTIES_TABLE(theClass) \
1081 wxPropertyInfo *theClass::GetPropertiesStatic() \
1082 { \
1083 typedef theClass class_t; \
1084 static wxPropertyInfo* first = NULL ;
1085
1086 #define WX_END_PROPERTIES_TABLE() \
1087 return first ; }
1088
1089 #define WX_HIDE_PROPERTY( pname ) \
1090 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(void).name() ,NULL , wxxVariant() , wxPROP_DONT_STREAM , wxEmptyString , wxEmptyString ) ;
1091
1092 #define WX_PROPERTY( pname , type , setter , getter ,defaultValue , flags , help , group) \
1093 WX_SETTER( pname , class_t , type , setter ) \
1094 static wxSetter##pname _setter##pname ; \
1095 WX_GETTER( pname , class_t , type , getter ) \
1096 static wxGetter##pname _getter##pname ; \
1097 static wxPropertyAccessor _accessor##pname( &_setter##pname , &_getter##pname , NULL , NULL ) ; \
1098 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(type).name() ,&_accessor##pname , wxxVariant(defaultValue) , flags , group , help ) ;
1099
1100 #define WX_PROPERTY_FLAGS( pname , flags , type , setter , getter ,defaultValue , pflags , help , group) \
1101 WX_SETTER( pname , class_t , type , setter ) \
1102 static wxSetter##pname _setter##pname ; \
1103 WX_GETTER( pname , class_t , type , getter ) \
1104 static wxGetter##pname _getter##pname ; \
1105 static wxPropertyAccessor _accessor##pname( &_setter##pname , &_getter##pname , NULL , NULL ) ; \
1106 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(flags).name() ,&_accessor##pname , wxxVariant(defaultValue), wxPROP_ENUM_STORE_LONG | pflags , help , group ) ;
1107
1108 #define WX_READONLY_PROPERTY( pname , type , getter ,defaultValue , flags , help , group) \
1109 WX_GETTER( pname , class_t , type , getter ) \
1110 static wxGetter##pname _getter##pname ; \
1111 static wxPropertyAccessor _accessor##pname( NULL , &_getter##pname , NULL , NULL ) ; \
1112 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(type).name() ,&_accessor##pname , wxxVariant(defaultValue), flags , help , group ) ;
1113
1114 #define WX_READONLY_PROPERTY_FLAGS( pname , flags , type , getter ,defaultValue , pflags , help , group) \
1115 WX_GETTER( pname , class_t , type , getter ) \
1116 static wxGetter##pname _getter##pname ; \
1117 static wxPropertyAccessor _accessor##pname( NULL , &_getter##pname , NULL , NULL ) ; \
1118 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(flags).name() ,&_accessor##pname , wxxVariant(defaultValue), wxPROP_ENUM_STORE_LONG | pflags , help , group ) ;
1119
1120 #define WX_PROPERTY_COLLECTION( pname , colltype , addelemtype , adder , getter , flags , help , group ) \
1121 WX_ADDER( pname , class_t , addelemtype , adder ) \
1122 static wxAdder##pname _adder##pname ; \
1123 WX_COLLECTION_GETTER( pname , class_t , colltype , getter ) \
1124 static wxCollectionGetter##pname _collectionGetter##pname ; \
1125 static wxPropertyAccessor _accessor##pname( NULL , NULL ,&_adder##pname , &_collectionGetter##pname ) ; \
1126 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(colltype).name() ,typeid(addelemtype).name() ,&_accessor##pname , flags , help , group ) ;
1127
1128 #define WX_READONLY_PROPERTY_COLLECTION( pname , colltype , addelemtype , getter , flags , help , group) \
1129 WX_COLLECTION_GETTER( pname , class_t , colltype , getter ) \
1130 static wxCollectionGetter##pname _collectionGetter##pname ; \
1131 static wxPropertyAccessor _accessor##pname( NULL , NULL , NULL , &_collectionGetter##pname ) ; \
1132 static wxPropertyInfo _propertyInfo##pname( first ,class_t::GetClassInfoStatic() , wxT(#pname) , typeid(colltype).name() ,typeid(addelemtype).name() ,&_accessor##pname , flags , help , group ) ;
1133
1134
1135 #define WX_EVENT_PROPERTY( name , eventType , eventClass ) \
1136 static wxDelegateTypeInfo _typeInfo##name( eventType , CLASSINFO( eventClass ) ) ; \
1137 static wxPropertyInfo _propertyInfo##name( first ,class_t::GetClassInfoStatic() , wxT(#name) , &_typeInfo##name , NULL , wxxVariant() ) ; \
1138
1139 #define WX_EVENT_RANGE_PROPERTY( name , eventType , lastEventType , eventClass ) \
1140 static wxDelegateTypeInfo _typeInfo##name( eventType , lastEventType , CLASSINFO( eventClass ) ) ; \
1141 static wxPropertyInfo _propertyInfo##name( first , class_t::GetClassInfoStatic() , wxT(#name) , &_typeInfo##name , NULL , wxxVariant() ) ; \
1142
1143 // ----------------------------------------------------------------------------
1144 // Handler Info
1145 //
1146 // this is describing an event sink
1147 // ----------------------------------------------------------------------------
1148
1149 class WXDLLIMPEXP_BASE wxHandlerInfo
1150 {
1151 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
1152 public :
1153 wxHandlerInfo(wxHandlerInfo* &iter,
1154 wxClassInfo* itsClass,
1155 const wxString& name,
1156 wxObjectEventFunction address,
1157 const wxClassInfo* eventClassInfo) :
1158 m_eventFunction(address),
1159 m_name(name),
1160 m_eventClassInfo(eventClassInfo) ,
1161 m_itsClass(itsClass)
1162 {
1163 m_next = NULL ;
1164 if ( iter == NULL )
1165 iter = this ;
1166 else
1167 {
1168 wxHandlerInfo* i = iter ;
1169 while( i->m_next )
1170 i = i->m_next ;
1171
1172 i->m_next = this ;
1173 }
1174 }
1175
1176 ~wxHandlerInfo() ;
1177
1178 // return the name of this handler
1179 const wxString& GetName() const { return m_name ; }
1180
1181 // return the class info of the event
1182 const wxClassInfo * GetEventClassInfo() const { return m_eventClassInfo ; }
1183
1184 // get the handler function pointer
1185 wxObjectEventFunction GetEventFunction() const { return m_eventFunction ; }
1186
1187 // returns NULL if this is the last handler of this class
1188 wxHandlerInfo* GetNext() const { return m_next ; }
1189
1190 // return the class this property is declared in
1191 const wxClassInfo* GetDeclaringClass() const { return m_itsClass ; }
1192
1193 private :
1194 wxObjectEventFunction m_eventFunction ;
1195 wxString m_name;
1196 const wxClassInfo* m_eventClassInfo ;
1197 wxHandlerInfo* m_next ;
1198 wxClassInfo* m_itsClass ;
1199 };
1200
1201 #define WX_HANDLER(name,eventClassType) \
1202 static wxHandlerInfo _handlerInfo##name( first , class_t::GetClassInfoStatic() , #name , (wxObjectEventFunction) (wxEventFunction) &name , CLASSINFO( eventClassType ) ) ;
1203
1204 #define WX_BEGIN_HANDLERS_TABLE(theClass) \
1205 wxHandlerInfo *theClass::GetHandlersStatic() \
1206 { \
1207 typedef theClass class_t; \
1208 static wxHandlerInfo* first = NULL ;
1209
1210 #define WX_END_HANDLERS_TABLE() \
1211 return first ; }
1212
1213 // ----------------------------------------------------------------------------
1214 // Constructor Bridges
1215 //
1216 // allow to set up constructors with params during runtime
1217 // ----------------------------------------------------------------------------
1218
1219 class WXDLLIMPEXP_BASE wxConstructorBridge
1220 {
1221 public :
1222 virtual void Create(wxObject * &o, wxxVariant *args) = 0;
1223 };
1224
1225 // a direct constructor bridge calls the operator new for this class and
1226 // passes all params to the constructor. needed for classes that cannot be
1227 // instantiated using alloc-create semantics
1228 class WXDLLIMPEXP_BASE wxDirectConstructorBrigde : public wxConstructorBridge
1229 {
1230 public :
1231 virtual void Create(wxObject * &o, wxxVariant *args) = 0;
1232 } ;
1233
1234 // Creator Bridges for all Numbers of Params
1235
1236 // no params
1237
1238 template<typename Class>
1239 struct wxConstructorBridge_0 : public wxConstructorBridge
1240 {
1241 void Create(wxObject * &o, wxxVariant *)
1242 {
1243 Class *obj = dynamic_cast<Class*>(o);
1244 obj->Create();
1245 }
1246 };
1247
1248 struct wxConstructorBridge_Dummy : public wxConstructorBridge
1249 {
1250 void Create(wxObject *&, wxxVariant *)
1251 {
1252 }
1253 } ;
1254
1255 #define WX_CONSTRUCTOR_0(klass) \
1256 wxConstructorBridge_0<klass> constructor##klass ; \
1257 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1258 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
1259 const int klass::sm_constructorPropertiesCount##klass = 0 ;
1260
1261 #define WX_CONSTRUCTOR_DUMMY(klass) \
1262 wxConstructorBridge_Dummy constructor##klass ; \
1263 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1264 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
1265 const int klass::sm_constructorPropertiesCount##klass = 0 ;
1266
1267 // 1 param
1268
1269 template<typename Class, typename T0>
1270 struct wxConstructorBridge_1 : public wxConstructorBridge
1271 {
1272 void Create(wxObject * &o, wxxVariant *args)
1273 {
1274 Class *obj = dynamic_cast<Class*>(o);
1275 obj->Create(
1276 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0)
1277 );
1278 }
1279 };
1280
1281 #define WX_CONSTRUCTOR_1(klass,t0,v0) \
1282 wxConstructorBridge_1<klass,t0> constructor##klass ; \
1283 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1284 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) } ; \
1285 const int klass::sm_constructorPropertiesCount##klass = 1 ;
1286
1287 // 2 params
1288
1289 template<typename Class,
1290 typename T0, typename T1>
1291 struct wxConstructorBridge_2 : public wxConstructorBridge
1292 {
1293 void Create(wxObject * &o, wxxVariant *args)
1294 {
1295 Class *obj = dynamic_cast<Class*>(o);
1296 obj->Create(
1297 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1298 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1)
1299 );
1300 }
1301 };
1302
1303 #define WX_CONSTRUCTOR_2(klass,t0,v0,t1,v1) \
1304 wxConstructorBridge_2<klass,t0,t1> constructor##klass ; \
1305 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1306 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) } ; \
1307 const int klass::sm_constructorPropertiesCount##klass = 2;
1308
1309 // direct constructor version
1310
1311 template<typename Class,
1312 typename T0, typename T1>
1313 struct wxDirectConstructorBridge_2 : public wxDirectConstructorBrigde
1314 {
1315 void Create(wxObject * &o, wxxVariant *args)
1316 {
1317 o = new Class(
1318 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1319 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1)
1320 );
1321 }
1322 };
1323
1324 #define WX_DIRECT_CONSTRUCTOR_2(klass,t0,v0,t1,v1) \
1325 wxDirectConstructorBridge_2<klass,t0,t1> constructor##klass ; \
1326 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1327 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) } ; \
1328 const int klass::sm_constructorPropertiesCount##klass = 2;
1329
1330
1331 // 3 params
1332
1333 template<typename Class,
1334 typename T0, typename T1, typename T2>
1335 struct wxConstructorBridge_3 : public wxConstructorBridge
1336 {
1337 void Create(wxObject * &o, wxxVariant *args)
1338 {
1339 Class *obj = dynamic_cast<Class*>(o);
1340 obj->Create(
1341 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1342 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1343 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2)
1344 );
1345 }
1346 };
1347
1348 #define WX_CONSTRUCTOR_3(klass,t0,v0,t1,v1,t2,v2) \
1349 wxConstructorBridge_3<klass,t0,t1,t2> constructor##klass ; \
1350 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1351 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) } ; \
1352 const int klass::sm_constructorPropertiesCount##klass = 3 ;
1353
1354 // 4 params
1355
1356 template<typename Class,
1357 typename T0, typename T1, typename T2, typename T3>
1358 struct wxConstructorBridge_4 : public wxConstructorBridge
1359 {
1360 void Create(wxObject * &o, wxxVariant *args)
1361 {
1362 Class *obj = dynamic_cast<Class*>(o);
1363 obj->Create(
1364 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1365 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1366 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1367 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3)
1368 );
1369 }
1370 };
1371
1372 #define WX_CONSTRUCTOR_4(klass,t0,v0,t1,v1,t2,v2,t3,v3) \
1373 wxConstructorBridge_4<klass,t0,t1,t2,t3> constructor##klass ; \
1374 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1375 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) } ; \
1376 const int klass::sm_constructorPropertiesCount##klass = 4 ;
1377
1378 // 5 params
1379
1380 template<typename Class,
1381 typename T0, typename T1, typename T2, typename T3, typename T4>
1382 struct wxConstructorBridge_5 : public wxConstructorBridge
1383 {
1384 void Create(wxObject * &o, wxxVariant *args)
1385 {
1386 Class *obj = dynamic_cast<Class*>(o);
1387 obj->Create(
1388 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1389 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1390 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1391 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1392 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4)
1393 );
1394 }
1395 };
1396
1397 #define WX_CONSTRUCTOR_5(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4) \
1398 wxConstructorBridge_5<klass,t0,t1,t2,t3,t4> constructor##klass ; \
1399 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1400 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) } ; \
1401 const int klass::sm_constructorPropertiesCount##klass = 5;
1402
1403 // 6 params
1404
1405 template<typename Class,
1406 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5>
1407 struct wxConstructorBridge_6 : public wxConstructorBridge
1408 {
1409 void Create(wxObject * &o, wxxVariant *args)
1410 {
1411 Class *obj = dynamic_cast<Class*>(o);
1412 obj->Create(
1413 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1414 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1415 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1416 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1417 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1418 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5)
1419 );
1420 }
1421 };
1422
1423 #define WX_CONSTRUCTOR_6(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5) \
1424 wxConstructorBridge_6<klass,t0,t1,t2,t3,t4,t5> constructor##klass ; \
1425 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1426 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) } ; \
1427 const int klass::sm_constructorPropertiesCount##klass = 6;
1428
1429 // direct constructor version
1430
1431 template<typename Class,
1432 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5>
1433 struct wxDirectConstructorBridge_6 : public wxDirectConstructorBrigde
1434 {
1435 void Create(wxObject * &o, wxxVariant *args)
1436 {
1437 o = new Class(
1438 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1439 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1440 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1441 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1442 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1443 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5)
1444 );
1445 }
1446 };
1447
1448 #define WX_DIRECT_CONSTRUCTOR_6(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5) \
1449 wxDirectConstructorBridge_6<klass,t0,t1,t2,t3,t4,t5> constructor##klass ; \
1450 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1451 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) } ; \
1452 const int klass::sm_constructorPropertiesCount##klass = 6;
1453
1454 // 7 params
1455
1456 template<typename Class,
1457 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
1458 struct wxConstructorBridge_7 : public wxConstructorBridge
1459 {
1460 void Create(wxObject * &o, wxxVariant *args)
1461 {
1462 Class *obj = dynamic_cast<Class*>(o);
1463 obj->Create(
1464 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1465 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1466 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1467 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1468 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1469 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5) ,
1470 args[6].WX_TEMPLATED_MEMBER_CALL(Get , T6)
1471 );
1472 }
1473 };
1474
1475 #define WX_CONSTRUCTOR_7(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5,t6,v6) \
1476 wxConstructorBridge_7<klass,t0,t1,t2,t3,t4,t5,t6> constructor##klass ; \
1477 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1478 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) , wxT(#v6) } ; \
1479 const int klass::sm_constructorPropertiesCount##klass = 7;
1480
1481 // 8 params
1482
1483 template<typename Class,
1484 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7>
1485 struct wxConstructorBridge_8 : public wxConstructorBridge
1486 {
1487 void Create(wxObject * &o, wxxVariant *args)
1488 {
1489 Class *obj = dynamic_cast<Class*>(o);
1490 obj->Create(
1491 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1492 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1493 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1494 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1495 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1496 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5) ,
1497 args[6].WX_TEMPLATED_MEMBER_CALL(Get , T6) ,
1498 args[7].WX_TEMPLATED_MEMBER_CALL(Get , T7)
1499 );
1500 }
1501 };
1502
1503 #define WX_CONSTRUCTOR_8(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5,t6,v6,t7,v7) \
1504 wxConstructorBridge_8<klass,t0,t1,t2,t3,t4,t5,t6,t7> constructor##klass ; \
1505 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1506 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) , wxT(#v6) , wxT(#v7) } ; \
1507 const int klass::sm_constructorPropertiesCount##klass = 8;
1508 // ----------------------------------------------------------------------------
1509 // wxClassInfo
1510 // ----------------------------------------------------------------------------
1511
1512 typedef wxObject *(*wxObjectConstructorFn)(void);
1513 typedef wxObject* (*wxVariantToObjectConverter)( wxxVariant &data ) ;
1514 typedef wxxVariant (*wxObjectToVariantConverter)( wxObject* ) ;
1515
1516 class WXDLLIMPEXP_BASE wxWriter;
1517 class WXDLLIMPEXP_BASE wxPersister;
1518
1519 typedef bool (*wxObjectStreamingCallback) ( const wxObject *, wxWriter * , wxPersister * , wxxVariantArray & ) ;
1520
1521 class WXDLLIMPEXP_BASE wxClassInfo
1522 {
1523 friend class WXDLLIMPEXP_BASE wxPropertyInfo ;
1524 friend class WXDLLIMPEXP_BASE wxHandlerInfo ;
1525 public:
1526 wxClassInfo(const wxClassInfo **_Parents,
1527 const wxChar *_UnitName,
1528 const wxChar *_ClassName,
1529 int size,
1530 wxObjectConstructorFn ctor ,
1531 wxPropertyInfo *_Props ,
1532 wxHandlerInfo *_Handlers ,
1533 wxConstructorBridge* _Constructor ,
1534 const wxChar ** _ConstructorProperties ,
1535 const int _ConstructorPropertiesCount ,
1536 wxVariantToObjectConverter _PtrConverter1 ,
1537 wxVariantToObjectConverter _Converter2 ,
1538 wxObjectToVariantConverter _Converter3 ,
1539 wxObjectStreamingCallback _streamingCallback = NULL
1540 ) :
1541
1542 m_className(_ClassName),
1543 m_objectSize(size),
1544 m_objectConstructor(ctor),
1545 m_next(sm_first),
1546 m_firstProperty(_Props),
1547 m_firstHandler(_Handlers),
1548 m_parents(_Parents),
1549 m_unitName(_UnitName),
1550 m_constructor(_Constructor),
1551 m_constructorProperties(_ConstructorProperties),
1552 m_constructorPropertiesCount(_ConstructorPropertiesCount),
1553 m_variantOfPtrToObjectConverter(_PtrConverter1),
1554 m_variantToObjectConverter(_Converter2),
1555 m_objectToVariantConverter(_Converter3),
1556 m_streamingCallback(_streamingCallback)
1557 {
1558 sm_first = this;
1559 Register() ;
1560 }
1561
1562 wxClassInfo(const wxChar *_UnitName, const wxChar *_ClassName,
1563 const wxClassInfo **_Parents) :
1564 m_className(_ClassName),
1565 m_objectSize(0),
1566 m_objectConstructor(NULL),
1567 m_next(sm_first),
1568 m_firstProperty(NULL),
1569 m_firstHandler(NULL),
1570 m_parents(_Parents),
1571 m_unitName(_UnitName),
1572 m_constructor(NULL),
1573 m_constructorProperties(NULL),
1574 m_constructorPropertiesCount(0),
1575 m_variantOfPtrToObjectConverter(NULL),
1576 m_variantToObjectConverter(NULL),
1577 m_objectToVariantConverter(NULL),
1578 m_streamingCallback(NULL)
1579 {
1580 sm_first = this;
1581 Register() ;
1582 }
1583
1584 virtual ~wxClassInfo() ;
1585
1586 // allocates an instance of this class, this object does not have to be initialized or fully constructed
1587 // as this call will be followed by a call to Create
1588 virtual wxObject *AllocateObject() const { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
1589
1590 // 'old naming' for AllocateObject staying here for backward compatibility
1591 wxObject *CreateObject() const { return AllocateObject() ; }
1592
1593 // direct construction call for classes that cannot construct instances via alloc/create
1594 wxObject *ConstructObject(int ParamCount, wxxVariant *Params) const
1595 {
1596 wxASSERT_MSG( ParamCount == m_constructorPropertiesCount , wxT("Illegal Parameter Count for ConstructObject Method")) ;
1597 wxObject *object = NULL ;
1598 m_constructor->Create( object , Params ) ;
1599 return object ;
1600 }
1601
1602 bool NeedsDirectConstruction() const { return dynamic_cast<wxDirectConstructorBrigde*>( m_constructor) != NULL ; }
1603
1604 const wxChar *GetClassName() const { return m_className; }
1605 const wxChar *GetIncludeName() const { return m_unitName ; }
1606 const wxClassInfo **GetParents() const { return m_parents; }
1607 int GetSize() const { return m_objectSize; }
1608
1609 wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
1610 static const wxClassInfo *GetFirst() { return sm_first; }
1611 const wxClassInfo *GetNext() const { return m_next; }
1612 static wxClassInfo *FindClass(const wxChar *className);
1613
1614 // Climb upwards through inheritance hierarchy.
1615 // Dual inheritance is catered for.
1616
1617 bool IsKindOf(const wxClassInfo *info) const
1618 {
1619 if ( info != 0 )
1620 {
1621 if ( info == this )
1622 return true ;
1623
1624 for ( int i = 0 ; m_parents[i] ; ++ i )
1625 {
1626 if ( m_parents[i]->IsKindOf( info ) )
1627 return true ;
1628 }
1629 }
1630 return false ;
1631 }
1632
1633 // if there is a callback registered with that class it will be called
1634 // before this object will be written to disk, it can veto streaming out
1635 // this object by returning false, if this class has not registered a
1636 // callback, the search will go up the inheritance tree if no callback has
1637 // been registered true will be returned by default
1638 bool BeforeWriteObject( const wxObject *obj, wxWriter *streamer , wxPersister *persister , wxxVariantArray &metadata) const ;
1639
1640 // gets the streaming callback from this class or any superclass
1641 wxObjectStreamingCallback GetStreamingCallback() const ;
1642
1643 #ifdef WXWIN_COMPATIBILITY_2_4
1644 // Initializes parent pointers and hash table for fast searching.
1645 wxDEPRECATED( static void InitializeClasses() );
1646 // Cleans up hash table used for fast searching.
1647 wxDEPRECATED( static void CleanUpClasses() );
1648 #endif
1649 static void CleanUp();
1650
1651 // returns the first property
1652 const wxPropertyInfo* GetFirstProperty() const { return m_firstProperty ; }
1653
1654 // returns the first handler
1655 const wxHandlerInfo* GetFirstHandler() const { return m_firstHandler ; }
1656
1657 // Call the Create upon an instance of the class, in the end the object is fully
1658 // initialized
1659 virtual void Create (wxObject *object, int ParamCount, wxxVariant *Params) const
1660 {
1661 wxASSERT_MSG( ParamCount == m_constructorPropertiesCount , wxT("Illegal Parameter Count for Create Method")) ;
1662 m_constructor->Create( object , Params ) ;
1663 }
1664
1665 // get number of parameters for constructor
1666 virtual int GetCreateParamCount() const { return m_constructorPropertiesCount; }
1667
1668 // get n-th constructor parameter
1669 virtual const wxChar* GetCreateParamName(int n) const { return m_constructorProperties[n] ; }
1670
1671 // Runtime access to objects for simple properties (get/set) by property name, and variant data
1672 virtual void SetProperty (wxObject *object, const wxChar *propertyName, const wxxVariant &value) const ;
1673 virtual wxxVariant GetProperty (wxObject *object, const wxChar *propertyName) const;
1674
1675 // Runtime access to objects for collection properties by property name
1676 virtual wxxVariantArray GetPropertyCollection(wxObject *object, const wxChar *propertyName) const ;
1677 virtual void AddToPropertyCollection(wxObject *object, const wxChar *propertyName , const wxxVariant& value) const ;
1678
1679 // we must be able to cast variants to wxObject pointers, templates seem not to be suitable
1680 wxObject* VariantToInstance( wxxVariant &data ) const
1681 { if ( data.GetTypeInfo()->GetKind() == wxT_OBJECT )
1682 return m_variantToObjectConverter( data ) ;
1683 else
1684 return m_variantOfPtrToObjectConverter( data ) ;
1685 }
1686
1687 wxxVariant InstanceToVariant( wxObject *object ) const { return m_objectToVariantConverter( object ) ; }
1688
1689 // find property by name
1690 virtual const wxPropertyInfo *FindPropertyInfo (const wxChar *PropertyName) const ;
1691
1692 // find handler by name
1693 virtual const wxHandlerInfo *FindHandlerInfo (const wxChar *PropertyName) const ;
1694
1695 // find property by name
1696 virtual wxPropertyInfo *FindPropertyInfoInThisClass (const wxChar *PropertyName) const ;
1697
1698 // find handler by name
1699 virtual wxHandlerInfo *FindHandlerInfoInThisClass (const wxChar *PropertyName) const ;
1700
1701 // puts all the properties of this class and its superclasses in the map, as long as there is not yet
1702 // an entry with the same name (overriding mechanism)
1703 void GetProperties( wxPropertyInfoMap &map ) const ;
1704 public:
1705 const wxChar *m_className;
1706 int m_objectSize;
1707 wxObjectConstructorFn m_objectConstructor;
1708
1709 // class info object live in a linked list:
1710 // pointers to its head and the next element in it
1711
1712 static wxClassInfo *sm_first;
1713 wxClassInfo *m_next;
1714
1715 // FIXME: this should be private (currently used directly by way too
1716 // many clients)
1717 static wxHashTable *sm_classTable;
1718
1719 protected :
1720 wxPropertyInfo * m_firstProperty ;
1721 wxHandlerInfo * m_firstHandler ;
1722 private:
1723 const wxClassInfo** m_parents ;
1724 const wxChar* m_unitName;
1725
1726 wxConstructorBridge* m_constructor ;
1727 const wxChar ** m_constructorProperties ;
1728 const int m_constructorPropertiesCount ;
1729 wxVariantToObjectConverter m_variantOfPtrToObjectConverter ;
1730 wxVariantToObjectConverter m_variantToObjectConverter ;
1731 wxObjectToVariantConverter m_objectToVariantConverter ;
1732 wxObjectStreamingCallback m_streamingCallback ;
1733 const wxPropertyAccessor *FindAccessor (const wxChar *propertyName) const ;
1734
1735
1736 // InitializeClasses() helper
1737 static wxClassInfo *GetBaseByName(const wxChar *name) ;
1738
1739 protected:
1740 // registers the class
1741 void Register();
1742 void Unregister();
1743
1744 DECLARE_NO_COPY_CLASS(wxClassInfo)
1745 };
1746
1747
1748 WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
1749
1750 // ----------------------------------------------------------------------------
1751 // wxDynamicObject
1752 // ----------------------------------------------------------------------------
1753 //
1754 // this object leads to having a pure runtime-instantiation
1755
1756 class WXDLLIMPEXP_BASE wxDynamicClassInfo : public wxClassInfo
1757 {
1758 public :
1759 wxDynamicClassInfo( const wxChar *_UnitName, const wxChar *_ClassName , const wxClassInfo* superClass ) ;
1760 virtual ~wxDynamicClassInfo() ;
1761
1762 // constructs a wxDynamicObject with an instance
1763 virtual wxObject *AllocateObject() const ;
1764
1765 // Call the Create method for a class
1766 virtual void Create (wxObject *object, int ParamCount, wxxVariant *Params) const ;
1767
1768 // get number of parameters for constructor
1769 virtual int GetCreateParamCount() const ;
1770
1771 // get i-th constructor parameter
1772 virtual const wxChar* GetCreateParamName(int i) const ;
1773
1774 // Runtime access to objects by property name, and variant data
1775 virtual void SetProperty (wxObject *object, const wxChar *PropertyName, const wxxVariant &Value) const ;
1776 virtual wxxVariant GetProperty (wxObject *object, const wxChar *PropertyName) const ;
1777
1778 // adds a property to this class at runtime
1779 void AddProperty( const wxChar *propertyName , const wxTypeInfo* typeInfo ) ;
1780
1781 // removes an existing runtime-property
1782 void RemoveProperty( const wxChar *propertyName ) ;
1783
1784 // renames an existing runtime-property
1785 void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ;
1786
1787 // as a handler to this class at runtime
1788 void AddHandler( const wxChar *handlerName , wxObjectEventFunction address , const wxClassInfo* eventClassInfo ) ;
1789
1790 // removes an existing runtime-handler
1791 void RemoveHandler( const wxChar *handlerName ) ;
1792
1793 // renames an existing runtime-handler
1794 void RenameHandler( const wxChar *oldHandlerName , const wxChar *newHandlerName ) ;
1795 } ;
1796
1797 // ----------------------------------------------------------------------------
1798 // Dynamic class macros
1799 // ----------------------------------------------------------------------------
1800
1801 #define _DECLARE_DYNAMIC_CLASS(name) \
1802 public: \
1803 static wxClassInfo sm_class##name; \
1804 static const wxClassInfo* sm_classParents##name[] ; \
1805 static wxPropertyInfo* GetPropertiesStatic() ; \
1806 static wxHandlerInfo* GetHandlersStatic() ; \
1807 static wxClassInfo *GetClassInfoStatic() \
1808 { return &name::sm_class##name; } \
1809 virtual wxClassInfo *GetClassInfo() const \
1810 { return &name::sm_class##name; }
1811
1812 #define DECLARE_DYNAMIC_CLASS(name) \
1813 static wxConstructorBridge* sm_constructor##name ; \
1814 static const wxChar * sm_constructorProperties##name[] ; \
1815 static const int sm_constructorPropertiesCount##name ; \
1816 _DECLARE_DYNAMIC_CLASS(name)
1817
1818 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
1819 DECLARE_NO_ASSIGN_CLASS(name) \
1820 DECLARE_DYNAMIC_CLASS(name)
1821
1822 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
1823 DECLARE_NO_COPY_CLASS(name) \
1824 DECLARE_DYNAMIC_CLASS(name)
1825
1826 #define DECLARE_ABSTRACT_CLASS(name) _DECLARE_DYNAMIC_CLASS(name)
1827 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
1828
1829 // -----------------------------------
1830 // for concrete classes
1831 // -----------------------------------
1832
1833 // Single inheritance with one base class
1834
1835 #define _TYPEINFO_CLASSES(n , toString , fromString ) \
1836 wxClassTypeInfo s_typeInfo##n(wxT_OBJECT , &n::sm_class##n , toString , fromString , typeid(n).name()) ; \
1837 wxClassTypeInfo s_typeInfoPtr##n(wxT_OBJECT_PTR , &n::sm_class##n , toString , fromString , typeid(n*).name()) ;
1838
1839 #define _IMPLEMENT_DYNAMIC_CLASS(name, basename, unit , callback) \
1840 wxObject* wxConstructorFor##name() \
1841 { return new name; } \
1842 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1843 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1844 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1845 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1846 (int) sizeof(name), \
1847 (wxObjectConstructorFn) wxConstructorFor##name , \
1848 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1849 name::sm_constructorPropertiesCount##name , wxVariantOfPtrToObjectConverter##name , NULL , wxObjectToVariantConverter##name , callback);
1850
1851 #define _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY(name, basename, unit, callback ) \
1852 wxObject* wxConstructorFor##name() \
1853 { return new name; } \
1854 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1855 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return &data.Get<name>() ; } \
1856 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1857 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1858 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1859 (int) sizeof(name), \
1860 (wxObjectConstructorFn) wxConstructorFor##name , \
1861 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1862 name::sm_constructorPropertiesCount##name , wxVariantOfPtrToObjectConverter##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name, callback);
1863
1864 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename ) \
1865 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , "" , NULL ) \
1866 _TYPEINFO_CLASSES(name, NULL , NULL) \
1867 const wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1868 const wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1869 WX_CONSTRUCTOR_DUMMY( name )
1870
1871 #define IMPLEMENT_DYNAMIC_CLASS( name , basename ) \
1872 _IMPLEMENT_DYNAMIC_CLASS( name , basename , "" , NULL ) \
1873 _TYPEINFO_CLASSES(name, NULL , NULL) \
1874 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1875 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1876 WX_CONSTRUCTOR_DUMMY( name )
1877
1878 #define IMPLEMENT_DYNAMIC_CLASS_XTI( name , basename , unit ) \
1879 _IMPLEMENT_DYNAMIC_CLASS( name , basename , unit , NULL ) \
1880 _TYPEINFO_CLASSES(name, NULL , NULL)
1881
1882 #define IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK( name , basename , unit , callback ) \
1883 _IMPLEMENT_DYNAMIC_CLASS( name , basename , unit , &callback ) \
1884 _TYPEINFO_CLASSES(name, NULL , NULL)
1885
1886 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY_XTI( name , basename , unit ) \
1887 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , unit , NULL ) \
1888 _TYPEINFO_CLASSES(name, NULL , NULL)
1889
1890 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY_AND_STREAMERS_XTI( name , basename , unit , toString , fromString ) \
1891 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , unit , NULL ) \
1892 _TYPEINFO_CLASSES(name, toString , fromString)
1893
1894 // this is for classes that do not derive from wxobject, there are no creators for these
1895
1896 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_NO_BASE_XTI( name , unit ) \
1897 const wxClassInfo* name::sm_classParents##name[] = { NULL } ; \
1898 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1899 (int) sizeof(name), \
1900 (wxObjectConstructorFn) 0 , \
1901 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1902 0 , 0 , 0 ); \
1903 _TYPEINFO_CLASSES(name, NULL , NULL)
1904
1905 // this is for subclasses that still do not derive from wxobject
1906
1907 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_XTI( name , basename, unit ) \
1908 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1909 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1910 (int) sizeof(name), \
1911 (wxObjectConstructorFn) 0 , \
1912 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1913 0 , 0 , 0 ); \
1914 _TYPEINFO_CLASSES(name, NULL , NULL)
1915
1916
1917 // Multiple inheritance with two base classes
1918
1919 #define _IMPLEMENT_DYNAMIC_CLASS2(name, basename, basename2, unit) \
1920 wxObject* wxConstructorFor##name() \
1921 { return new name; } \
1922 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,&basename2::sm_class##basename2 , NULL } ; \
1923 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1924 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1925 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1926 (int) sizeof(name), \
1927 (wxObjectConstructorFn) wxConstructorFor##name , \
1928 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1929 name::sm_constructorPropertiesCount##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1930
1931 #define IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2) \
1932 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , "") \
1933 _TYPEINFO_CLASSES(name, NULL , NULL) \
1934 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1935 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1936 WX_CONSTRUCTOR_DUMMY( name )
1937
1938 #define IMPLEMENT_DYNAMIC_CLASS2_XTI( name , basename , basename2, unit) \
1939 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , unit) \
1940 _TYPEINFO_CLASSES(name, NULL , NULL)
1941
1942
1943 // -----------------------------------
1944 // for abstract classes
1945 // -----------------------------------
1946
1947 // Single inheritance with one base class
1948
1949 #define _IMPLEMENT_ABSTRACT_CLASS(name, basename) \
1950 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1951 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1952 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1953 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1954 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1955 (int) sizeof(name), \
1956 (wxObjectConstructorFn) 0 , \
1957 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1958 0 , wxVariantOfPtrToObjectConverter##name ,wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1959 _TYPEINFO_CLASSES(name, NULL , NULL)
1960
1961 #define IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1962 _IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1963 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1964 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; }
1965
1966 // Multiple inheritance with two base classes
1967
1968 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
1969 wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1), \
1970 wxT(#basename2), (int) sizeof(name), \
1971 (wxObjectConstructorFn) 0);
1972
1973 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
1974 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
1975
1976 // --------------------------------------------------------------------------
1977 // Collection Support
1978 // --------------------------------------------------------------------------
1979
1980 template<typename iter , typename collection_t > void wxListCollectionToVariantArray( const collection_t& coll , wxxVariantArray &value )
1981 {
1982 iter current = coll.GetFirst() ;
1983 while (current)
1984 {
1985 value.Add( new wxxVariant(current->GetData()) ) ;
1986 current = current->GetNext();
1987 }
1988 }
1989
1990 template<typename collection_t> void wxArrayCollectionToVariantArray( const collection_t& coll , wxxVariantArray &value )
1991 {
1992 for( size_t i = 0 ; i < coll.GetCount() ; i++ )
1993 {
1994 value.Add( new wxxVariant(coll[i]) ) ;
1995 }
1996 }
1997
1998
1999 #endif