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 // Forward declarations and %renames for some classes, so the autodoc strings
 386 // will be able to use the right types even when the real class declaration is
 387 // not in the module being processed or seen by %import's.
 388
 389 #ifdef BUILDING_RENAMERS
 390     #define FORWARD_DECLARE(wxName, Name)
 391 #else
 392     %define FORWARD_DECLARE(wxName, Name)
 393         %rename(Name) wxName;
 394         class wxName;
 395     %enddef
 396 #endif
 397
 398 FORWARD_DECLARE(wxString,         String);
 399 FORWARD_DECLARE(wxBitmap,         Bitmap);
 400 FORWARD_DECLARE(wxDateTime,       DateTime);
 401 FORWARD_DECLARE(wxInputStream,    InputStream);
 402 FORWARD_DECLARE(wxDC,             DC);
 403 FORWARD_DECLARE(wxCursor,         Cursor);
 404 FORWARD_DECLARE(wxRegion,         Region);
 405 FORWARD_DECLARE(wxColour,         Colour);
 406 FORWARD_DECLARE(wxFont,           Font);
 407 FORWARD_DECLARE(wxCaret,          Caret);
 408 FORWARD_DECLARE(wxToolTip,        ToolTip);
 409 FORWARD_DECLARE(wxPyDropTarget,   DropTarget);
 410 FORWARD_DECLARE(wxImageList,      ImageList);
 411 FORWARD_DECLARE(wxMemoryDC,       MemoryDC);
 412 FORWARD_DECLARE(wxHtmlTagHandler, HtmlTagHandler);
 413 FORWARD_DECLARE(wxConfigBase,     ConfigBase);
 414 FORWARD_DECLARE(wxIcon,           Icon);
 415 FORWARD_DECLARE(wxStaticBox,      StaticBox);
 416
 417
 418 //---------------------------------------------------------------------------
 419
 420 %{
 421 #if !WXWIN_COMPATIBILITY_2_4
 422     #define wxHIDE_READONLY  0
 423 #endif
 424 %}
 425
 426
 427 // General numeric #define's and etc.  Making them all enums makes SWIG use the
 428 // real macro when making the Python Int
 429
 430 enum {
 431 //     wxMAJOR_VERSION,
 432 //     wxMINOR_VERSION,
 433 //     wxRELEASE_NUMBER,
 434
 435     wxNOT_FOUND,
 436
 437     wxVSCROLL,
 438     wxHSCROLL,
 439     wxCAPTION,
 440     wxDOUBLE_BORDER,
 441     wxSUNKEN_BORDER,
 442     wxRAISED_BORDER,
 443     wxBORDER,
 444     wxSIMPLE_BORDER,
 445     wxSTATIC_BORDER,
 446     wxTRANSPARENT_WINDOW,
 447     wxNO_BORDER,
 448     wxDEFAULT_CONTROL_BORDER,
 449     wxDEFAULT_STATUSBAR_STYLE,
 450
 451     wxTAB_TRAVERSAL,
 452     wxWANTS_CHARS,
 453     wxPOPUP_WINDOW,
 454     wxCENTER_FRAME,
 455     wxCENTRE_ON_SCREEN,
 456     wxCENTER_ON_SCREEN,
 457
 458     wxCLIP_CHILDREN,
 459     wxCLIP_SIBLINGS,
 460
 461     wxALWAYS_SHOW_SB,
 462
 463     wxRETAINED,
 464     wxBACKINGSTORE,
 465
 466     wxCOLOURED,
 467     wxFIXED_LENGTH,
 468
 469     wxLB_NEEDED_SB,
 470     wxLB_ALWAYS_SB,
 471     wxLB_SORT,
 472     wxLB_SINGLE,
 473     wxLB_MULTIPLE,
 474     wxLB_EXTENDED,
 475     wxLB_OWNERDRAW,
 476     wxLB_HSCROLL,
 477     wxPROCESS_ENTER,
 478     wxPASSWORD,
 479
 480     wxCB_SIMPLE,
 481     wxCB_DROPDOWN,
 482     wxCB_SORT,
 483     wxCB_READONLY,
 484     wxRA_HORIZONTAL,
 485     wxRA_VERTICAL,
 486     wxRA_SPECIFY_ROWS,
 487     wxRA_SPECIFY_COLS,
 488     wxRA_USE_CHECKBOX,
 489     wxRB_GROUP,
 490     wxRB_SINGLE,
 491     wxSB_HORIZONTAL,
 492     wxSB_VERTICAL,
 493     wxRB_USE_CHECKBOX,
 494     wxST_SIZEGRIP,
 495     wxST_NO_AUTORESIZE,
 496
 497     wxFLOOD_SURFACE,
 498     wxFLOOD_BORDER,
 499     wxODDEVEN_RULE,
 500     wxWINDING_RULE,
 501     wxTOOL_TOP,
 502     wxTOOL_BOTTOM,
 503     wxTOOL_LEFT,
 504     wxTOOL_RIGHT,
 505     wxOK,
 506     wxYES_NO,
 507     wxCANCEL,
 508     wxYES,
 509     wxNO,
 510     wxNO_DEFAULT,
 511     wxYES_DEFAULT,
 512     wxICON_EXCLAMATION,
 513     wxICON_HAND,
 514     wxICON_QUESTION,
 515     wxICON_INFORMATION,
 516     wxICON_STOP,
 517     wxICON_ASTERISK,
 518     wxICON_MASK,
 519     wxICON_WARNING,
 520     wxICON_ERROR,
 521
 522     wxFORWARD,
 523     wxBACKWARD,
 524     wxRESET,
 525     wxHELP,
 526     wxMORE,
 527     wxSETUP,
 528
 529
 530     wxSIZE_AUTO_WIDTH,
 531     wxSIZE_AUTO_HEIGHT,
 532     wxSIZE_AUTO,
 533     wxSIZE_USE_EXISTING,
 534     wxSIZE_ALLOW_MINUS_ONE,
 535     wxSIZE_FORCE,
 536     wxPORTRAIT,
 537     wxLANDSCAPE,
 538     wxPRINT_QUALITY_HIGH,
 539     wxPRINT_QUALITY_MEDIUM,
 540     wxPRINT_QUALITY_LOW,
 541     wxPRINT_QUALITY_DRAFT,
 542
 543     wxID_ANY,
 544     wxID_SEPARATOR,
 545     wxID_NONE,
 546
 547     wxID_LOWEST,
 548     wxID_OPEN,
 549     wxID_CLOSE,
 550     wxID_NEW,
 551     wxID_SAVE,
 552     wxID_SAVEAS,
 553     wxID_REVERT,
 554     wxID_EXIT,
 555     wxID_UNDO,
 556     wxID_REDO,
 557     wxID_HELP,
 558     wxID_PRINT,
 559     wxID_PRINT_SETUP,
 560     wxID_PREVIEW,
 561     wxID_ABOUT,
 562     wxID_HELP_CONTENTS,
 563     wxID_HELP_COMMANDS,
 564     wxID_HELP_PROCEDURES,
 565     wxID_HELP_CONTEXT,
 566     wxID_CLOSE_ALL,
 567     wxID_PREFERENCES,
 568
 569     wxID_CUT,
 570     wxID_COPY,
 571     wxID_PASTE,
 572     wxID_CLEAR,
 573     wxID_FIND,
 574     wxID_DUPLICATE,
 575     wxID_SELECTALL,
 576
 577     wxID_DELETE,
 578     wxID_REPLACE,
 579     wxID_REPLACE_ALL,
 580     wxID_PROPERTIES,
 581
 582     wxID_VIEW_DETAILS,
 583     wxID_VIEW_LARGEICONS,
 584     wxID_VIEW_SMALLICONS,
 585     wxID_VIEW_LIST,
 586     wxID_VIEW_SORTDATE,
 587     wxID_VIEW_SORTNAME,
 588     wxID_VIEW_SORTSIZE,
 589     wxID_VIEW_SORTTYPE,
 590
 591     wxID_FILE1,
 592     wxID_FILE2,
 593     wxID_FILE3,
 594     wxID_FILE4,
 595     wxID_FILE5,
 596     wxID_FILE6,
 597     wxID_FILE7,
 598     wxID_FILE8,
 599     wxID_FILE9,
 600
 601     wxID_OK,
 602     wxID_CANCEL,
 603     wxID_APPLY,
 604     wxID_YES,
 605     wxID_NO,
 606     wxID_STATIC,
 607     wxID_FORWARD,
 608     wxID_BACKWARD,
 609     wxID_DEFAULT,
 610     wxID_MORE,
 611     wxID_SETUP,
 612     wxID_RESET,
 613     wxID_CONTEXT_HELP,
 614     wxID_YESTOALL,
 615     wxID_NOTOALL,
 616     wxID_ABORT,
 617     wxID_RETRY,
 618     wxID_IGNORE,
 619
 620     wxID_ADD,
 621     wxID_REMOVE,
 622
 623     wxID_UP,
 624     wxID_DOWN,
 625     wxID_HOME,
 626     wxID_REFRESH,
 627     wxID_STOP,
 628     wxID_INDEX,
 629
 630     wxID_BOLD,
 631     wxID_ITALIC,
 632     wxID_JUSTIFY_CENTER,
 633     wxID_JUSTIFY_FILL,
 634     wxID_JUSTIFY_RIGHT,
 635     wxID_JUSTIFY_LEFT,
 636     wxID_UNDERLINE,
 637     wxID_INDENT,
 638     wxID_UNINDENT,
 639     wxID_ZOOM_100,
 640     wxID_ZOOM_FIT,
 641     wxID_ZOOM_IN,
 642     wxID_ZOOM_OUT,
 643     wxID_UNDELETE,
 644     wxID_REVERT_TO_SAVED,
 645
 646     wxID_HIGHEST,
 647
 648     wxOPEN,
 649     wxSAVE,
 650     wxHIDE_READONLY,
 651     wxOVERWRITE_PROMPT,
 652     wxFILE_MUST_EXIST,
 653     wxMULTIPLE,
 654     wxCHANGE_DIR,
 655
 656     wxACCEL_ALT,
 657     wxACCEL_CTRL,
 658     wxACCEL_SHIFT,
 659     wxACCEL_NORMAL,
 660
 661     wxPD_AUTO_HIDE,
 662     wxPD_APP_MODAL,
 663     wxPD_CAN_ABORT,
 664     wxPD_ELAPSED_TIME,
 665     wxPD_ESTIMATED_TIME,
 666     wxPD_REMAINING_TIME,
 667     wxPD_SMOOTH,
 668     wxPD_CAN_SKIP,
 669
 670     wxDD_NEW_DIR_BUTTON,
 671     wxDD_DEFAULT_STYLE,
 672
 673     wxMENU_TEAROFF,
 674     wxMB_DOCKABLE,
 675     wxNO_FULL_REPAINT_ON_RESIZE,
 676     wxFULL_REPAINT_ON_RESIZE,
 677
 678     wxLI_HORIZONTAL,
 679     wxLI_VERTICAL,
 680
 681     wxWS_EX_VALIDATE_RECURSIVELY,
 682     wxWS_EX_BLOCK_EVENTS,
 683     wxWS_EX_TRANSIENT,
 684
 685     wxWS_EX_THEMED_BACKGROUND,
 686     wxWS_EX_PROCESS_IDLE,
 687     wxWS_EX_PROCESS_UI_UPDATES,
 688
 689
 690     // Mapping modes (as per Windows)
 691     wxMM_TEXT,
 692     wxMM_LOMETRIC,
 693     wxMM_HIMETRIC,
 694     wxMM_LOENGLISH,
 695     wxMM_HIENGLISH,
 696     wxMM_TWIPS,
 697     wxMM_ISOTROPIC,
 698     wxMM_ANISOTROPIC,
 699     wxMM_POINTS,
 700     wxMM_METRIC,
 701
 702
 703     // It looks like wxTabCtrl may rise from the dead.  Uncomment these if
 704     // it gets an implementation for all platforms...
 705 //     wxTC_RIGHTJUSTIFY,
 706 //     wxTC_FIXEDWIDTH,
 707 //     wxTC_TOP,
 708 //     wxTC_LEFT,
 709 //     wxTC_RIGHT,
 710 //     wxTC_BOTTOM,
 711 //     wxTC_MULTILINE,
 712 //     wxTC_OWNERDRAW,
 713
 714 };
 715
 716
 717
 718 enum wxGeometryCentre
 719 {
 720     wxCENTRE                  = 0x0001,
 721     wxCENTER                  = wxCENTRE
 722 };
 723
 724
 725 enum wxOrientation
 726 {
 727     wxHORIZONTAL,
 728     wxVERTICAL,
 729     wxBOTH
 730 };
 731
 732 enum wxDirection
 733 {
 734     wxLEFT,
 735     wxRIGHT,
 736     wxUP,
 737     wxDOWN,
 738
 739     wxTOP,
 740     wxBOTTOM,
 741
 742     wxNORTH,
 743     wxSOUTH,
 744     wxWEST,
 745     wxEAST,
 746
 747     wxALL
 748 };
 749
 750 enum wxAlignment
 751 {
 752     wxALIGN_NOT,
 753     wxALIGN_CENTER_HORIZONTAL,
 754     wxALIGN_CENTRE_HORIZONTAL,
 755     wxALIGN_LEFT,
 756     wxALIGN_TOP,
 757     wxALIGN_RIGHT,
 758     wxALIGN_BOTTOM,
 759     wxALIGN_CENTER_VERTICAL,
 760     wxALIGN_CENTRE_VERTICAL,
 761
 762     wxALIGN_CENTER,
 763     wxALIGN_CENTRE,
 764
 765     wxALIGN_MASK,
 766 };
 767
 768 enum wxStretch
 769 {
 770     wxSTRETCH_NOT,
 771     wxSHRINK,
 772     wxGROW,
 773     wxEXPAND,
 774     wxSHAPED,
 775     wxFIXED_MINSIZE,
 776     wxTILE,
 777     wxADJUST_MINSIZE,
 778 };
 779
 780
 781 enum wxBorder
 782 {
 783     wxBORDER_DEFAULT,
 784     wxBORDER_NONE,
 785     wxBORDER_STATIC,
 786     wxBORDER_SIMPLE,
 787     wxBORDER_RAISED,
 788     wxBORDER_SUNKEN,
 789     wxBORDER_DOUBLE,
 790     wxBORDER_MASK,
 791 };
 792
 793
 794 enum wxBackgroundStyle
 795 {
 796   wxBG_STYLE_SYSTEM,
 797   wxBG_STYLE_COLOUR,
 798   wxBG_STYLE_CUSTOM
 799 };
 800
 801
 802 enum {
 803   wxDEFAULT ,
 804   wxDECORATIVE,
 805   wxROMAN,
 806   wxSCRIPT,
 807   wxSWISS,
 808   wxMODERN,
 809   wxTELETYPE,
 810   wxVARIABLE,
 811   wxFIXED,
 812   wxNORMAL,
 813   wxLIGHT,
 814   wxBOLD,
 815   wxITALIC,
 816   wxSLANT,
 817   wxSOLID,
 818   wxDOT,
 819   wxLONG_DASH,
 820   wxSHORT_DASH,
 821   wxDOT_DASH,
 822   wxUSER_DASH,
 823   wxTRANSPARENT,
 824   wxSTIPPLE,
 825   wxSTIPPLE_MASK,
 826   wxSTIPPLE_MASK_OPAQUE,
 827   wxBDIAGONAL_HATCH,
 828   wxCROSSDIAG_HATCH,
 829   wxFDIAGONAL_HATCH,
 830   wxCROSS_HATCH,
 831   wxHORIZONTAL_HATCH,
 832   wxVERTICAL_HATCH,
 833   wxJOIN_BEVEL,
 834   wxJOIN_MITER,
 835   wxJOIN_ROUND,
 836   wxCAP_ROUND,
 837   wxCAP_PROJECTING,
 838   wxCAP_BUTT
 839 };
 840
 841 typedef enum {
 842   wxCLEAR,      // 0
 843   wxXOR,        // src XOR dst
 844   wxINVERT,     // NOT dst
 845   wxOR_REVERSE, // src OR (NOT dst)
 846   wxAND_REVERSE,// src AND (NOT dst)
 847   wxCOPY,       // src
 848   wxAND,        // src AND dst
 849   wxAND_INVERT, // (NOT src) AND dst
 850   wxNO_OP,      // dst
 851   wxNOR,        // (NOT src) AND (NOT dst)
 852   wxEQUIV,      // (NOT src) XOR dst
 853   wxSRC_INVERT, // (NOT src)
 854   wxOR_INVERT,  // (NOT src) OR dst
 855   wxNAND,       // (NOT src) OR (NOT dst)
 856   wxOR,         // src OR dst
 857   wxSET,        // 1
 858 //  wxSRC_OR,     // source _bitmap_ OR destination
 859 //  wxSRC_AND     // source _bitmap_ AND destination
 860 } form_ops_t;
 861
 862 enum wxKeyCode {
 863     WXK_BACK    =    8,
 864     WXK_TAB     =    9,
 865     WXK_RETURN  =    13,
 866     WXK_ESCAPE  =    27,
 867     WXK_SPACE   =    32,
 868     WXK_DELETE  =    127,
 869
 870     WXK_START   = 300,
 871     WXK_LBUTTON,
 872     WXK_RBUTTON,
 873     WXK_CANCEL,
 874     WXK_MBUTTON,
 875     WXK_CLEAR,
 876     WXK_SHIFT,
 877     WXK_ALT,
 878     WXK_CONTROL,
 879     WXK_MENU,
 880     WXK_PAUSE,
 881     WXK_CAPITAL,
 882     WXK_PRIOR,  /* Page up */
 883     WXK_NEXT,   /* Page down */
 884     WXK_END,
 885     WXK_HOME,
 886     WXK_LEFT,
 887     WXK_UP,
 888     WXK_RIGHT,
 889     WXK_DOWN,
 890     WXK_SELECT,
 891     WXK_PRINT,
 892     WXK_EXECUTE,
 893     WXK_SNAPSHOT,
 894     WXK_INSERT,
 895     WXK_HELP,
 896     WXK_NUMPAD0,
 897     WXK_NUMPAD1,
 898     WXK_NUMPAD2,
 899     WXK_NUMPAD3,
 900     WXK_NUMPAD4,
 901     WXK_NUMPAD5,
 902     WXK_NUMPAD6,
 903     WXK_NUMPAD7,
 904     WXK_NUMPAD8,
 905     WXK_NUMPAD9,
 906     WXK_MULTIPLY,
 907     WXK_ADD,
 908     WXK_SEPARATOR,
 909     WXK_SUBTRACT,
 910     WXK_DECIMAL,
 911     WXK_DIVIDE,
 912     WXK_F1,
 913     WXK_F2,
 914     WXK_F3,
 915     WXK_F4,
 916     WXK_F5,
 917     WXK_F6,
 918     WXK_F7,
 919     WXK_F8,
 920     WXK_F9,
 921     WXK_F10,
 922     WXK_F11,
 923     WXK_F12,
 924     WXK_F13,
 925     WXK_F14,
 926     WXK_F15,
 927     WXK_F16,
 928     WXK_F17,
 929     WXK_F18,
 930     WXK_F19,
 931     WXK_F20,
 932     WXK_F21,
 933     WXK_F22,
 934     WXK_F23,
 935     WXK_F24,
 936     WXK_NUMLOCK,
 937     WXK_SCROLL,
 938     WXK_PAGEUP,
 939     WXK_PAGEDOWN,
 940
 941     WXK_NUMPAD_SPACE,
 942     WXK_NUMPAD_TAB,
 943     WXK_NUMPAD_ENTER,
 944     WXK_NUMPAD_F1,
 945     WXK_NUMPAD_F2,
 946     WXK_NUMPAD_F3,
 947     WXK_NUMPAD_F4,
 948     WXK_NUMPAD_HOME,
 949     WXK_NUMPAD_LEFT,
 950     WXK_NUMPAD_UP,
 951     WXK_NUMPAD_RIGHT,
 952     WXK_NUMPAD_DOWN,
 953     WXK_NUMPAD_PRIOR,
 954     WXK_NUMPAD_PAGEUP,
 955     WXK_NUMPAD_NEXT,
 956     WXK_NUMPAD_PAGEDOWN,
 957     WXK_NUMPAD_END,
 958     WXK_NUMPAD_BEGIN,
 959     WXK_NUMPAD_INSERT,
 960     WXK_NUMPAD_DELETE,
 961     WXK_NUMPAD_EQUAL,
 962     WXK_NUMPAD_MULTIPLY,
 963     WXK_NUMPAD_ADD,
 964     WXK_NUMPAD_SEPARATOR,
 965     WXK_NUMPAD_SUBTRACT,
 966     WXK_NUMPAD_DECIMAL,
 967     WXK_NUMPAD_DIVIDE,
 968
 969     WXK_WINDOWS_LEFT,
 970     WXK_WINDOWS_RIGHT,
 971     WXK_WINDOWS_MENU,
 972
 973     WXK_COMMAND,
 974
 975     // Hardware-specific buttons
 976     WXK_SPECIAL1 = 193,
 977     WXK_SPECIAL2,
 978     WXK_SPECIAL3,
 979     WXK_SPECIAL4,
 980     WXK_SPECIAL5,
 981     WXK_SPECIAL6,
 982     WXK_SPECIAL7,
 983     WXK_SPECIAL8,
 984     WXK_SPECIAL9,
 985     WXK_SPECIAL10,
 986     WXK_SPECIAL11,
 987     WXK_SPECIAL12,
 988     WXK_SPECIAL13,
 989     WXK_SPECIAL14,
 990     WXK_SPECIAL15,
 991     WXK_SPECIAL16,
 992     WXK_SPECIAL17,
 993     WXK_SPECIAL18,
 994     WXK_SPECIAL19,
 995     WXK_SPECIAL20
 996 };
 997
 998
 999
