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