wxPython/src/_defs.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _defs.i
   3 // Purpose:     Definitions and stuff
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     6/24/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 //---------------------------------------------------------------------------
  15
  16 // Globally turn on the autodoc feature
  17 %feature("autodoc", "1");  // 0 == no param types, 1 == show param types
  18
  19 // Turn on kwargs by default
  20 %feature("kwargs", "1");
  21
  22 // Don't generate separate wrappers for each default args combination
  23 %feature("compactdefaultargs");
  24
  25 #if SWIG_VERSION < 0x010328
  26 // Don't generate default ctors or dtors if the C++ doesn't have them
  27 %feature("nodefault");
  28 #else
  29 // This is the SWIG 1.3.28 way to do the above...
  30 %feature("nodefaultctor");
  31 %feature("nodefaultdtor");
  32 #endif
  33
  34 // For now, just supress the warning about using Python keywords as parameter
  35 // names.  Will need to come back later and correct these rather than just
  36 // hide them...
  37 #pragma SWIG nowarn=314
  38
  39 //---------------------------------------------------------------------------
  40
  41 // Tell SWIG to wrap all the wrappers with our thread protection
  42 %define %threadWrapperOn
  43 %exception {
  44     PyThreadState* __tstate = wxPyBeginAllowThreads();
  45     $action
  46     wxPyEndAllowThreads(__tstate);
  47     if (PyErr_Occurred()) SWIG_fail;
  48 }
  49 %enddef
  50
  51 // This one will turn off the generation of the thread wrapper code
  52 %define %threadWrapperOff
  53 %exception
  54 %enddef
  55
  56 // Turn it on by default
  57 %threadWrapperOn
  58
  59 // This one can be used to add a check for an existing wxApp before the real
  60 // work is done.  An exception is raised if there isn't one.
  61 %define MustHaveApp(name)
  62 %exception name {
  63     if (!wxPyCheckForApp()) SWIG_fail;
  64     PyThreadState* __tstate = wxPyBeginAllowThreads();
  65     $action
  66     wxPyEndAllowThreads(__tstate);
  67     if (PyErr_Occurred()) SWIG_fail;
  68 }
  69 %enddef
  70
  71
  72
  73 //---------------------------------------------------------------------------
  74 // some type definitions to simplify things for SWIG
  75
  76 typedef int             wxEventType;
  77 typedef unsigned int    size_t;
  78 typedef unsigned int    time_t;
  79 typedef unsigned char   byte;
  80 typedef unsigned long   wxUIntPtr;
  81
  82 #define wxWindowID      int
  83 #define wxCoord         int
  84 #define wxInt32         int
  85 #define wxUint32        unsigned int
  86
  87
  88 //----------------------------------------------------------------------
  89 // Various SWIG macros and such
  90
  91 #define %pythonAppend   %feature("pythonappend")
  92 #define %pythonPrepend  %feature("pythonprepend")
  93 #define %noautodoc      %feature("noautodoc")
  94
  95 #if SWIG_VERSION >= 0x010327
  96 #define %kwargs         %feature("kwargs", "1")
  97 #define %nokwargs       %feature("kwargs", "0")
  98 #else
  99 #define %kwargs         %feature("kwargs")
 100 #define %nokwargs       %feature("nokwargs")
 101 #endif
 102
 103 #define %disownarg(typespec)   %typemap(in) typespec = SWIGTYPE* DISOWN
 104 #define %cleardisown(typespec) %typemap(in) typespec
 105
 106
 107
 108 #ifndef %pythoncode
 109 #define %pythoncode     %insert("python")
 110 #endif
 111
 112 #define WXUNUSED(x)     x
 113
 114
 115 // Given the name of a wxChar (or wxString) constant in C++, make
 116 // a static wxString for wxPython, and also let SWIG wrap it.
 117 %define MAKE_CONST_WXSTRING(strname)
 118     %{ static const wxString wxPy##strname(wx##strname); %}
 119     %immutable;
 120     %rename(strname) wxPy##strname;
 121     const wxString wxPy##strname;
 122     %mutable;
 123 %enddef
 124
 125 %define MAKE_CONST_WXSTRING2(strname, val)
 126     %{ static const wxString wxPy##strname(val); %}
 127     %immutable;
 128     %rename(strname) wxPy##strname;
 129     const wxString wxPy##strname;
 130     %mutable;
 131 %enddef
 132
 133 %define MAKE_CONST_WXSTRING_NOSWIG(strname)
 134     %{ static const wxString wxPy##strname(wx##strname); %}
 135 %enddef
 136
 137 // Generate code in the module init for the event types, since they may not be
 138 // initialized yet when they are used in the static swig_const_table.
 139 %typemap(consttab) wxEventType; // TODO: how to prevent code inserted into the consttab?
 140 %typemap(constcode) wxEventType "PyDict_SetItemString(d, \"$symname\", PyInt_FromLong($value));";
 141
 142
 143
 144 //----------------------------------------------------------------------
 145 // Macros for the docstring and autodoc features of SWIG.  These will
 146 // help make the code look more readable, and pretty, as well as help
 147 // reduce typing in some cases.
 148
 149 // Set the docsring for the given full or partial declaration
 150 #ifdef _DO_FULL_DOCS
 151     %define DocStr(decl, docstr, details)
 152         %feature("docstring") decl docstr details;
 153     %enddef
 154 #else
 155     %define DocStr(decl, docstr, details)
 156         %feature("docstring") decl docstr;
 157     %enddef
 158 #endif
 159
 160
 161 // Set the autodoc string for a full or partial declaration
 162 %define DocA(decl, astr)
 163     %feature("autodoc") decl astr;
 164 %enddef
 165
 166
 167 // Set both the autodoc and docstring for a full or partial declaration
 168 #ifdef _DO_FULL_DOCS
 169     %define DocAStr(decl, astr, docstr, details)
 170         %feature("autodoc") decl astr;
 171         %feature("docstring") decl docstr details
 172     %enddef
 173 #else
 174     %define DocAStr(decl, astr, docstr, details)
 175         %feature("autodoc") decl astr;
 176         %feature("docstring") decl docstr
 177     %enddef
 178 #endif
 179
 180
 181
 182
 183 // Set the docstring for a decl and then define the decl too.  Must use the
 184 // full declaration of the item.
 185 #ifdef _DO_FULL_DOCS
 186     %define DocDeclStr(type, decl, docstr, details)
 187         %feature("docstring") decl docstr details;
 188         type decl
 189     %enddef
 190 #else
 191     %define DocDeclStr(type, decl, docstr, details)
 192         %feature("docstring") decl docstr;
 193         type decl
 194     %enddef
 195 #endif
 196
 197
 198
 199 // As above, but also give the decl a new %name
 200 #ifdef _DO_FULL_DOCS
 201     %define DocDeclStrName(type, decl, docstr, details, newname)
 202         %feature("docstring") decl docstr details;
 203         %rename(newname) decl;
 204         type decl
 205     %enddef
 206 #else
 207     %define DocDeclStrName(type, decl, docstr, details, newname)
 208         %feature("docstring") decl docstr;
 209         %rename(newname) decl;
 210         type decl
 211     %enddef
 212 #endif
 213
 214
 215 // Set the autodoc string for a decl and then define the decl too.  Must use the
 216 // full declaration of the item.
 217 %define DocDeclA(type, decl, astr)
 218     %feature("autodoc") decl astr;
 219     type decl
 220 %enddef
 221
 222 // As above, but also give the decl a new %name
 223 %define DocDeclAName(type, decl, astr, newname)
 224     %feature("autodoc") decl astr;
 225     %rename(newname) decl;
 226     type decl
 227 %enddef
 228
 229
 230
 231 // Set the autodoc and the docstring for a decl and then define the decl too.
 232 // Must use the full declaration of the item.
 233 #ifdef _DO_FULL_DOCS
 234     %define DocDeclAStr(type, decl, astr, docstr, details)
 235         %feature("autodoc") decl astr;
 236         %feature("docstring") decl docstr details;
 237         type decl
 238     %enddef
 239 #else
 240     %define DocDeclAStr(type, decl, astr, docstr, details)
 241         %feature("autodoc") decl astr;
 242         %feature("docstring") decl docstr;
 243         type decl
 244     %enddef
 245 #endif
 246
 247
 248 // As above, but also give the decl a new %name
 249 #ifdef _DO_FULL_DOCS
 250     %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
 251         %feature("autodoc") decl astr;
 252         %feature("docstring") decl docstr details;
 253         %rename(newname) decl;
 254         type decl
 255     %enddef
 256 #else
 257     %define DocDeclAStrName(type, decl, astr, docstr, details, newname)
 258         %feature("autodoc") decl astr;
 259         %feature("docstring") decl docstr;
 260         %rename(newname) decl;
 261         type decl
 262     %enddef
 263 #endif
 264
 265
 266
 267 // Set the docstring for a constructor decl and then define the decl too.
 268 // Must use the full declaration of the item.
 269 #ifdef _DO_FULL_DOCS
 270     %define DocCtorStr(decl, docstr, details)
 271         %feature("docstring") decl docstr details;
 272         decl
 273     %enddef
 274 #else
 275     %define DocCtorStr(decl, docstr, details)
 276         %feature("docstring") decl docstr;
 277         decl
 278     %enddef
 279 #endif
 280
 281
 282 // As above, but also give the decl a new %name
 283 #ifdef _DO_FULL_DOCS
 284     %define DocCtorStrName(decl, docstr, details, newname)
 285         %feature("docstring") decl docstr details;
 286         %rename(newname) decl;
 287         decl
 288     %enddef
 289 #else
 290     %define DocCtorStrName(decl, docstr, details, newname)
 291         %feature("docstring") decl docstr;
 292         %rename(newname) decl;
 293         decl
 294     %enddef
 295 #endif
 296
 297
 298 // Set the autodoc string for a constructor decl and then define the decl too.
 299 // Must use the full declaration of the item.
 300 %define DocCtorA(decl, astr)
 301     %feature("autodoc") decl astr;
 302     decl
 303 %enddef
 304
 305 // As above, but also give the decl a new %name
 306 %define DocCtorAName(decl, astr, newname)
 307     %feature("autodoc") decl astr;
 308     %rename(newname) decl;
 309     decl
 310 %enddef
 311
 312
 313
 314 // Set the autodoc and the docstring for a constructor decl and then define
 315 // the decl too.  Must use the full declaration of the item.
 316 #ifdef _DO_FULL_DOCS
 317     %define DocCtorAStr(decl, astr, docstr, details)
 318         %feature("autodoc") decl astr;
 319         %feature("docstring") decl docstr details;
 320         decl
 321     %enddef
 322 #else
 323     %define DocCtorAStr(decl, astr, docstr, details)
 324         %feature("autodoc") decl astr;
 325         %feature("docstring") decl docstr;
 326         decl
 327     %enddef
 328 #endif
 329
 330
 331
 332 // As above, but also give the decl a new %name
 333 #ifdef _DO_FULL_DOCS
 334     %define DocCtorAStrName(decl, astr, docstr, details, newname)
 335         %feature("autodoc") decl astr;
 336         %feature("docstring") decl docstr details;
 337         %rename(newname) decl;
 338         decl
 339     %enddef
 340 #else
 341     %define DocCtorAStrName(decl, astr, docstr, details, newname)
 342         %feature("autodoc") decl astr;
 343         %feature("docstring") decl docstr;
 344         %rename(newname) decl;
 345         decl
 346     %enddef
 347 #endif
 348
 349
 350
 351 %define %newgroup
 352 %pythoncode {
 353 %#---------------------------------------------------------------------------
 354 }
 355 %enddef
 356
 357
 358 // A set of macros to make using %rename easier, since %name has been
 359 // deprecated...
 360 %define %Rename(newname, type, decl)
 361     %rename(newname) decl;
 362     type decl
 363 %enddef
 364
 365 %define %RenameCtor(newname, decl)
 366     %rename(newname) decl;
 367     decl
 368 %enddef
 369
 370 #ifdef _DO_FULL_DOCS
 371     %define %RenameDocCtor(newname, docstr, details, decl)
 372         %feature("docstring") decl docstr details;
 373         %rename(newname) decl;
 374         decl
 375     %enddef
 376 #else
 377     %define %RenameDocCtor(newname, docstr, details, decl)
 378         %feature("docstring") decl docstr;
 379         %rename(newname) decl;
 380         decl
 381     %enddef
 382 #endif
 383
 384
 385 //---------------------------------------------------------------------------
 386 // Generates a base_On* method that just wraps a call to the On*, and mark it
 387 // deprecated.  We need this because there is no longer any need for a
 388 // base_On* method to be able to call the C++ base class method, since our
 389 // virtualization code can now sense when an attempt is being made to call
 390 // the base class version from the derived class override.
 391
 392 %define %MAKE_BASE_FUNC(Class, Method)
 393     %pythoncode {
 394         def base_##Method(*args, **kw):
 395             return Class.Method(*args, **kw)
 396         base_##Method = wx._deprecated(base_##Method,
 397                                        "Please use Class.Method instead.")
 398     }
 399 %enddef
 400
 401 //---------------------------------------------------------------------------
 402 // Forward declarations and %renames for some classes, so the autodoc strings
 403 // will be able to use the right types even when the real class declaration is
 404 // not in the module being processed or seen by %import's.
 405
 406 #ifdef BUILDING_RENAMERS
 407     #define FORWARD_DECLARE(wxName, Name)
 408 #else
 409     %define FORWARD_DECLARE(wxName, Name)
 410         %rename(Name) wxName;
 411         class wxName;
 412     %enddef
 413 #endif
 414
 415 FORWARD_DECLARE(wxString,         String);
 416 FORWARD_DECLARE(wxBitmap,         Bitmap);
 417 FORWARD_DECLARE(wxDateTime,       DateTime);
 418 FORWARD_DECLARE(wxInputStream,    InputStream);
 419 FORWARD_DECLARE(wxDC,             DC);
 420 FORWARD_DECLARE(wxCursor,         Cursor);
 421 FORWARD_DECLARE(wxRegion,         Region);
 422 FORWARD_DECLARE(wxColour,         Colour);
 423 FORWARD_DECLARE(wxFont,           Font);
 424 FORWARD_DECLARE(wxCaret,          Caret);
 425 FORWARD_DECLARE(wxToolTip,        ToolTip);
 426 FORWARD_DECLARE(wxPyDropTarget,   DropTarget);
 427 FORWARD_DECLARE(wxImageList,      ImageList);
 428 FORWARD_DECLARE(wxMemoryDC,       MemoryDC);
 429 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
 430 FORWARD_DECLARE(wxConfigBase,     ConfigBase);
 431 FORWARD_DECLARE(wxIcon,           Icon);
 432 FORWARD_DECLARE(wxStaticBox,      StaticBox);
 433
 434
 435 //---------------------------------------------------------------------------
 436
 437 %{
 438 #if !WXWIN_COMPATIBILITY_2_4
 439     #define wxHIDE_READONLY  0
 440 #endif
 441 %}
 442
 443
 444 // General numeric #define's and etc.  Making them all enums makes SWIG use the
 445 // real macro when making the Python Int
 446
 447 enum {
 448 //     wxMAJOR_VERSION,
 449 //     wxMINOR_VERSION,
 450 //     wxRELEASE_NUMBER,
 451
 452     wxNOT_FOUND,
 453
 454     wxVSCROLL,
 455     wxHSCROLL,
 456     wxCAPTION,
 457     wxDOUBLE_BORDER,
 458     wxSUNKEN_BORDER,
 459     wxRAISED_BORDER,
 460     wxBORDER,
 461     wxSIMPLE_BORDER,
 462     wxSTATIC_BORDER,
 463     wxTRANSPARENT_WINDOW,
 464     wxNO_BORDER,
 465     wxDEFAULT_CONTROL_BORDER,
 466     wxDEFAULT_STATUSBAR_STYLE,
 467
 468     wxTAB_TRAVERSAL,
 469     wxWANTS_CHARS,
 470     wxPOPUP_WINDOW,
 471     wxCENTER_FRAME,
 472     wxCENTRE_ON_SCREEN,
 473     wxCENTER_ON_SCREEN,
 474
 475     wxCLIP_CHILDREN,
 476     wxCLIP_SIBLINGS,
 477
 478     wxALWAYS_SHOW_SB,
 479
 480     wxRETAINED,
 481     wxBACKINGSTORE,
 482
 483     wxCOLOURED,
 484     wxFIXED_LENGTH,
 485
 486     wxLB_NEEDED_SB,
 487     wxLB_ALWAYS_SB,
 488     wxLB_SORT,
 489     wxLB_SINGLE,
 490     wxLB_MULTIPLE,
 491     wxLB_EXTENDED,
 492     wxLB_OWNERDRAW,
 493     wxLB_HSCROLL,
 494     wxPROCESS_ENTER,
 495     wxPASSWORD,
 496
 497     wxCB_SIMPLE,
 498     wxCB_DROPDOWN,
 499     wxCB_SORT,
 500     wxCB_READONLY,
 501     wxRA_HORIZONTAL,
 502     wxRA_VERTICAL,
 503     wxRA_SPECIFY_ROWS,
 504     wxRA_SPECIFY_COLS,
 505     wxRA_USE_CHECKBOX,
 506     wxRB_GROUP,
 507     wxRB_SINGLE,
 508     wxSB_HORIZONTAL,
 509     wxSB_VERTICAL,
 510     wxRB_USE_CHECKBOX,
 511     wxST_SIZEGRIP,
 512     wxST_NO_AUTORESIZE,
 513
 514     wxFLOOD_SURFACE,
 515     wxFLOOD_BORDER,
 516     wxODDEVEN_RULE,
 517     wxWINDING_RULE,
 518     wxTOOL_TOP,
 519     wxTOOL_BOTTOM,
 520     wxTOOL_LEFT,
 521     wxTOOL_RIGHT,
 522     wxOK,
 523     wxYES_NO,
 524     wxCANCEL,
 525     wxYES,
 526     wxNO,
 527     wxNO_DEFAULT,
 528     wxYES_DEFAULT,
 529     wxICON_EXCLAMATION,
 530     wxICON_HAND,
 531     wxICON_QUESTION,
 532     wxICON_INFORMATION,
 533     wxICON_STOP,
 534     wxICON_ASTERISK,
 535     wxICON_MASK,
 536     wxICON_WARNING,
 537     wxICON_ERROR,
 538
 539     wxFORWARD,
 540     wxBACKWARD,
 541     wxRESET,
 542     wxHELP,
 543     wxMORE,
 544     wxSETUP,
 545
 546
 547     wxSIZE_AUTO_WIDTH,
 548     wxSIZE_AUTO_HEIGHT,
 549     wxSIZE_AUTO,
 550     wxSIZE_USE_EXISTING,
 551     wxSIZE_ALLOW_MINUS_ONE,
 552     wxSIZE_FORCE,
 553     wxPORTRAIT,
 554     wxLANDSCAPE,
 555     wxPRINT_QUALITY_HIGH,
 556     wxPRINT_QUALITY_MEDIUM,
 557     wxPRINT_QUALITY_LOW,
 558     wxPRINT_QUALITY_DRAFT,
 559
 560     wxID_ANY,
 561     wxID_SEPARATOR,
 562     wxID_NONE,
 563
 564     wxID_LOWEST,
 565     wxID_OPEN,
 566     wxID_CLOSE,
 567     wxID_NEW,
 568     wxID_SAVE,
 569     wxID_SAVEAS,
 570     wxID_REVERT,
 571     wxID_EXIT,
 572     wxID_UNDO,
 573     wxID_REDO,
 574     wxID_HELP,
 575     wxID_PRINT,
 576     wxID_PRINT_SETUP,
 577     wxID_PREVIEW,
 578     wxID_ABOUT,
 579     wxID_HELP_CONTENTS,
 580     wxID_HELP_COMMANDS,
 581     wxID_HELP_PROCEDURES,
 582     wxID_HELP_CONTEXT,
 583     wxID_CLOSE_ALL,
 584     wxID_PREFERENCES,
 585
 586     wxID_CUT,
 587     wxID_COPY,
 588     wxID_PASTE,
 589     wxID_CLEAR,
 590     wxID_FIND,
 591     wxID_DUPLICATE,
 592     wxID_SELECTALL,
 593
 594     wxID_DELETE,
 595     wxID_REPLACE,
 596     wxID_REPLACE_ALL,
 597     wxID_PROPERTIES,
 598
 599     wxID_VIEW_DETAILS,
 600     wxID_VIEW_LARGEICONS,
 601     wxID_VIEW_SMALLICONS,
 602     wxID_VIEW_LIST,
 603     wxID_VIEW_SORTDATE,
 604     wxID_VIEW_SORTNAME,
 605     wxID_VIEW_SORTSIZE,
 606     wxID_VIEW_SORTTYPE,
 607
 608     wxID_FILE1,
 609     wxID_FILE2,
 610     wxID_FILE3,
 611     wxID_FILE4,
 612     wxID_FILE5,
 613     wxID_FILE6,
 614     wxID_FILE7,
 615     wxID_FILE8,
 616     wxID_FILE9,
 617
 618     wxID_OK,
 619     wxID_CANCEL,
 620     wxID_APPLY,
 621     wxID_YES,
 622     wxID_NO,
 623     wxID_STATIC,
 624     wxID_FORWARD,
 625     wxID_BACKWARD,
 626     wxID_DEFAULT,
 627     wxID_MORE,
 628     wxID_SETUP,
 629     wxID_RESET,
 630     wxID_CONTEXT_HELP,
 631     wxID_YESTOALL,
 632     wxID_NOTOALL,
 633     wxID_ABORT,
 634     wxID_RETRY,
 635     wxID_IGNORE,
 636
 637     wxID_ADD,
 638     wxID_REMOVE,
 639
 640     wxID_UP,
 641     wxID_DOWN,
 642     wxID_HOME,
 643     wxID_REFRESH,
 644     wxID_STOP,
 645     wxID_INDEX,
 646
 647     wxID_BOLD,
 648     wxID_ITALIC,
 649     wxID_JUSTIFY_CENTER,
 650     wxID_JUSTIFY_FILL,
 651     wxID_JUSTIFY_RIGHT,
 652     wxID_JUSTIFY_LEFT,
 653     wxID_UNDERLINE,
 654     wxID_INDENT,
 655     wxID_UNINDENT,
 656     wxID_ZOOM_100,
 657     wxID_ZOOM_FIT,
 658     wxID_ZOOM_IN,
 659     wxID_ZOOM_OUT,
 660     wxID_UNDELETE,
 661     wxID_REVERT_TO_SAVED,
 662
 663     wxID_HIGHEST,
 664
 665     wxOPEN,
 666     wxSAVE,
 667     wxHIDE_READONLY,
 668     wxOVERWRITE_PROMPT,
 669     wxFILE_MUST_EXIST,
 670     wxMULTIPLE,
 671     wxCHANGE_DIR,
 672
 673     wxACCEL_ALT,
 674     wxACCEL_CTRL,
 675     wxACCEL_SHIFT,
 676     wxACCEL_NORMAL,
 677
 678     wxPD_AUTO_HIDE,
 679     wxPD_APP_MODAL,
 680     wxPD_CAN_ABORT,
 681     wxPD_ELAPSED_TIME,
 682     wxPD_ESTIMATED_TIME,
 683     wxPD_REMAINING_TIME,
 684     wxPD_SMOOTH,
 685     wxPD_CAN_SKIP,
 686
 687     wxDD_NEW_DIR_BUTTON,
 688     wxDD_DEFAULT_STYLE,
 689
 690     wxMENU_TEAROFF,
 691     wxMB_DOCKABLE,
 692     wxNO_FULL_REPAINT_ON_RESIZE,
 693     wxFULL_REPAINT_ON_RESIZE,
 694
 695     wxLI_HORIZONTAL,
 696     wxLI_VERTICAL,
 697
 698     wxWS_EX_VALIDATE_RECURSIVELY,
 699     wxWS_EX_BLOCK_EVENTS,
 700     wxWS_EX_TRANSIENT,
 701
 702     wxWS_EX_THEMED_BACKGROUND,
 703     wxWS_EX_PROCESS_IDLE,
 704     wxWS_EX_PROCESS_UI_UPDATES,
 705
 706
 707     // Mapping modes (as per Windows)
 708     wxMM_TEXT,
 709     wxMM_LOMETRIC,
 710     wxMM_HIMETRIC,
 711     wxMM_LOENGLISH,
 712     wxMM_HIENGLISH,
 713     wxMM_TWIPS,
 714     wxMM_ISOTROPIC,
 715     wxMM_ANISOTROPIC,
 716     wxMM_POINTS,
 717     wxMM_METRIC,
 718
 719
 720     // It looks like wxTabCtrl may rise from the dead.  Uncomment these if
 721     // it gets an implementation for all platforms...
 722 //     wxTC_RIGHTJUSTIFY,
 723 //     wxTC_FIXEDWIDTH,
 724 //     wxTC_TOP,
 725 //     wxTC_LEFT,
 726 //     wxTC_RIGHT,
 727 //     wxTC_BOTTOM,
 728 //     wxTC_MULTILINE,
 729 //     wxTC_OWNERDRAW,
 730
 731 };
 732
 733
 734
 735 enum wxGeometryCentre
 736 {
 737     wxCENTRE                  = 0x0001,
 738     wxCENTER                  = wxCENTRE
 739 };
 740
 741
 742 enum wxOrientation
 743 {
 744     wxHORIZONTAL,
 745     wxVERTICAL,
 746     wxBOTH
 747 };
 748
 749 enum wxDirection
 750 {
 751     wxLEFT,
 752     wxRIGHT,
 753     wxUP,
 754     wxDOWN,
 755
 756     wxTOP,
 757     wxBOTTOM,
 758
 759     wxNORTH,
 760     wxSOUTH,
 761     wxWEST,
 762     wxEAST,
 763
 764     wxALL
 765 };
 766
 767 enum wxAlignment
 768 {
 769     wxALIGN_NOT,
 770     wxALIGN_CENTER_HORIZONTAL,
 771     wxALIGN_CENTRE_HORIZONTAL,
 772     wxALIGN_LEFT,
 773     wxALIGN_TOP,
 774     wxALIGN_RIGHT,
 775     wxALIGN_BOTTOM,
 776     wxALIGN_CENTER_VERTICAL,
 777     wxALIGN_CENTRE_VERTICAL,
 778
 779     wxALIGN_CENTER,
 780     wxALIGN_CENTRE,
 781
 782     wxALIGN_MASK,
 783 };
 784
 785 enum wxStretch
 786 {
 787     wxSTRETCH_NOT,
 788     wxSHRINK,
 789     wxGROW,
 790     wxEXPAND,
 791     wxSHAPED,
 792     wxFIXED_MINSIZE,
 793     wxTILE,
 794     wxADJUST_MINSIZE,
 795 };
 796
 797
 798 enum wxBorder
 799 {
 800     wxBORDER_DEFAULT,
 801     wxBORDER_NONE,
 802     wxBORDER_STATIC,
 803     wxBORDER_SIMPLE,
 804     wxBORDER_RAISED,
 805     wxBORDER_SUNKEN,
 806     wxBORDER_DOUBLE,
 807     wxBORDER_MASK,
 808 };
 809
 810
 811 enum wxBackgroundStyle
 812 {
 813   wxBG_STYLE_SYSTEM,
 814   wxBG_STYLE_COLOUR,
 815   wxBG_STYLE_CUSTOM
 816 };
 817
 818
 819 enum {
 820   wxDEFAULT ,
 821   wxDECORATIVE,
 822   wxROMAN,
 823   wxSCRIPT,
 824   wxSWISS,
 825   wxMODERN,
 826   wxTELETYPE,
 827   wxVARIABLE,
 828   wxFIXED,
 829   wxNORMAL,
 830   wxLIGHT,
 831   wxBOLD,
 832   wxITALIC,
 833   wxSLANT,
 834   wxSOLID,
 835   wxDOT,
 836   wxLONG_DASH,
 837   wxSHORT_DASH,
 838   wxDOT_DASH,
 839   wxUSER_DASH,
 840   wxTRANSPARENT,
 841   wxSTIPPLE,
 842   wxSTIPPLE_MASK,
 843   wxSTIPPLE_MASK_OPAQUE,
 844   wxBDIAGONAL_HATCH,
 845   wxCROSSDIAG_HATCH,
 846   wxFDIAGONAL_HATCH,
 847   wxCROSS_HATCH,
 848   wxHORIZONTAL_HATCH,
 849   wxVERTICAL_HATCH,
 850   wxJOIN_BEVEL,
 851   wxJOIN_MITER,
 852   wxJOIN_ROUND,
 853   wxCAP_ROUND,
 854   wxCAP_PROJECTING,
 855   wxCAP_BUTT
 856 };
 857
 858 typedef enum {
 859   wxCLEAR,      // 0
 860   wxXOR,        // src XOR dst
 861   wxINVERT,     // NOT dst
 862   wxOR_REVERSE, // src OR (NOT dst)
 863   wxAND_REVERSE,// src AND (NOT dst)
 864   wxCOPY,       // src
 865   wxAND,        // src AND dst
 866   wxAND_INVERT, // (NOT src) AND dst
 867   wxNO_OP,      // dst
 868   wxNOR,        // (NOT src) AND (NOT dst)
 869   wxEQUIV,      // (NOT src) XOR dst
 870   wxSRC_INVERT, // (NOT src)
 871   wxOR_INVERT,  // (NOT src) OR dst
 872   wxNAND,       // (NOT src) OR (NOT dst)
 873   wxOR,         // src OR dst
 874   wxSET,        // 1
 875 //  wxSRC_OR,     // source _bitmap_ OR destination
 876 //  wxSRC_AND     // source _bitmap_ AND destination
 877 } form_ops_t;
 878
 879 enum wxKeyCode {
 880     WXK_BACK    =    8,
 881     WXK_TAB     =    9,
 882     WXK_RETURN  =    13,
 883     WXK_ESCAPE  =    27,
 884     WXK_SPACE   =    32,
 885     WXK_DELETE  =    127,
 886
 887     WXK_START   = 300,
 888     WXK_LBUTTON,
 889     WXK_RBUTTON,
 890     WXK_CANCEL,
 891     WXK_MBUTTON,
 892     WXK_CLEAR,
 893     WXK_SHIFT,
 894     WXK_ALT,
 895     WXK_CONTROL,
 896     WXK_MENU,
 897     WXK_PAUSE,
 898     WXK_CAPITAL,
 899     WXK_PRIOR,  /* Page up */
 900     WXK_NEXT,   /* Page down */
 901     WXK_END,
 902     WXK_HOME,
 903     WXK_LEFT,
 904     WXK_UP,
 905     WXK_RIGHT,
 906     WXK_DOWN,
 907     WXK_SELECT,
 908     WXK_PRINT,
 909     WXK_EXECUTE,
 910     WXK_SNAPSHOT,
 911     WXK_INSERT,
 912     WXK_HELP,
 913     WXK_NUMPAD0,
 914     WXK_NUMPAD1,
 915     WXK_NUMPAD2,
 916     WXK_NUMPAD3,
 917     WXK_NUMPAD4,
 918     WXK_NUMPAD5,
 919     WXK_NUMPAD6,
 920     WXK_NUMPAD7,
 921     WXK_NUMPAD8,
 922     WXK_NUMPAD9,
 923     WXK_MULTIPLY,
 924     WXK_ADD,
 925     WXK_SEPARATOR,
 926     WXK_SUBTRACT,
 927     WXK_DECIMAL,
 928     WXK_DIVIDE,
 929     WXK_F1,
 930     WXK_F2,
 931     WXK_F3,
 932     WXK_F4,
 933     WXK_F5,
 934     WXK_F6,
 935     WXK_F7,
 936     WXK_F8,
 937     WXK_F9,
 938     WXK_F10,
 939     WXK_F11,
 940     WXK_F12,
 941     WXK_F13,
 942     WXK_F14,
 943     WXK_F15,
 944     WXK_F16,
 945     WXK_F17,
 946     WXK_F18,
 947     WXK_F19,
 948     WXK_F20,
 949     WXK_F21,
 950     WXK_F22,
 951     WXK_F23,
 952     WXK_F24,
 953     WXK_NUMLOCK,
 954     WXK_SCROLL,
 955     WXK_PAGEUP,
 956     WXK_PAGEDOWN,
 957
 958     WXK_NUMPAD_SPACE,
 959     WXK_NUMPAD_TAB,
 960     WXK_NUMPAD_ENTER,
 961     WXK_NUMPAD_F1,
 962     WXK_NUMPAD_F2,
 963     WXK_NUMPAD_F3,
 964     WXK_NUMPAD_F4,
 965     WXK_NUMPAD_HOME,
 966     WXK_NUMPAD_LEFT,
 967     WXK_NUMPAD_UP,
 968     WXK_NUMPAD_RIGHT,
 969     WXK_NUMPAD_DOWN,
 970     WXK_NUMPAD_PRIOR,
 971     WXK_NUMPAD_PAGEUP,
 972     WXK_NUMPAD_NEXT,
 973     WXK_NUMPAD_PAGEDOWN,
 974     WXK_NUMPAD_END,
 975     WXK_NUMPAD_BEGIN,
 976     WXK_NUMPAD_INSERT,
 977     WXK_NUMPAD_DELETE,
 978     WXK_NUMPAD_EQUAL,
 979     WXK_NUMPAD_MULTIPLY,
 980     WXK_NUMPAD_ADD,
 981     WXK_NUMPAD_SEPARATOR,
 982     WXK_NUMPAD_SUBTRACT,
 983     WXK_NUMPAD_DECIMAL,
 984     WXK_NUMPAD_DIVIDE,
 985
 986     WXK_WINDOWS_LEFT,
 987     WXK_WINDOWS_RIGHT,
 988     WXK_WINDOWS_MENU,
 989
 990     WXK_COMMAND,
 991
 992     // Hardware-specific buttons
 993     WXK_SPECIAL1 = 193,
 994     WXK_SPECIAL2,
 995     WXK_SPECIAL3,
 996     WXK_SPECIAL4,
 997     WXK_SPECIAL5,
 998     WXK_SPECIAL6,
 999     WXK_SPECIAL7,
1000     WXK_SPECIAL8,
1001     WXK_SPECIAL9,
1002     WXK_SPECIAL10,
1003     WXK_SPECIAL11,
1004     WXK_SPECIAL12,
1005     WXK_SPECIAL13,
1006     WXK_SPECIAL14,
1007     WXK_SPECIAL15,
1008     WXK_SPECIAL16,
1009     WXK_SPECIAL17,
1010     WXK_SPECIAL18,
1011     WXK_SPECIAL19,
1012     WXK_SPECIAL20
1013 };
1014
1015
1016
1017 typedef enum {
1018     wxPAPER_NONE,               // Use specific dimensions
1019     wxPAPER_LETTER,             // Letter, 8 1/2 by 11 inches
1020     wxPAPER_LEGAL,              // Legal, 8 1/2 by 14 inches
1021     wxPAPER_A4,                 // A4 Sheet, 210 by 297 millimeters
1022     wxPAPER_CSHEET,             // C Sheet, 17 by 22 inches
1023     wxPAPER_DSHEET,             // D Sheet, 22 by 34 inches
1024     wxPAPER_ESHEET,             // E Sheet, 34 by 44 inches
1025     wxPAPER_LETTERSMALL,        // Letter Small, 8 1/2 by 11 inches
1026     wxPAPER_TABLOID,            // Tabloid, 11 by 17 inches
1027     wxPAPER_LEDGER,             // Ledger, 17 by 11 inches
1028     wxPAPER_STATEMENT,          // Statement, 5 1/2 by 8 1/2 inches
1029     wxPAPER_EXECUTIVE,          // Executive, 7 1/4 by 10 1/2 inches
1030     wxPAPER_A3,                 // A3 sheet, 297 by 420 millimeters
1031     wxPAPER_A4SMALL,            // A4 small sheet, 210 by 297 millimeters
1032     wxPAPER_A5,                 // A5 sheet, 148 by 210 millimeters
1033     wxPAPER_B4,                 // B4 sheet, 250 by 354 millimeters
1034     wxPAPER_B5,                 // B5 sheet, 182-by-257-millimeter paper
1035     wxPAPER_FOLIO,              // Folio, 8-1/2-by-13-inch paper
1036     wxPAPER_QUARTO,             // Quarto, 215-by-275-millimeter paper
1037     wxPAPER_10X14,              // 10-by-14-inch sheet
1038     wxPAPER_11X17,              // 11-by-17-inch sheet
1039     wxPAPER_NOTE,               // Note, 8 1/2 by 11 inches
1040     wxPAPER_ENV_9,              // #9 Envelope, 3 7/8 by 8 7/8 inches
1041     wxPAPER_ENV_10,             // #10 Envelope, 4 1/8 by 9 1/2 inches
1042     wxPAPER_ENV_11,             // #11 Envelope, 4 1/2 by 10 3/8 inches
1043     wxPAPER_ENV_12,             // #12 Envelope, 4 3/4 by 11 inches
1044     wxPAPER_ENV_14,             // #14 Envelope, 5 by 11 1/2 inches
1045     wxPAPER_ENV_DL,             // DL Envelope, 110 by 220 millimeters
1046     wxPAPER_ENV_C5,             // C5 Envelope, 162 by 229 millimeters
1047     wxPAPER_ENV_C3,             // C3 Envelope, 324 by 458 millimeters
1048     wxPAPER_ENV_C4,             // C4 Envelope, 229 by 324 millimeters
1049     wxPAPER_ENV_C6,             // C6 Envelope, 114 by 162 millimeters
1050     wxPAPER_ENV_C65,            // C65 Envelope, 114 by 229 millimeters
1051     wxPAPER_ENV_B4,             // B4 Envelope, 250 by 353 millimeters
1052     wxPAPER_ENV_B5,             // B5 Envelope, 176 by 250 millimeters
1053     wxPAPER_ENV_B6,             // B6 Envelope, 176 by 125 millimeters
1054     wxPAPER_ENV_ITALY,          // Italy Envelope, 110 by 230 millimeters
1055     wxPAPER_ENV_MONARCH,        // Monarch Envelope, 3 7/8 by 7 1/2 inches
1056     wxPAPER_ENV_PERSONAL,       // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
1057     wxPAPER_FANFOLD_US,         // US Std Fanfold, 14 7/8 by 11 inches
1058     wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
1059     wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
1060
1061     wxPAPER_ISO_B4,             // B4 (ISO) 250 x 353 mm
1062     wxPAPER_JAPANESE_POSTCARD,  // Japanese Postcard 100 x 148 mm
1063     wxPAPER_9X11,               // 9 x 11 in
1064     wxPAPER_10X11,              // 10 x 11 in
1065     wxPAPER_15X11,              // 15 x 11 in
1066     wxPAPER_ENV_INVITE,         // Envelope Invite 220 x 220 mm
1067     wxPAPER_LETTER_EXTRA,       // Letter Extra 9 \275 x 12 in
1068     wxPAPER_LEGAL_EXTRA,        // Legal Extra 9 \275 x 15 in
1069     wxPAPER_TABLOID_EXTRA,      // Tabloid Extra 11.69 x 18 in
1070     wxPAPER_A4_EXTRA,           // A4 Extra 9.27 x 12.69 in
1071     wxPAPER_LETTER_TRANSVERSE,  // Letter Transverse 8 \275 x 11 in
1072     wxPAPER_A4_TRANSVERSE,      // A4 Transverse 210 x 297 mm
1073     wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
1074     wxPAPER_A_PLUS,             // SuperA/SuperA/A4 227 x 356 mm
1075     wxPAPER_B_PLUS,             // SuperB/SuperB/A3 305 x 487 mm
1076     wxPAPER_LETTER_PLUS,        // Letter Plus 8.5 x 12.69 in
1077     wxPAPER_A4_PLUS,            // A4 Plus 210 x 330 mm
1078     wxPAPER_A5_TRANSVERSE,      // A5 Transverse 148 x 210 mm
1079     wxPAPER_B5_TRANSVERSE,      // B5 (JIS) Transverse 182 x 257 mm
1080     wxPAPER_A3_EXTRA,           // A3 Extra 322 x 445 mm
1081     wxPAPER_A5_EXTRA,           // A5 Extra 174 x 235 mm
1082     wxPAPER_B5_EXTRA,           // B5 (ISO) Extra 201 x 276 mm
1083     wxPAPER_A2,                 // A2 420 x 594 mm
1084     wxPAPER_A3_TRANSVERSE,      // A3 Transverse 297 x 420 mm
1085     wxPAPER_A3_EXTRA_TRANSVERSE, // A3 Extra Transverse 322 x 445 mm
1086
1087     wxPAPER_DBL_JAPANESE_POSTCARD,/* Japanese Double Postcard 200 x 148 mm */
1088     wxPAPER_A6,                 /* A6 105 x 148 mm */
1089     wxPAPER_JENV_KAKU2,         /* Japanese Envelope Kaku #2 */
1090     wxPAPER_JENV_KAKU3,         /* Japanese Envelope Kaku #3 */
1091     wxPAPER_JENV_CHOU3,         /* Japanese Envelope Chou #3 */
1092     wxPAPER_JENV_CHOU4,         /* Japanese Envelope Chou #4 */
1093     wxPAPER_LETTER_ROTATED,     /* Letter Rotated 11 x 8 1/2 in */
1094     wxPAPER_A3_ROTATED,         /* A3 Rotated 420 x 297 mm */
1095     wxPAPER_A4_ROTATED,         /* A4 Rotated 297 x 210 mm */
1096     wxPAPER_A5_ROTATED,         /* A5 Rotated 210 x 148 mm */
1097     wxPAPER_B4_JIS_ROTATED,     /* B4 (JIS) Rotated 364 x 257 mm */
1098     wxPAPER_B5_JIS_ROTATED,     /* B5 (JIS) Rotated 257 x 182 mm */
1099     wxPAPER_JAPANESE_POSTCARD_ROTATED,/* Japanese Postcard Rotated 148 x 100 mm */
1100     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED,/* Double Japanese Postcard Rotated 148 x 200 mm */
1101     wxPAPER_A6_ROTATED,         /* A6 Rotated 148 x 105 mm */
1102     wxPAPER_JENV_KAKU2_ROTATED, /* Japanese Envelope Kaku #2 Rotated */
1103     wxPAPER_JENV_KAKU3_ROTATED, /* Japanese Envelope Kaku #3 Rotated */
1104     wxPAPER_JENV_CHOU3_ROTATED, /* Japanese Envelope Chou #3 Rotated */
1105     wxPAPER_JENV_CHOU4_ROTATED, /* Japanese Envelope Chou #4 Rotated */
1106     wxPAPER_B6_JIS,             /* B6 (JIS) 128 x 182 mm */
1107     wxPAPER_B6_JIS_ROTATED,     /* B6 (JIS) Rotated 182 x 128 mm */
1108     wxPAPER_12X11,              /* 12 x 11 in */
1109     wxPAPER_JENV_YOU4,          /* Japanese Envelope You #4 */
1110     wxPAPER_JENV_YOU4_ROTATED,  /* Japanese Envelope You #4 Rotated */
1111     wxPAPER_P16K,               /* PRC 16K 146 x 215 mm */
1112     wxPAPER_P32K,               /* PRC 32K 97 x 151 mm */
1113     wxPAPER_P32KBIG,            /* PRC 32K(Big) 97 x 151 mm */
1114     wxPAPER_PENV_1,             /* PRC Envelope #1 102 x 165 mm */
1115     wxPAPER_PENV_2,             /* PRC Envelope #2 102 x 176 mm */
1116     wxPAPER_PENV_3,             /* PRC Envelope #3 125 x 176 mm */
1117     wxPAPER_PENV_4,             /* PRC Envelope #4 110 x 208 mm */
1118     wxPAPER_PENV_5,             /* PRC Envelope #5 110 x 220 mm */
1119     wxPAPER_PENV_6,             /* PRC Envelope #6 120 x 230 mm */
1120     wxPAPER_PENV_7,             /* PRC Envelope #7 160 x 230 mm */
1121     wxPAPER_PENV_8,             /* PRC Envelope #8 120 x 309 mm */
1122     wxPAPER_PENV_9,             /* PRC Envelope #9 229 x 324 mm */
1123     wxPAPER_PENV_10,            /* PRC Envelope #10 324 x 458 mm */
1124     wxPAPER_P16K_ROTATED,       /* PRC 16K Rotated */
1125     wxPAPER_P32K_ROTATED,       /* PRC 32K Rotated */
1126     wxPAPER_P32KBIG_ROTATED,    /* PRC 32K(Big) Rotated */
1127     wxPAPER_PENV_1_ROTATED,     /* PRC Envelope #1 Rotated 165 x 102 mm */
1128     wxPAPER_PENV_2_ROTATED,     /* PRC Envelope #2 Rotated 176 x 102 mm */
1129     wxPAPER_PENV_3_ROTATED,     /* PRC Envelope #3 Rotated 176 x 125 mm */
1130     wxPAPER_PENV_4_ROTATED,     /* PRC Envelope #4 Rotated 208 x 110 mm */
1131     wxPAPER_PENV_5_ROTATED,     /* PRC Envelope #5 Rotated 220 x 110 mm */
1132     wxPAPER_PENV_6_ROTATED,     /* PRC Envelope #6 Rotated 230 x 120 mm */
1133     wxPAPER_PENV_7_ROTATED,     /* PRC Envelope #7 Rotated 230 x 160 mm */
1134     wxPAPER_PENV_8_ROTATED,     /* PRC Envelope #8 Rotated 309 x 120 mm */
1135     wxPAPER_PENV_9_ROTATED,     /* PRC Envelope #9 Rotated 324 x 229 mm */
1136     wxPAPER_PENV_10_ROTATED    /* PRC Envelope #10 Rotated 458 x 324 m */
1137
1138 } wxPaperSize ;
1139
1140 typedef enum {
1141     wxDUPLEX_SIMPLEX, // Non-duplex
1142     wxDUPLEX_HORIZONTAL,
1143     wxDUPLEX_VERTICAL
1144 } wxDuplexMode;
1145
1146
1147
1148 // menu and toolbar item kinds
1149 enum wxItemKind
1150 {
1151     wxITEM_SEPARATOR,
1152     wxITEM_NORMAL,
1153     wxITEM_CHECK,
1154     wxITEM_RADIO,
1155     wxITEM_MAX
1156 };
1157
1158
1159 enum wxHitTest
1160 {
1161     wxHT_NOWHERE,
1162
1163     // scrollbar
1164     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
1165     wxHT_SCROLLBAR_ARROW_LINE_1,    // left or upper arrow to scroll by line
1166     wxHT_SCROLLBAR_ARROW_LINE_2,    // right or down
1167     wxHT_SCROLLBAR_ARROW_PAGE_1,    // left or upper arrow to scroll by page
1168     wxHT_SCROLLBAR_ARROW_PAGE_2,    // right or down
1169     wxHT_SCROLLBAR_THUMB,           // on the thumb
1170     wxHT_SCROLLBAR_BAR_1,           // bar to the left/above the thumb
1171     wxHT_SCROLLBAR_BAR_2,           // bar to the right/below the thumb
1172     wxHT_SCROLLBAR_LAST,
1173
1174     // window
1175     wxHT_WINDOW_OUTSIDE,            // not in this window at all
1176     wxHT_WINDOW_INSIDE,             // in the client area
1177     wxHT_WINDOW_VERT_SCROLLBAR,     // on the vertical scrollbar
1178     wxHT_WINDOW_HORZ_SCROLLBAR,     // on the horizontal scrollbar
1179     wxHT_WINDOW_CORNER,             // on the corner between 2 scrollbars
1180
1181     wxHT_MAX
1182 };
1183
1184
1185
1186 enum wxKeyModifier
1187 {
1188     wxMOD_NONE,
1189     wxMOD_ALT,
1190     wxMOD_CONTROL,
1191     wxMOD_ALTGR,
1192     wxMOD_SHIFT,
1193     wxMOD_META,
1194     wxMOD_WIN,
1195     wxMOD_CMD,
1196     wxMOD_ALL
1197 };
1198
1199
1200 enum wxUpdateUI
1201 {
1202     wxUPDATE_UI_NONE          = 0x0000,
1203     wxUPDATE_UI_RECURSE       = 0x0001,
1204     wxUPDATE_UI_FROMIDLE      = 0x0002 // Invoked from On(Internal)Idle
1205 };
1206
1207
1208
1209 //---------------------------------------------------------------------------
1210