2001-10-09 18:50:33 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: wx/clntdata.h
|
|
|
|
// Purpose: A mixin class for holding a wxClientData or void pointer
|
|
|
|
// Author: Robin Dunn
|
|
|
|
// Modified by:
|
|
|
|
// Created: 9-Oct-2001
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) wxWindows team
|
|
|
|
// Licence: wxWindows licence
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_CLNTDATAH__
|
|
|
|
#define _WX_CLNTDATAH__
|
|
|
|
|
2002-08-31 07:29:13 -04:00
|
|
|
#if defined(__GNUG__) && !defined(__APPLE__)
|
2001-10-09 19:09:41 -04:00
|
|
|
#pragma interface "clntdata.h"
|
2001-10-09 18:50:33 -04:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#include "wx/defs.h"
|
2001-10-09 19:09:41 -04:00
|
|
|
#include "wx/string.h"
|
2001-10-09 18:50:33 -04:00
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// what kind of client data do we have?
|
|
|
|
enum wxClientDataType
|
|
|
|
{
|
|
|
|
wxClientData_None, // we don't know yet because we don't have it at all
|
|
|
|
wxClientData_Object, // our client data is typed and we own it
|
|
|
|
wxClientData_Void // client data is untyped and we don't own it
|
|
|
|
};
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxClientData
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxClientData() { }
|
|
|
|
virtual ~wxClientData() { }
|
|
|
|
};
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxStringClientData : public wxClientData
|
|
|
|
{
|
|
|
|
public:
|
2002-05-07 17:58:27 -04:00
|
|
|
wxStringClientData() : m_data() { }
|
2001-10-09 18:50:33 -04:00
|
|
|
wxStringClientData( const wxString &data ) : m_data(data) { }
|
|
|
|
void SetData( const wxString &data ) { m_data = data; }
|
|
|
|
const wxString& GetData() const { return m_data; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
wxString m_data;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2001-10-09 19:09:41 -04:00
|
|
|
|
|
|
|
// This class is a mixin that provides storage and management of "client
|
|
|
|
// data." The client data stored can either be a pointer to a wxClientData
|
|
|
|
// object in which case it is managed by the container (i.e. it will delete
|
|
|
|
// the data when it's destroyed) or an untyped pointer which won't be deleted
|
2001-10-20 23:56:07 -04:00
|
|
|
// by the container - but not both of them
|
|
|
|
//
|
|
|
|
// NOTE: This functionality is currently duplicated in wxEvtHandler in order
|
|
|
|
// to avoid having more than one vtable in that class heirachy.
|
2001-10-09 19:09:41 -04:00
|
|
|
|
2001-10-09 18:50:33 -04:00
|
|
|
class WXDLLEXPORT wxClientDataContainer
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxClientDataContainer();
|
2001-10-09 19:09:41 -04:00
|
|
|
virtual ~wxClientDataContainer();
|
2001-10-09 18:50:33 -04:00
|
|
|
|
|
|
|
void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
|
|
|
|
wxClientData *GetClientObject() const { return DoGetClientObject(); }
|
|
|
|
|
|
|
|
void SetClientData( void *data ) { DoSetClientData(data); }
|
|
|
|
void *GetClientData() const { return DoGetClientData(); }
|
|
|
|
|
|
|
|
protected:
|
2001-10-09 19:09:41 -04:00
|
|
|
// The user data: either an object which will be deleted by the container
|
|
|
|
// when it's deleted or some raw pointer which we do nothing with - only
|
|
|
|
// one type of data can be used with the given window (i.e. you cannot set
|
2001-10-11 23:18:35 -04:00
|
|
|
// the void data and then associate the container with wxClientData or vice
|
2001-10-09 19:09:41 -04:00
|
|
|
// versa)
|
2001-10-09 18:50:33 -04:00
|
|
|
union
|
|
|
|
{
|
|
|
|
wxClientData *m_clientObject;
|
|
|
|
void *m_clientData;
|
|
|
|
};
|
|
|
|
|
|
|
|
// client data accessors
|
|
|
|
virtual void DoSetClientObject( wxClientData *data );
|
|
|
|
virtual wxClientData *DoGetClientObject() const;
|
|
|
|
|
|
|
|
virtual void DoSetClientData( void *data );
|
|
|
|
virtual void *DoGetClientData() const;
|
|
|
|
|
|
|
|
// what kind of data do we have?
|
|
|
|
wxClientDataType m_clientDataType;
|
|
|
|
|
|
|
|
};
|
2001-10-20 23:56:07 -04:00
|
|
|
|
2002-12-08 13:43:45 -05:00
|
|
|
// not Motif-specific, but currently used only under Motif
|
|
|
|
#ifdef __WXMOTIF__
|
|
|
|
|
|
|
|
#include <wx/vector.h>
|
|
|
|
|
|
|
|
struct WXDLLEXPORT wxClientDataDictionaryPair
|
|
|
|
{
|
|
|
|
wxClientDataDictionaryPair( size_t idx ) : index( idx ), data( 0 ) { }
|
|
|
|
|
|
|
|
size_t index;
|
|
|
|
wxClientData* data;
|
|
|
|
};
|
|
|
|
|
|
|
|
WX_DECLARE_VECTOR(wxClientDataDictionaryPair,wxClientDataDictionaryPairVector);
|
|
|
|
|
|
|
|
// this class is used internally to maintain the association between items
|
|
|
|
// of (some subclasses of) wxControlWithItems and their client data
|
|
|
|
// NOTE: this class does not keep track if it contains
|
|
|
|
// wxClientData or void*, the client must ensure that
|
|
|
|
// it does not contain a mix of the two, and that
|
|
|
|
// DestroyData is called if it contains wxClientData
|
|
|
|
class WXDLLEXPORT wxClientDataDictionary
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxClientDataDictionary() {};
|
|
|
|
|
|
|
|
// deletes all the data
|
|
|
|
void DestroyData()
|
|
|
|
{
|
|
|
|
for( size_t i = 0, end = m_vec.size(); i != end; ++i )
|
|
|
|
delete m_vec[i].data;
|
|
|
|
m_vec.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
// if data for the given index is not present, add it,
|
|
|
|
// if it is present, delete the old data and replace it with
|
|
|
|
// the new one
|
|
|
|
void Set( size_t index, wxClientData* data, bool doDelete )
|
|
|
|
{
|
|
|
|
size_t ptr = Find( index );
|
|
|
|
|
|
|
|
if( !data )
|
|
|
|
{
|
|
|
|
if( ptr == m_vec.size() ) return;
|
|
|
|
if( doDelete )
|
|
|
|
delete m_vec[ptr].data;
|
|
|
|
m_vec.erase( ptr );
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
if( ptr == m_vec.size() )
|
|
|
|
{
|
|
|
|
m_vec.push_back( wxClientDataDictionaryPair( index ) );
|
|
|
|
ptr = m_vec.size() - 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
if( doDelete )
|
|
|
|
delete m_vec[ptr].data;
|
|
|
|
m_vec[ptr].data = data;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// get the data associated with the given index,
|
|
|
|
// return 0 if not found
|
|
|
|
wxClientData* Get( size_t index ) const
|
|
|
|
{
|
|
|
|
size_t it = Find( index );
|
|
|
|
if( it == m_vec.size() ) return 0;
|
|
|
|
return (wxClientData*)m_vec[it].data; // const cast
|
|
|
|
}
|
|
|
|
|
|
|
|
// delete the data associated with the given index
|
|
|
|
// it also decreases by one the indices of all the elements
|
|
|
|
// with an index greater than the given index
|
|
|
|
void Delete( size_t index, bool doDelete )
|
|
|
|
{
|
|
|
|
size_t todel = m_vec.size();
|
|
|
|
|
|
|
|
for( size_t i = 0, end = m_vec.size(); i != end; ++i )
|
|
|
|
{
|
|
|
|
if( m_vec[i].index == index )
|
|
|
|
todel = i;
|
|
|
|
else if( m_vec[i].index > index )
|
|
|
|
--(m_vec[i].index);
|
|
|
|
}
|
|
|
|
|
|
|
|
if( todel != m_vec.size() )
|
|
|
|
{
|
|
|
|
if( doDelete )
|
|
|
|
delete m_vec[todel].data;
|
|
|
|
m_vec.erase( todel );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
private:
|
|
|
|
// returns MyVec.size() if not found
|
|
|
|
size_t Find( size_t index ) const
|
|
|
|
{
|
|
|
|
for( size_t i = 0, end = m_vec.size(); i != end; ++i )
|
|
|
|
{
|
|
|
|
if( m_vec[i].index == index )
|
|
|
|
return i;
|
|
|
|
}
|
|
|
|
|
|
|
|
return m_vec.size();
|
|
|
|
}
|
|
|
|
|
|
|
|
wxClientDataDictionaryPairVector m_vec;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // __WXMOTIF__
|
|
|
|
|
2001-10-09 18:50:33 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#endif
|
|
|
|
|