X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3863c5ebd92650ba88f29db4f5f8d794ec11bf80..c8c77ee2af68bcea8ba157b4d5a4e2cd5b4912bd:/docs/doxygen/overviews/windowids.h?ds=sidebyside diff --git a/docs/doxygen/overviews/windowids.h b/docs/doxygen/overviews/windowids.h index a513b8bf3e..7bfc294d06 100644 --- a/docs/doxygen/overviews/windowids.h +++ b/docs/doxygen/overviews/windowids.h @@ -3,18 +3,18 @@ // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -/*! +/** -@page overview_windowids Window IDs Overview +@page overview_windowids Window IDs @li @ref overview_windowids_intro @li @ref overview_windowids_type @li @ref overview_windowids_using -@seealso +@see @li wxIdManager @li wxWindow::NewControlId @@ -26,17 +26,17 @@ @section overview_windowids_intro Introduction -Various contols and other parts of wxWidgets need an ID. Sometimes the ID may -be directly provided by the use or have a predefined value, such as +Various controls and other parts of wxWidgets need an ID. Sometimes the ID may +be directly provided by the user or have a predefined value, such as @c wxID_OPEN. Often, however, the value of the ID is unimportant and is created automatically by calling wxWindow::NewControlId or by passing @c wxID_ANY as the ID of an object. -There are two ways to generate an ID. One way, is to start at a negative +There are two ways to generate an ID. One way is to start at a negative number, and for each new ID, return the next smallest number. This is fine for -systems that can used the full range of negative numbers for an ID, as this +systems that can use the full range of negative numbers for IDs, as this provides more than enough IDs and it would take a very very long time to run -out and wrap around. However, some systems can not use the full range of the +out and wrap around. However, some systems cannot use the full range of the ID value. Windows, for example, can only use 16 bit IDs, and only has about 32000 possible automatic IDs that can be generated by wxWindow::NewControlId. If the program runs long enough, depending on the program itself, using this @@ -70,8 +70,8 @@ it is assigned to a wxWindowIDRef, then it will be unreserved automatically and will be considered free when the count is 0, and should NOT be manually unreserved. -wxWindowIDRef can store both automatic IDs from wxWindow::NewControlId as well -as normal IDs. Reference counting is only done for the automatic IDs. Also, +wxWindowIDRef can store both automatic IDs from wxWindow::NewControlId and +normal IDs. Reference counting is only done for the automatic IDs. Also, wxWindowIDRef has conversion operators that allow it to be treated just like a wxWindowID.