wx.IdManager

wx.IdManager is responsible for allocating and releasing window IDs.

It is used by wx.Window.NewControlId and wx.Window.UnreserveControlId , and can also be used be used directly.

See also

wx.Window.NewControlId , wx.Window.UnreserveControlId , Window IDs

Class Hierarchy

Inheritance diagram for class IdManager:

Methods Summary

ReserveId	Called directly by wx.Window.NewControlId , this function will create a new ID or range of IDs.
UnreserveId	Called directly by wx.Window.UnreserveControlId , this function will unreserve an ID or range of IDs that is currently reserved.

Class API

class wx.IdManager(object)

IdManager is responsible for allocating and releasing window IDs.

Methods

static ReserveId(count=1)

Called directly by wx.Window.NewControlId , this function will create a new ID or range of IDs.

The IDs will be reserved until assigned to a WindowIDRef() or unreserved with UnreserveControlId(). Only ID values that are not assigned to a WindowIDRef() need to be unreserved.

Parameters:

count (int) – The number of sequential IDs to reserve.

Return type:

int

Returns:

The value of the first ID in the sequence, or wx.ID_NONE.

---

static UnreserveId(id, count=1)

Called directly by wx.Window.UnreserveControlId , this function will unreserve an ID or range of IDs that is currently reserved.

This should only be called for IDs returned by ReserveControlId() that have NOT been assigned to a WindowIDRef (see Window IDs).

Parameters:

• id (wx.WindowID) – The first of the range of IDs to unreserve.

• count (int) – The number of sequential IDs to unreserve.

Return type:

None