]> git.saurik.com Git - wxWidgets.git/commitdiff
document standard IDs only in one place, not two; bring the list up to date
authorVáclav Slavík <vslavik@fastmail.fm>
Fri, 21 Mar 2008 14:20:26 +0000 (14:20 +0000)
committerVáclav Slavík <vslavik@fastmail.fm>
Fri, 21 Mar 2008 14:20:26 +0000 (14:20 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/doxygen/mainpages/const_stdevtid.h
docs/doxygen/overviews/eventhandling.h

index f90f957f10f8d67e7c30d55ca4bbedc7a4b01356..e22a3580abc79b99a8a478be2b86f9861d55e40f 100644 (file)
  the user code and also are sometimes used by wxWidgets itself. These reserved
  identifiers are all in the range between @c wxID_LOWEST and
  @c wxID_HIGHEST and, accordingly, the user code should avoid defining its
- own constants in this range.
+ own constants in this range (e.g. by using wxNewId()).
 
  @verbatim
-     wxID_LOWEST = 4999,
-
-     wxID_OPEN,
-     wxID_CLOSE,
-     wxID_NEW,
-     wxID_SAVE,
-     wxID_SAVEAS,
-     wxID_REVERT,
-     wxID_EXIT,
-     wxID_UNDO,
-     wxID_REDO,
-     wxID_HELP,
-     wxID_PRINT,
-     wxID_PRINT_SETUP,
-     wxID_PAGE_SETUP,
-     wxID_PREVIEW,
-     wxID_ABOUT,
-     wxID_HELP_CONTENTS,
-     wxID_HELP_INDEX,
-     wxID_HELP_SEARCH,
-     wxID_HELP_COMMANDS,
-     wxID_HELP_PROCEDURES,
-     wxID_HELP_CONTEXT,
-     wxID_CLOSE_ALL,
-
-     wxID_EDIT = 5030,
-     wxID_CUT,
-     wxID_COPY,
-     wxID_PASTE,
-     wxID_CLEAR,
-     wxID_FIND,
-     wxID_DUPLICATE,
-     wxID_SELECTALL,
-     wxID_DELETE,
-     wxID_REPLACE,
-     wxID_REPLACE_ALL,
-     wxID_PROPERTIES,
-
-     wxID_VIEW_DETAILS,
-     wxID_VIEW_LARGEICONS,
-     wxID_VIEW_SMALLICONS,
-     wxID_VIEW_LIST,
-     wxID_VIEW_SORTDATE,
-     wxID_VIEW_SORTNAME,
-     wxID_VIEW_SORTSIZE,
-     wxID_VIEW_SORTTYPE,
-
-     wxID_FILE = 5050,
-     wxID_FILE1,
-     wxID_FILE2,
-     wxID_FILE3,
-     wxID_FILE4,
-     wxID_FILE5,
-     wxID_FILE6,
-     wxID_FILE7,
-     wxID_FILE8,
-     wxID_FILE9,
-
-     // Standard button IDs
-     wxID_OK = 5100,
-     wxID_CANCEL,
-     wxID_APPLY,
-     wxID_YES,
-     wxID_NO,
-     wxID_STATIC,
-     wxID_FORWARD,
-     wxID_BACKWARD,
-     wxID_DEFAULT,
-     wxID_MORE,
-     wxID_SETUP,
-     wxID_RESET,
-     wxID_CONTEXT_HELP,
-     wxID_YESTOALL,
-     wxID_NOTOALL,
-     wxID_ABORT,
-     wxID_RETRY,
-     wxID_IGNORE,
-
-     wxID_UP,
-     wxID_DOWN,
-     wxID_HOME,
-     wxID_REFRESH,
-     wxID_STOP,
-     wxID_INDEX,
-
-     wxID_BOLD,
-     wxID_ITALIC,
-     wxID_JUSTIFY_CENTER,
-     wxID_JUSTIFY_FILL,
-     wxID_JUSTIFY_RIGHT,
-     wxID_JUSTIFY_LEFT,
-     wxID_UNDERLINE,
-     wxID_INDENT,
-     wxID_UNINDENT,
-     wxID_ZOOM_100,
-     wxID_ZOOM_FIT,
-     wxID_ZOOM_IN,
-     wxID_ZOOM_OUT,
-     wxID_UNDELETE,
-     wxID_REVERT_TO_SAVED,
-
-     // System menu IDs (used by wxUniv):
-     wxID_SYSTEM_MENU = 5200,
-     wxID_CLOSE_FRAME,
-     wxID_MOVE_FRAME,
-     wxID_RESIZE_FRAME,
-     wxID_MAXIMIZE_FRAME,
-     wxID_ICONIZE_FRAME,
-     wxID_RESTORE_FRAME,
-
-     // IDs used by generic file dialog (13 consecutive starting from this value)
-     wxID_FILEDLGG = 5900,
-
-     wxID_HIGHEST = 5999
+ wxID_LOWEST = 4999,
+
+ wxID_OPEN,
+ wxID_CLOSE,
+ wxID_NEW,
+ wxID_SAVE,
+ wxID_SAVEAS,
+ wxID_REVERT,
+ wxID_EXIT,
+ wxID_UNDO,
+ wxID_REDO,
+ wxID_HELP,
+ wxID_PRINT,
+ wxID_PRINT_SETUP,
+ wxID_PAGE_SETUP,
+ wxID_PREVIEW,
+ wxID_ABOUT,
+ wxID_HELP_CONTENTS,
+ wxID_HELP_INDEX,
+ wxID_HELP_SEARCH,
+ wxID_HELP_COMMANDS,
+ wxID_HELP_PROCEDURES,
+ wxID_HELP_CONTEXT,
+ wxID_CLOSE_ALL,
+ wxID_PREFERENCES,
+
+ wxID_EDIT = 5030,
+ wxID_CUT,
+ wxID_COPY,
+ wxID_PASTE,
+ wxID_CLEAR,
+ wxID_FIND,
+ wxID_DUPLICATE,
+ wxID_SELECTALL,
+ wxID_DELETE,
+ wxID_REPLACE,
+ wxID_REPLACE_ALL,
+ wxID_PROPERTIES,
+
+ wxID_VIEW_DETAILS,
+ wxID_VIEW_LARGEICONS,
+ wxID_VIEW_SMALLICONS,
+ wxID_VIEW_LIST,
+ wxID_VIEW_SORTDATE,
+ wxID_VIEW_SORTNAME,
+ wxID_VIEW_SORTSIZE,
+ wxID_VIEW_SORTTYPE,
+
+ wxID_FILE = 5050,
+ wxID_FILE1,
+ wxID_FILE2,
+ wxID_FILE3,
+ wxID_FILE4,
+ wxID_FILE5,
+ wxID_FILE6,
+ wxID_FILE7,
+ wxID_FILE8,
+ wxID_FILE9,
+
+ // Standard button and menu IDs
+ wxID_OK = 5100,
+ wxID_CANCEL,
+ wxID_APPLY,
+ wxID_YES,
+ wxID_NO,
+ wxID_STATIC,
+ wxID_FORWARD,
+ wxID_BACKWARD,
+ wxID_DEFAULT,
+ wxID_MORE,
+ wxID_SETUP,
+ wxID_RESET,
+ wxID_CONTEXT_HELP,
+ wxID_YESTOALL,
+ wxID_NOTOALL,
+ wxID_ABORT,
+ wxID_RETRY,
+ wxID_IGNORE,
+ wxID_ADD,
+ wxID_REMOVE,
+
+ wxID_UP,
+ wxID_DOWN,
+ wxID_HOME,
+ wxID_REFRESH,
+ wxID_STOP,
+ wxID_INDEX,
+
+ wxID_BOLD,
+ wxID_ITALIC,
+ wxID_JUSTIFY_CENTER,
+ wxID_JUSTIFY_FILL,
+ wxID_JUSTIFY_RIGHT,
+ wxID_JUSTIFY_LEFT,
+ wxID_UNDERLINE,
+ wxID_INDENT,
+ wxID_UNINDENT,
+ wxID_ZOOM_100,
+ wxID_ZOOM_FIT,
+ wxID_ZOOM_IN,
+ wxID_ZOOM_OUT,
+ wxID_UNDELETE,
+ wxID_REVERT_TO_SAVED,
+
+ // System menu IDs (used by wxUniv)
+ wxID_SYSTEM_MENU = 5200,
+ wxID_CLOSE_FRAME,
+ wxID_MOVE_FRAME,
+ wxID_RESIZE_FRAME,
+ wxID_MAXIMIZE_FRAME,
+ wxID_ICONIZE_FRAME,
+ wxID_RESTORE_FRAME,
+
+ // IDs used by generic file dialog (13 consecutive starting from this value)
+ wxID_FILEDLGG = 5900,
+
+ //  IDs used by generic file ctrl (4 consecutive starting from this value)
+ wxID_FILECTRL = 5950,
+
+ wxID_HIGHEST = 5999
  @endverbatim
 
 */
index ae1c0679513bb89bfce6780060f929273d8b6b04..68c2aa5f4564a71d6cfa1a1a0e25b717c80b2e5f 100644 (file)
  will never conflict with the user-specified identifiers which must be always
  positive.
 
- The following standard identifiers are supplied. You can use wxID_HIGHEST to
- determine the number above which it is safe to define your own identifiers. Or,
- you can use identifiers below wxID_LOWEST.
-
- @code
- #define wxID_ANY                -1
-
- #define wxID_LOWEST             4999
-
- #define wxID_OPEN               5000
- #define wxID_CLOSE              5001
- #define wxID_NEW                5002
- #define wxID_SAVE               5003
- #define wxID_SAVEAS             5004
- #define wxID_REVERT             5005
- #define wxID_EXIT               5006
- #define wxID_UNDO               5007
- #define wxID_REDO               5008
- #define wxID_HELP               5009
- #define wxID_PRINT              5010
- #define wxID_PRINT_SETUP        5011
- #define wxID_PREVIEW            5012
- #define wxID_ABOUT              5013
- #define wxID_HELP_CONTENTS      5014
- #define wxID_HELP_COMMANDS      5015
- #define wxID_HELP_PROCEDURES    5016
- #define wxID_HELP_CONTEXT       5017
-
- #define wxID_CUT                5030
- #define wxID_COPY               5031
- #define wxID_PASTE              5032
- #define wxID_CLEAR              5033
- #define wxID_FIND               5034
- #define wxID_DUPLICATE          5035
- #define wxID_SELECTALL          5036
- #define wxID_DELETE             5037
- #define wxID_REPLACE            5038
- #define wxID_REPLACE_ALL        5039
- #define wxID_PROPERTIES         5040
-
- #define wxID_VIEW_DETAILS       5041
- #define wxID_VIEW_LARGEICONS    5042
- #define wxID_VIEW_SMALLICONS    5043
- #define wxID_VIEW_LIST          5044
- #define wxID_VIEW_SORTDATE      5045
- #define wxID_VIEW_SORTNAME      5046
- #define wxID_VIEW_SORTSIZE      5047
- #define wxID_VIEW_SORTTYPE      5048
-
- #define wxID_FILE1              5050
- #define wxID_FILE2              5051
- #define wxID_FILE3              5052
- #define wxID_FILE4              5053
- #define wxID_FILE5              5054
- #define wxID_FILE6              5055
- #define wxID_FILE7              5056
- #define wxID_FILE8              5057
- #define wxID_FILE9              5058
-
- #define wxID_OK                 5100
- #define wxID_CANCEL             5101
- #define wxID_APPLY              5102
- #define wxID_YES                5103
- #define wxID_NO                 5104
- #define wxID_STATIC             5105
-
- #define wxID_HIGHEST            5999
- @endcode
-
+ See @ref page_stdevtid for the list of standard identifiers availabel.
+ You can use wxID_HIGHEST to determine the number above which it is safe to
+ define your own identifiers. Or, you can use identifiers below wxID_LOWEST.
+ Finally, you can allocate identifiers dynamically using wxNewId() function to.
+ If you use wxNewId() consistently in your application, you can be sure that
+ the your identifiers don't conflict accidentally.
 
 
  @section overview_eventhandling_custom Custom event summary