1000 typedef enum {
1001     wxPAPER_NONE,               // Use specific dimensions
1002     wxPAPER_LETTER,             // Letter, 8 1/2 by 11 inches
1003     wxPAPER_LEGAL,              // Legal, 8 1/2 by 14 inches
1004     wxPAPER_A4,                 // A4 Sheet, 210 by 297 millimeters
1005     wxPAPER_CSHEET,             // C Sheet, 17 by 22 inches
1006     wxPAPER_DSHEET,             // D Sheet, 22 by 34 inches
1007     wxPAPER_ESHEET,             // E Sheet, 34 by 44 inches
1008     wxPAPER_LETTERSMALL,        // Letter Small, 8 1/2 by 11 inches
1009     wxPAPER_TABLOID,            // Tabloid, 11 by 17 inches
1010     wxPAPER_LEDGER,             // Ledger, 17 by 11 inches
1011     wxPAPER_STATEMENT,          // Statement, 5 1/2 by 8 1/2 inches
1012     wxPAPER_EXECUTIVE,          // Executive, 7 1/4 by 10 1/2 inches
1013     wxPAPER_A3,                 // A3 sheet, 297 by 420 millimeters
1014     wxPAPER_A4SMALL,            // A4 small sheet, 210 by 297 millimeters
1015     wxPAPER_A5,                 // A5 sheet, 148 by 210 millimeters
1016     wxPAPER_B4,                 // B4 sheet, 250 by 354 millimeters
1017     wxPAPER_B5,                 // B5 sheet, 182-by-257-millimeter paper
1018     wxPAPER_FOLIO,              // Folio, 8-1/2-by-13-inch paper
1019     wxPAPER_QUARTO,             // Quarto, 215-by-275-millimeter paper
1020     wxPAPER_10X14,              // 10-by-14-inch sheet
1021     wxPAPER_11X17,              // 11-by-17-inch sheet
1022     wxPAPER_NOTE,               // Note, 8 1/2 by 11 inches
1023     wxPAPER_ENV_9,              // #9 Envelope, 3 7/8 by 8 7/8 inches
1024     wxPAPER_ENV_10,             // #10 Envelope, 4 1/8 by 9 1/2 inches
1025     wxPAPER_ENV_11,             // #11 Envelope, 4 1/2 by 10 3/8 inches
1026     wxPAPER_ENV_12,             // #12 Envelope, 4 3/4 by 11 inches
1027     wxPAPER_ENV_14,             // #14 Envelope, 5 by 11 1/2 inches
1028     wxPAPER_ENV_DL,             // DL Envelope, 110 by 220 millimeters
1029     wxPAPER_ENV_C5,             // C5 Envelope, 162 by 229 millimeters
1030     wxPAPER_ENV_C3,             // C3 Envelope, 324 by 458 millimeters
1031     wxPAPER_ENV_C4,             // C4 Envelope, 229 by 324 millimeters
1032     wxPAPER_ENV_C6,             // C6 Envelope, 114 by 162 millimeters
1033     wxPAPER_ENV_C65,            // C65 Envelope, 114 by 229 millimeters
1034     wxPAPER_ENV_B4,             // B4 Envelope, 250 by 353 millimeters
1035     wxPAPER_ENV_B5,             // B5 Envelope, 176 by 250 millimeters
1036     wxPAPER_ENV_B6,             // B6 Envelope, 176 by 125 millimeters
1037     wxPAPER_ENV_ITALY,          // Italy Envelope, 110 by 230 millimeters
1038     wxPAPER_ENV_MONARCH,        // Monarch Envelope, 3 7/8 by 7 1/2 inches
1039     wxPAPER_ENV_PERSONAL,       // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
1040     wxPAPER_FANFOLD_US,         // US Std Fanfold, 14 7/8 by 11 inches
1041     wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
1042     wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
1043
1044     wxPAPER_ISO_B4,             // B4 (ISO) 250 x 353 mm
1045     wxPAPER_JAPANESE_POSTCARD,  // Japanese Postcard 100 x 148 mm
1046     wxPAPER_9X11,               // 9 x 11 in
1047     wxPAPER_10X11,              // 10 x 11 in
1048     wxPAPER_15X11,              // 15 x 11 in
1049     wxPAPER_ENV_INVITE,         // Envelope Invite 220 x 220 mm
1050     wxPAPER_LETTER_EXTRA,       // Letter Extra 9 \275 x 12 in
1051     wxPAPER_LEGAL_EXTRA,        // Legal Extra 9 \275 x 15 in
1052     wxPAPER_TABLOID_EXTRA,      // Tabloid Extra 11.69 x 18 in
1053     wxPAPER_A4_EXTRA,           // A4 Extra 9.27 x 12.69 in
1054     wxPAPER_LETTER_TRANSVERSE,  // Letter Transverse 8 \275 x 11 in
1055     wxPAPER_A4_TRANSVERSE,      // A4 Transverse 210 x 297 mm
1056     wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
1057     wxPAPER_A_PLUS,             // SuperA/SuperA/A4 227 x 356 mm
1058     wxPAPER_B_PLUS,             // SuperB/SuperB/A3 305 x 487 mm
1059     wxPAPER_LETTER_PLUS,        // Letter Plus 8.5 x 12.69 in
1060     wxPAPER_A4_PLUS,            // A4 Plus 210 x 330 mm
1061     wxPAPER_A5_TRANSVERSE,      // A5 Transverse 148 x 210 mm
1062     wxPAPER_B5_TRANSVERSE,      // B5 (JIS) Transverse 182 x 257 mm
1063     wxPAPER_A3_EXTRA,           // A3 Extra 322 x 445 mm
1064     wxPAPER_A5_EXTRA,           // A5 Extra 174 x 235 mm
1065     wxPAPER_B5_EXTRA,           // B5 (ISO) Extra 201 x 276 mm
1066     wxPAPER_A2,                 // A2 420 x 594 mm
1067     wxPAPER_A3_TRANSVERSE,      // A3 Transverse 297 x 420 mm
1068     wxPAPER_A3_EXTRA_TRANSVERSE, // A3 Extra Transverse 322 x 445 mm
1069
1070     wxPAPER_DBL_JAPANESE_POSTCARD,/* Japanese Double Postcard 200 x 148 mm */
1071     wxPAPER_A6,                 /* A6 105 x 148 mm */
1072     wxPAPER_JENV_KAKU2,         /* Japanese Envelope Kaku #2 */
1073     wxPAPER_JENV_KAKU3,         /* Japanese Envelope Kaku #3 */
1074     wxPAPER_JENV_CHOU3,         /* Japanese Envelope Chou #3 */
1075     wxPAPER_JENV_CHOU4,         /* Japanese Envelope Chou #4 */
1076     wxPAPER_LETTER_ROTATED,     /* Letter Rotated 11 x 8 1/2 in */
1077     wxPAPER_A3_ROTATED,         /* A3 Rotated 420 x 297 mm */
1078     wxPAPER_A4_ROTATED,         /* A4 Rotated 297 x 210 mm */
1079     wxPAPER_A5_ROTATED,         /* A5 Rotated 210 x 148 mm */
1080     wxPAPER_B4_JIS_ROTATED,     /* B4 (JIS) Rotated 364 x 257 mm */
1081     wxPAPER_B5_JIS_ROTATED,     /* B5 (JIS) Rotated 257 x 182 mm */
1082     wxPAPER_JAPANESE_POSTCARD_ROTATED,/* Japanese Postcard Rotated 148 x 100 mm */
1083     wxPAPER_DBL_JAPANESE_POSTCARD_ROTATED,/* Double Japanese Postcard Rotated 148 x 200 mm */
1084     wxPAPER_A6_ROTATED,         /* A6 Rotated 148 x 105 mm */
1085     wxPAPER_JENV_KAKU2_ROTATED, /* Japanese Envelope Kaku #2 Rotated */
1086     wxPAPER_JENV_KAKU3_ROTATED, /* Japanese Envelope Kaku #3 Rotated */
1087     wxPAPER_JENV_CHOU3_ROTATED, /* Japanese Envelope Chou #3 Rotated */
1088     wxPAPER_JENV_CHOU4_ROTATED, /* Japanese Envelope Chou #4 Rotated */
1089     wxPAPER_B6_JIS,             /* B6 (JIS) 128 x 182 mm */
1090     wxPAPER_B6_JIS_ROTATED,     /* B6 (JIS) Rotated 182 x 128 mm */
1091     wxPAPER_12X11,              /* 12 x 11 in */
1092     wxPAPER_JENV_YOU4,          /* Japanese Envelope You #4 */
1093     wxPAPER_JENV_YOU4_ROTATED,  /* Japanese Envelope You #4 Rotated */
1094     wxPAPER_P16K,               /* PRC 16K 146 x 215 mm */
1095     wxPAPER_P32K,               /* PRC 32K 97 x 151 mm */
1096     wxPAPER_P32KBIG,            /* PRC 32K(Big) 97 x 151 mm */
1097     wxPAPER_PENV_1,             /* PRC Envelope #1 102 x 165 mm */
1098     wxPAPER_PENV_2,             /* PRC Envelope #2 102 x 176 mm */
1099     wxPAPER_PENV_3,             /* PRC Envelope #3 125 x 176 mm */
1100     wxPAPER_PENV_4,             /* PRC Envelope #4 110 x 208 mm */
1101     wxPAPER_PENV_5,             /* PRC Envelope #5 110 x 220 mm */
1102     wxPAPER_PENV_6,             /* PRC Envelope #6 120 x 230 mm */
1103     wxPAPER_PENV_7,             /* PRC Envelope #7 160 x 230 mm */
1104     wxPAPER_PENV_8,             /* PRC Envelope #8 120 x 309 mm */
1105     wxPAPER_PENV_9,             /* PRC Envelope #9 229 x 324 mm */
1106     wxPAPER_PENV_10,            /* PRC Envelope #10 324 x 458 mm */
1107     wxPAPER_P16K_ROTATED,       /* PRC 16K Rotated */
1108     wxPAPER_P32K_ROTATED,       /* PRC 32K Rotated */
1109     wxPAPER_P32KBIG_ROTATED,    /* PRC 32K(Big) Rotated */
1110     wxPAPER_PENV_1_ROTATED,     /* PRC Envelope #1 Rotated 165 x 102 mm */
1111     wxPAPER_PENV_2_ROTATED,     /* PRC Envelope #2 Rotated 176 x 102 mm */
1112     wxPAPER_PENV_3_ROTATED,     /* PRC Envelope #3 Rotated 176 x 125 mm */
1113     wxPAPER_PENV_4_ROTATED,     /* PRC Envelope #4 Rotated 208 x 110 mm */
1114     wxPAPER_PENV_5_ROTATED,     /* PRC Envelope #5 Rotated 220 x 110 mm */
1115     wxPAPER_PENV_6_ROTATED,     /* PRC Envelope #6 Rotated 230 x 120 mm */
1116     wxPAPER_PENV_7_ROTATED,     /* PRC Envelope #7 Rotated 230 x 160 mm */
1117     wxPAPER_PENV_8_ROTATED,     /* PRC Envelope #8 Rotated 309 x 120 mm */
1118     wxPAPER_PENV_9_ROTATED,     /* PRC Envelope #9 Rotated 324 x 229 mm */
1119     wxPAPER_PENV_10_ROTATED    /* PRC Envelope #10 Rotated 458 x 324 m */
1120
1121 } wxPaperSize ;
1122
1123 typedef enum {
1124     wxDUPLEX_SIMPLEX, // Non-duplex
1125     wxDUPLEX_HORIZONTAL,
1126     wxDUPLEX_VERTICAL
1127 } wxDuplexMode;
1128
1129
1130
1131 // menu and toolbar item kinds
1132 enum wxItemKind
1133 {
1134     wxITEM_SEPARATOR,
1135     wxITEM_NORMAL,
1136     wxITEM_CHECK,
1137     wxITEM_RADIO,
1138     wxITEM_MAX
1139 };
1140
1141
1142 enum wxHitTest
1143 {
1144     wxHT_NOWHERE,
1145
1146     // scrollbar
1147     wxHT_SCROLLBAR_FIRST = wxHT_NOWHERE,
1148     wxHT_SCROLLBAR_ARROW_LINE_1,    // left or upper arrow to scroll by line
1149     wxHT_SCROLLBAR_ARROW_LINE_2,    // right or down
1150     wxHT_SCROLLBAR_ARROW_PAGE_1,    // left or upper arrow to scroll by page
1151     wxHT_SCROLLBAR_ARROW_PAGE_2,    // right or down
1152     wxHT_SCROLLBAR_THUMB,           // on the thumb
1153     wxHT_SCROLLBAR_BAR_1,           // bar to the left/above the thumb
1154     wxHT_SCROLLBAR_BAR_2,           // bar to the right/below the thumb
1155     wxHT_SCROLLBAR_LAST,
1156
1157     // window
1158     wxHT_WINDOW_OUTSIDE,            // not in this window at all
1159     wxHT_WINDOW_INSIDE,             // in the client area
1160     wxHT_WINDOW_VERT_SCROLLBAR,     // on the vertical scrollbar
1161     wxHT_WINDOW_HORZ_SCROLLBAR,     // on the horizontal scrollbar
1162     wxHT_WINDOW_CORNER,             // on the corner between 2 scrollbars
1163
1164     wxHT_MAX
1165 };
1166
1167
1168
1169 enum wxKeyModifier
1170 {
1171     wxMOD_NONE,
1172     wxMOD_ALT,
1173     wxMOD_CONTROL,
1174     wxMOD_ALTGR,
1175     wxMOD_SHIFT,
1176     wxMOD_META,
1177     wxMOD_WIN,
1178     wxMOD_CMD,
1179     wxMOD_ALL
1180 };
1181
1182
1183 enum wxUpdateUI
1184 {
1185     wxUPDATE_UI_NONE          = 0x0000,
1186     wxUPDATE_UI_RECURSE       = 0x0001,
1187     wxUPDATE_UI_FROMIDLE      = 0x0002 // Invoked from On(Internal)Idle
1188 };
1189
1190
1191
1192 //---------------------------------------------------------------------------
1193