wx.SharedClientDataContainer

This class is a replacement for wx.ClientDataContainer, and unlike wx.ClientDataContainer the wx.SharedClientDataContainer client data is copiable, so it can be copied when objects containing it are cloned.

Like wx.ClientDataContainer, wx.SharedClientDataContainer is a mixin that provides storage and management of “client data.”. The client data is reference counted and managed by the container. As the client data is a shared object, changing the client data used by any object changes it for all other objects, too.

Added in version 4.1/wxWidgets-3.1.7.

Note

If your class has a Clone function and needs to store client data, use wx.SharedClientDataContainer and not ClientDataContainer!

See also

wx.ClientDataContainer, ClientData

Class Hierarchy

Inheritance diagram for class SharedClientDataContainer:

Known Subclasses

wx.grid.GridCellAttr, wx.grid.GridCellEditor, wx.grid.GridCellRenderer

Methods Summary

GetClientData	Get the untyped client data.
GetClientObject	Get a pointer to the client data object.
SetClientData	Set the untyped client data.
SetClientObject	Set the client data object.

Properties Summary

ClientData	See GetClientData and SetClientData
ClientObject	See GetClientObject and SetClientObject

Class API

class wx.SharedClientDataContainer(object)

This class is a replacement for ClientDataContainer, and unlike ClientDataContainer the SharedClientDataContainer client data is copiable, so it can be copied when objects containing it are cloned.

Methods

GetClientData(self)

Get the untyped client data.

Return type:

Any

---

GetClientObject(self)

Get a pointer to the client data object.

Return type:

ClientData

---

SetClientData(self, data)

Set the untyped client data.

Parameters:

data

Return type:

None

---

SetClientObject(self, data)

Set the client data object.

Any previous object will be deleted.

Parameters:

data (ClientData)

Return type:

None

Properties

ClientData

See GetClientData and SetClientData

---

ClientObject

See GetClientObject and SetClientObject