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