added interface headers with latest discussed changes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
42
interface/windowid.h
Normal file
42
interface/windowid.h
Normal file
@@ -0,0 +1,42 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: windowid.h
|
||||
// Purpose: documentation for wxIdManager class
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxIdManager
|
||||
@wxheader{windowid.h}
|
||||
|
||||
wxIdManager is responsible for allocating and releasing window IDs. It
|
||||
is used by wxWindow::NewControlId and
|
||||
wxWindow::UnreserveControlId, and can also
|
||||
be used be used directly.
|
||||
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref
|
||||
overview_windowidsoverview "Window IDs overview"
|
||||
*/
|
||||
class wxIdManager
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Called directly by wxWindow::NewControlId,
|
||||
this function will create a new ID or range of IDs. The IDs will be
|
||||
reserved until assigned to a wxWindowIDRef
|
||||
or unreserved with UnreserveControlId().
|
||||
Only ID values that are not assigned to a wxWindowIDRef
|
||||
need to be unreserved.
|
||||
|
||||
@param count
|
||||
The number of sequential IDs to reserve.
|
||||
|
||||
@returns The value of the first ID in the sequence, or wxID_NONE.
|
||||
*/
|
||||
static wxWindowID ReserveControlId(int count = 1);
|
||||
};
|
Reference in New Issue
Block a user