1 #----------------------------------------------------------------------------
3 # Authors: Will Sadkin, Jeff Childers
4 # Email: wsadkin@parlancecorp.com, jchilders_98@yahoo.com
6 # Copyright: (c) 2003 by Jeff Childers, Will Sadkin, 2003
7 # Portions: (c) 2002 by Will Sadkin, 2002-2007
9 # License: wxWidgets license
10 #----------------------------------------------------------------------------
12 # MaskedEdit controls are based on a suggestion made on [wxPython-Users] by
13 # Jason Hihn, and borrows liberally from Will Sadkin's original masked edit
14 # control for time entry, TimeCtrl (which is now rewritten using this
17 # MaskedEdit controls do not normally use validators, because they do
18 # careful manipulation of the cursor in the text window on each keystroke,
19 # and validation is cursor-position specific, so the control intercepts the
20 # key codes before the validator would fire. However, validators can be
21 # provided to do data transfer to the controls.
23 #----------------------------------------------------------------------------
25 # This file now contains the bulk of the logic behind all masked controls,
26 # the MaskedEditMixin class, the Field class, and the autoformat codes.
28 #----------------------------------------------------------------------------
30 # 03/30/2004 - Will Sadkin (wsadkin@parlancecorp.com)
32 # o Split out TextCtrl, ComboBox and IpAddrCtrl into their own files,
33 # o Reorganized code into masked package
35 # 12/09/2003 - Jeff Grimmett (grimmtooth@softhome.net)
37 # o Updated for wx namespace. No guarantees. This is one huge file.
39 # 12/13/2003 - Jeff Grimmett (grimmtooth@softhome.net)
41 # o Missed wx.DateTime stuff earlier.
43 # 12/20/2003 - Jeff Grimmett (grimmtooth@softhome.net)
45 # o MaskedEditMixin -> MaskedEditMixin
46 # o wxMaskedTextCtrl -> maskedTextCtrl
47 # o wxMaskedComboBoxSelectEvent -> MaskedComboBoxSelectEvent
48 # o wxMaskedComboBox -> MaskedComboBox
49 # o wxIpAddrCtrl -> IpAddrCtrl
50 # o wxTimeCtrl -> TimeCtrl
54 contains MaskedEditMixin class that drives all the other masked controls.
61 is a sublassed text control that can carefully control the user's input
62 based on a mask string you provide.
64 General usage example::
66 control = masked.TextCtrl( win, -1, '', mask = '(###) ###-####')
68 The example above will create a text control that allows only numbers to be
69 entered and then only in the positions indicated in the mask by the # sign.
72 is a similar subclass of wxComboBox that allows the same sort of masking,
73 but also can do auto-complete of values, and can require the value typed
74 to be in the list of choices to be colored appropriately.
77 is actually a factory function for several types of masked edit controls:
79 ================= ==================================================
80 masked.TextCtrl standard masked edit text box
81 masked.ComboBox adds combobox capabilities
82 masked.IpAddrCtrl adds special semantics for IP address entry
83 masked.TimeCtrl special subclass handling lots of types as values
84 masked.NumCtrl special subclass handling numeric values
85 ================= ==================================================
87 It works by looking for a *controlType* parameter in the keyword
88 arguments of the control, to determine what kind of instance to return.
89 If not specified as a keyword argument, the default control type returned
90 will be masked.TextCtrl.
92 Each of the above classes has its own set of arguments, but masked.Ctrl
93 provides a single "unified" interface for masked controls.
95 What follows is a description of how to configure the generic masked.TextCtrl
96 and masked.ComboBox; masked.NumCtrl and masked.TimeCtrl have their own demo
97 pages and interface descriptions.
99 =========================
101 Initialization Parameters
102 -------------------------
104 Allowed mask characters and function:
106 ========= ==========================================================
108 ========= ==========================================================
109 # Allow numeric only (0-9)
110 N Allow letters and numbers (0-9)
111 A Allow uppercase letters only
112 a Allow lowercase letters only
113 C Allow any letter, upper or lower
114 X Allow string.letters, string.punctuation, string.digits
115 & Allow string.punctuation only (doesn't include all unicode symbols)
116 \* Allow any visible character
117 | explicit field boundary (takes no space in the control; allows mix
118 of adjacent mask characters to be treated as separate fields,
119 eg: '&|###' means "field 0 = '&', field 1 = '###'", but there's
120 no fixed characters in between.
121 ========= ==========================================================
124 These controls define these sets of characters using string.letters,
125 string.uppercase, etc. These sets are affected by the system locale
126 setting, so in order to have the masked controls accept characters
127 that are specific to your users' language, your application should
129 For example, to allow international characters to be used in the
130 above masks, you can place the following in your code as part of
131 your application's initialization code::
134 locale.setlocale(locale.LC_ALL, '')
136 The controls now also support (by popular demand) all "visible" characters,
137 by use of the * mask character, including unicode characters above
138 the standard ANSI keycode range.
139 Note: As string.punctuation doesn't typically include all unicode
140 symbols, you will have to use includechars to get some of these into
141 otherwise restricted positions in your control, such as those specified
144 Using these mask characters, a variety of template masks can be built. See
145 the demo for some other common examples include date+time, social security
146 number, etc. If any of these characters are needed as template rather
147 than mask characters, they can be escaped with \, ie. \N means "literal N".
148 (use \\ for literal backslash, as in: r'CCC\\NNN'.)
152 Masks containing only # characters and one optional decimal point
153 character are handled specially, as "numeric" controls. Such
154 controls have special handling for typing the '-' key, handling
155 the "decimal point" character as truncating the integer portion,
156 optionally allowing grouping characters and so forth.
157 There are several parameters and format codes that only make sense
158 when combined with such masks, eg. groupChar, decimalChar, and so
159 forth (see below). These allow you to construct reasonable
160 numeric entry controls.
163 Changing the mask for a control deletes any previous field classes
164 (and any associated validation or formatting constraints) for them.
167 By default, masked edit controls use a fixed width font, so that
168 the mask characters are fixed within the control, regardless of
169 subsequent modifications to the value. Set to False if having
170 the control font be the same as other controls is required. (This is
171 a control-level parameter.)
174 (Applies to unicode systems only) By default, the default unicode encoding
175 used is latin1, or iso-8859-1. If necessary, you can set this control-level
176 parameter to govern the codec used to decode your keyboard inputs.
177 (This is a control-level parameter.)
180 These other properties can be passed to the class when instantiating it:
181 Formatcodes are specified as a string of single character formatting
182 codes that modify behavior of the control::
187 R Right-align field(s)
188 r Right-insert in field(s) (implies R)
189 < Stay in field until explicit navigation out of it
191 > Allow insert/delete within partially filled fields (as
192 opposed to the default "overwrite" mode for fixed-width
193 masked edit controls.) This allows single-field controls
194 or each field within a multi-field control to optionally
195 behave more like standard text controls.
196 (See EMAIL or phone number autoformat examples.)
198 *Note: This also governs whether backspace/delete operations
199 shift contents of field to right of cursor, or just blank the
202 Also, when combined with 'r', this indicates that the field
203 or control allows right insert anywhere within the current
204 non-empty value in the field. (Otherwise right-insert behavior
205 is only performed to when the entire right-insertable field is
206 selected or the cursor is at the right edge of the field.*
209 , Allow grouping character in integer fields of numeric controls
210 and auto-group/regroup digits (if the result fits) when leaving
211 such a field. (If specified, .SetValue() will attempt to
213 ',' is also the default grouping character. To change the
214 grouping character and/or decimal character, use the groupChar
215 and decimalChar parameters, respectively.
216 Note: typing the "decimal point" character in such fields will
217 clip the value to that left of the cursor for integer
218 fields of controls with "integer" or "floating point" masks.
219 If the ',' format code is specified, this will also cause the
220 resulting digits to be regrouped properly, using the current
222 - Prepend and reserve leading space for sign to mask and allow
223 signed values (negative #s shown in red by default.) Can be
224 used with argument useParensForNegatives (see below.)
225 0 integer fields get leading zeros
228 F Auto-Fit: the control calulates its size from
229 the length of the template mask
230 V validate entered chars against validRegex before allowing them
231 to be entered vs. being allowed by basic mask and then having
232 the resulting value just colored as invalid.
233 (See USSTATE autoformat demo for how this can be used.)
234 S select entire field when navigating to new field
239 These controls have two options for the initial state of the control.
240 If a blank control with just the non-editable characters showing
241 is desired, simply leave the constructor variable fillChar as its
242 default (' '). If you want some other character there, simply
243 change the fillChar to that value. Note: changing the control's fillChar
244 will implicitly reset all of the fields' fillChars to this value.
246 If you need different default characters in each mask position,
247 you can specify a defaultValue parameter in the constructor, or
248 set them for each field individually.
249 This value must satisfy the non-editable characters of the mask,
250 but need not conform to the replaceable characters.
255 These parameters govern what character is used to group numbers
256 and is used to indicate the decimal point for numeric format controls.
257 The default groupChar is ',', the default decimalChar is '.'
258 By changing these, you can customize the presentation of numbers
263 formatcodes = ',', groupChar='\'' allows 12'345.34
264 formatcodes = ',', groupChar='.', decimalChar=',' allows 12.345,34
266 (These are control-level parameters.)
269 The default "shiftDecimalChar" (used for "backwards-tabbing" until
270 shift-tab is fixed in wxPython) is '>' (for QUERTY keyboards.) for
271 other keyboards, you may want to customize this, eg '?' for shift ',' on
272 AZERTY keyboards, ':' or ';' for other European keyboards, etc.
273 (This is a control-level parameter.)
275 useParensForNegatives=False
276 This option can be used with signed numeric format controls to
277 indicate signs via () rather than '-'.
278 (This is a control-level parameter.)
281 This option can be used to have a field or the control try to
282 auto-complete on each keystroke if choices have been specified.
284 autoCompleteKeycodes=[]
285 By default, DownArrow, PageUp and PageDown will auto-complete a
286 partially entered field. Shift-DownArrow, Shift-UpArrow, PageUp
287 and PageDown will also auto-complete, but if the field already
288 contains a matched value, these keys will cycle through the list
289 of choices forward or backward as appropriate. Shift-Up and
290 Shift-Down also take you to the next/previous field after any
291 auto-complete action.
293 Additional auto-complete keys can be specified via this parameter.
294 Any keys so specified will act like PageDown.
295 (This is a control-level parameter.)
299 Validating User Input
300 =====================
301 There are a variety of initialization parameters that are used to validate
302 user input. These parameters can apply to the control as a whole, and/or
303 to individual fields:
305 ===================== ==================================================================
306 excludeChars A string of characters to exclude even if otherwise allowed
307 includeChars A string of characters to allow even if otherwise disallowed
308 validRegex Use a regular expression to validate the contents of the text box
309 validRange Pass a rangeas list (low,high) to limit numeric fields/values
310 choices A list of strings that are allowed choices for the control.
311 choiceRequired value must be member of choices list
312 compareNoCase Perform case-insensitive matching when validating against list
313 *Note: for masked.ComboBox, this defaults to True.*
314 emptyInvalid Boolean indicating whether an empty value should be considered
317 validFunc A function to call of the form: bool = func(candidate_value)
318 which will return True if the candidate_value satisfies some
319 external criteria for the control in addition to the the
320 other validation, or False if not. (This validation is
321 applied last in the chain of validations.)
323 validRequired Boolean indicating whether or not keys that are allowed by the
324 mask, but result in an invalid value are allowed to be entered
325 into the control. Setting this to True implies that a valid
326 default value is set for the control.
328 retainFieldValidation False by default; if True, this allows individual fields to
329 retain their own validation constraints independently of any
330 subsequent changes to the control's overall parameters.
331 (This is a control-level parameter.)
333 validator Validators are not normally needed for masked controls, because
334 of the nature of the validation and control of input. However,
335 you can supply one to provide data transfer routines for the
337 raiseOnInvalidPaste False by default; normally a bad paste simply is ignored with a bell;
338 if True, this will cause a ValueError exception to be thrown,
339 with the .value attribute of the exception containing the bad value.
341 stopFieldChangeIfInvalid
342 False by default; tries to prevent navigation out of a field if its
343 current value is invalid. Can be used to create a hybrid of validation
344 settings, allowing intermediate invalid values in a field without
345 sacrificing ability to limit values as with validRequired.
346 NOTE: It is possible to end up with an invalid value when using
347 this option if focus is switched to some other control via mousing.
348 To avoid this, consider deriving a class that defines _LostFocus()
349 function that returns the control to a valid value when the focus
350 shifts. (AFAICT, The change in focus is unpreventable.)
351 ===================== =================================================================
356 The following parameters have been provided to allow you to change the default
357 coloring behavior of the control. These can be set at construction, or via
358 the .SetCtrlParameters() function. Pass a color as string e.g. 'Yellow':
360 ======================== =======================================================================
361 emptyBackgroundColour Control Background color when identified as empty. Default=White
362 invalidBackgroundColour Control Background color when identified as Not valid. Default=Yellow
363 validBackgroundColour Control Background color when identified as Valid. Default=white
364 ======================== =======================================================================
367 The following parameters control the default foreground color coloring behavior of the
368 control. Pass a color as string e.g. 'Yellow':
370 ======================== ======================================================================
371 foregroundColour Control foreground color when value is not negative. Default=Black
372 signedForegroundColour Control foreground color when value is negative. Default=Red
373 ======================== ======================================================================
378 Each part of the mask that allows user input is considered a field. The fields
379 are represented by their own class instances. You can specify field-specific
380 constraints by constructing or accessing the field instances for the control
381 and then specifying those constraints via parameters.
384 This parameter allows you to specify Field instances containing
385 constraints for the individual fields of a control, eg: local
386 choice lists, validation rules, functions, regexps, etc.
387 It can be either an ordered list or a dictionary. If a list,
388 the fields will be applied as fields 0, 1, 2, etc.
389 If a dictionary, it should be keyed by field index.
390 the values should be a instances of maskededit.Field.
392 Any field not represented by the list or dictionary will be
393 implicitly created by the control.
397 fields = [ Field(formatcodes='_r'), Field('choices=['a', 'b', 'c']) ]
402 1: ( Field(formatcodes='_R', choices=['a', 'b', 'c']),
403 3: ( Field(choices=['01', '02', '03'], choiceRequired=True)
406 The following parameters are available for individual fields, with the
407 same semantics as for the whole control but applied to the field in question:
409 ============== =============================================================================
410 fillChar if set for a field, it will override the control's fillChar for that field
411 groupChar if set for a field, it will override the control's default
412 defaultValue sets field-specific default value; overrides any default from control
413 compareNoCase overrides control's settings
414 emptyInvalid determines whether field is required to be filled at all times
415 validRequired if set, requires field to contain valid value
416 ============== =============================================================================
418 If any of the above parameters are subsequently specified for the control as a
419 whole, that new value will be propagated to each field, unless the
420 retainFieldValidation control-level parameter is set.
422 ============== ==============================
423 formatcodes Augments control's settings
431 ============== ==============================
435 Control Class Functions
436 =======================
437 .GetPlainValue(value=None)
438 Returns the value specified (or the control's text value
439 not specified) without the formatting text.
440 In the example above, might return phone no='3522640075',
441 whereas control.GetValue() would return '(352) 264-0075'
443 Returns the control's value to its default, and places the
444 cursor at the beginning of the control.
446 Does "smart replacement" of passed value into the control, as does
447 the .Paste() method. As with other text entry controls, the
448 .SetValue() text replacement begins at left-edge of the control,
449 with missing mask characters inserted as appropriate.
450 .SetValue will also adjust integer, float or date mask entry values,
451 adding commas, auto-completing years, etc. as appropriate.
452 For "right-aligned" numeric controls, it will also now automatically
453 right-adjust any value whose length is less than the width of the
454 control before attempting to set the value.
455 If a value does not follow the format of the control's mask, or will
456 not fit into the control, a ValueError exception will be raised.
460 mask = '(###) ###-####'
461 .SetValue('1234567890') => '(123) 456-7890'
462 .SetValue('(123)4567890') => '(123) 456-7890'
463 .SetValue('(123)456-7890') => '(123) 456-7890'
464 .SetValue('123/4567-890') => illegal paste; ValueError
466 mask = '#{6}.#{2}', formatcodes = '_,-',
467 .SetValue('111') => ' 111 . '
468 .SetValue(' %9.2f' % -111.12345 ) => ' -111.12'
469 .SetValue(' %9.2f' % 1234.00 ) => ' 1,234.00'
470 .SetValue(' %9.2f' % -1234567.12345 ) => insufficient room; ValueError
472 mask = '#{6}.#{2}', formatcodes = '_,-R' # will right-adjust value for right-aligned control
473 .SetValue('111') => padded value misalignment ValueError: " 111" will not fit
474 .SetValue('%.2f' % 111 ) => ' 111.00'
475 .SetValue('%.2f' % -111.12345 ) => ' -111.12'
479 Returns True if the value specified (or the value of the control
480 if not specified) passes validation tests
482 Returns True if the value specified (or the value of the control
483 if not specified) is equal to an "empty value," ie. all
484 editable characters == the fillChar for their respective fields.
485 .IsDefault(value=None)
486 Returns True if the value specified (or the value of the control
487 if not specified) is equal to the initial value of the control.
490 Recolors the control as appropriate to its current settings.
492 .SetCtrlParameters(\*\*kwargs)
493 This function allows you to set up and/or change the control parameters
494 after construction; it takes a list of key/value pairs as arguments,
495 where the keys can be any of the mask-specific parameters in the constructor.
499 ctl = masked.TextCtrl( self, -1 )
500 ctl.SetCtrlParameters( mask='###-####',
501 defaultValue='555-1212',
504 .GetCtrlParameter(parametername)
505 This function allows you to retrieve the current value of a parameter
508 *Note:* Each of the control parameters can also be set using its
509 own Set and Get function. These functions follow a regular form:
510 All of the parameter names start with lower case; for their
511 corresponding Set/Get function, the parameter name is capitalized.
515 ctl.SetMask('###-####')
516 ctl.SetDefaultValue('555-1212')
517 ctl.GetChoiceRequired()
520 *Note:* After any change in parameters, the choices for the
521 control are reevaluated to ensure that they are still legal. If you
522 have large choice lists, it is therefore more efficient to set parameters
523 before setting the choices available.
525 .SetFieldParameters(field_index, \*\*kwargs)
526 This function allows you to specify change individual field
527 parameters after construction. (Indices are 0-based.)
529 .GetFieldParameter(field_index, parametername)
530 Allows the retrieval of field parameters after construction
533 The control detects certain common constructions. In order to use the signed feature
534 (negative numbers and coloring), the mask has to be all numbers with optionally one
535 decimal point. Without a decimal (e.g. '######', the control will treat it as an integer
536 value. With a decimal (e.g. '###.##'), the control will act as a floating point control
537 (i.e. press decimal to 'tab' to the decimal position). Pressing decimal in the
538 integer control truncates the value. However, for a true numeric control,
539 masked.NumCtrl provides all this, and true numeric input/output support as well.
542 Check your controls by calling each control's .IsValid() function and the
543 .IsEmpty() function to determine which controls have been a) filled in and
544 b) filled in properly.
547 Regular expression validations can be used flexibly and creatively.
548 Take a look at the demo; the zip-code validation succeeds as long as the
549 first five numerals are entered. the last four are optional, but if
550 any are entered, there must be 4 to be valid.
552 masked.Ctrl Configuration
553 =========================
554 masked.Ctrl works by looking for a special *controlType*
555 parameter in the variable arguments of the control, to determine
556 what kind of instance to return.
557 controlType can be one of::
565 These constants are also available individually, ie, you can
566 use either of the following::
568 from wxPython.wx.lib.masked import MaskedCtrl, controlTypes
569 from wxPython.wx.lib.masked import MaskedCtrl, COMBO, TEXT, NUMBER, IPADDR
571 If not specified as a keyword argument, the default controlType is
577 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
582 All methods of the Mixin that are not meant to be exposed to the external
583 interface are prefaced with '_'. Those functions that are primarily
584 intended to be internal subroutines subsequently start with a lower-case
585 letter; those that are primarily intended to be used and/or overridden
586 by derived subclasses start with a capital letter.
588 The following methods must be used and/or defined when deriving a control
589 from MaskedEditMixin. NOTE: if deriving from a *masked edit* control
590 (eg. class IpAddrCtrl(masked.TextCtrl) ), then this is NOT necessary,
591 as it's already been done for you in the base class.
594 This function must be called after the associated base
595 control has been initialized in the subclass __init__
596 function. It sets the initial value of the control,
597 either to the value specified if non-empty, the
598 default value if specified, or the "template" for
599 the empty control as necessary. It will also set/reset
600 the font if necessary and apply formatting to the
601 control at this time.
605 Each class derived from MaskedEditMixin must define
606 the function for getting the start and end of the
607 current text selection. The reason for this is
608 that not all controls have the same function name for
609 doing this; eg. wx.TextCtrl uses .GetSelection(),
610 whereas we had to write a .GetMark() function for
611 wxComboBox, because .GetSelection() for the control
612 gets the currently selected list item from the combo
613 box, and the control doesn't (yet) natively provide
614 a means of determining the text selection.
617 Similarly to _GetSelection, each class derived from
618 MaskedEditMixin must define the function for setting
619 the start and end of the current text selection.
620 (eg. .SetSelection() for masked.TextCtrl, and .SetMark() for
623 ._GetInsertionPoint()
624 ._SetInsertionPoint()
626 For consistency, and because the mixin shouldn't rely
627 on fixed names for any manipulations it does of any of
628 the base controls, we require each class derived from
629 MaskedEditMixin to define these functions as well.
632 ._SetValue() REQUIRED
633 Each class derived from MaskedEditMixin must define
634 the functions used to get and set the raw value of the
636 This is necessary so that recursion doesn't take place
637 when setting the value, and so that the mixin can
638 call the appropriate function after doing all its
639 validation and manipulation without knowing what kind
640 of base control it was mixed in with. To handle undo
641 functionality, the ._SetValue() must record the current
642 selection prior to setting the value.
648 Each class derived from MaskedEditMixin must redefine
649 these functions to call the _Cut(), _Paste(), _Undo()
650 and _SetValue() methods, respectively for the control,
651 so as to prevent programmatic corruption of the control's
652 value. This must be done in each derivation, as the
653 mixin cannot itself override a member of a sibling class.
656 Each class derived from MaskedEditMixin must define
657 the function used to refresh the base control.
660 Each class derived from MaskedEditMixin must redefine
661 this function so that it checks the validity of the
662 control (via self._CheckValid) and then refreshes
663 control using the base class method.
665 ._IsEditable() REQUIRED
666 Each class derived from MaskedEditMixin must define
667 the function used to determine if the base control is
668 editable or not. (For masked.ComboBox, this has to
669 be done with code, rather than specifying the proper
670 function in the base control, as there isn't one...)
671 ._CalcSize() REQUIRED
672 Each class derived from MaskedEditMixin must define
673 the function used to determine how wide the control
674 should be given the mask. (The mixin function
675 ._calcSize() provides a baseline estimate.)
680 Event handlers are "chained", and MaskedEditMixin usually
681 swallows most of the events it sees, thereby preventing any other
682 handlers from firing in the chain. It is therefore required that
683 each class derivation using the mixin to have an option to hook up
684 the event handlers itself or forego this operation and let a
685 subclass of the masked control do so. For this reason, each
686 subclass should probably include the following code:
688 if setupEventHandling:
689 ## Setup event handlers
690 EVT_SET_FOCUS( self, self._OnFocus ) ## defeat automatic full selection
691 EVT_KILL_FOCUS( self, self._OnKillFocus ) ## run internal validator
692 EVT_LEFT_DCLICK(self, self._OnDoubleClick) ## select field under cursor on dclick
693 EVT_RIGHT_UP(self, self._OnContextMenu ) ## bring up an appropriate context menu
694 EVT_KEY_DOWN( self, self._OnKeyDown ) ## capture control events not normally seen, eg ctrl-tab.
695 EVT_CHAR( self, self._OnChar ) ## handle each keypress
696 EVT_TEXT( self, self.GetId(), self._OnTextChange ) ## color control appropriately & keep
697 ## track of previous value for undo
699 where setupEventHandling is an argument to its constructor.
701 These 5 handlers must be "wired up" for the masked edit
702 controls to provide default behavior. (The setupEventHandling
703 is an argument to masked.TextCtrl and masked.ComboBox, so
704 that controls derived from *them* may replace one of these
705 handlers if they so choose.)
707 If your derived control wants to preprocess events before
708 taking action, it should then set up the event handling itself,
709 so it can be first in the event handler chain.
712 The following routines are available to facilitate changing
713 the default behavior of masked edit controls:
715 ._SetKeycodeHandler(keycode, func)
716 ._SetKeyHandler(char, func)
717 Use to replace default handling for any given keycode.
718 func should take the key event as argument and return
719 False if no further action is required to handle the
721 self._SetKeycodeHandler(WXK_UP, self.IncrementValue)
722 self._SetKeyHandler('-', self._OnChangeSign)
724 (Setting a func of None removes any keyhandler for the given key.)
726 "Navigation" keys are assumed to change the cursor position, and
727 therefore don't cause automatic motion of the cursor as insertable
730 ._AddNavKeycode(keycode, handler=None)
731 ._AddNavKey(char, handler=None)
732 Allows controls to specify other keys (and optional handlers)
733 to be treated as navigational characters. (eg. '.' in IpAddrCtrl)
735 ._GetNavKeycodes() Returns the current list of navigational keycodes.
737 ._SetNavKeycodes(key_func_tuples)
738 Allows replacement of the current list of keycode
739 processed as navigation keys, and bind associated
740 optional keyhandlers. argument is a list of key/handler
741 tuples. Passing a value of None for the handler in a
742 given tuple indicates that default processing for the key
745 ._FindField(pos) Returns the Field object associated with this position
748 ._FindFieldExtent(pos, getslice=False, value=None)
749 Returns edit_start, edit_end of the field corresponding
750 to the specified position within the control, and
751 optionally also returns the current contents of that field.
752 If value is specified, it will retrieve the slice the corresponding
753 slice from that value, rather than the current value of the
757 This is, the function that gets called for a given position
758 whenever the cursor is adjusted to leave a given field.
759 By default, it adjusts the year in date fields if mask is a date,
760 It can be overridden by a derived class to
761 adjust the value of the control at that time.
762 (eg. IpAddrCtrl reformats the address in this way.)
764 ._Change() Called by internal EVT_TEXT handler. Return False to force
765 skip of the normal class change event.
766 ._Keypress(key) Called by internal EVT_CHAR handler. Return False to force
767 skip of the normal class keypress event.
768 ._LostFocus() Called by internal EVT_KILL_FOCUS handler
771 This is the default EVT_KEY_DOWN routine; it just checks for
772 "navigation keys", and if event.ControlDown(), it fires the
773 mixin's _OnChar() routine, as such events are not always seen
774 by the "cooked" EVT_CHAR routine.
776 ._OnChar(event) This is the main EVT_CHAR handler for the
779 The following routines are used to handle standard actions
781 _OnArrow(event) used for arrow navigation events
782 _OnCtrl_A(event) 'select all'
783 _OnCtrl_C(event) 'copy' (uses base control function, as copy is non-destructive)
784 _OnCtrl_S(event) 'save' (does nothing)
785 _OnCtrl_V(event) 'paste' - calls _Paste() method, to do smart paste
786 _OnCtrl_X(event) 'cut' - calls _Cut() method, to "erase" selection
787 _OnCtrl_Z(event) 'undo' - resets value to previous value (if any)
789 _OnChangeField(event) primarily used for tab events, but can be
790 used for other keys (eg. '.' in IpAddrCtrl)
792 _OnErase(event) used for backspace and delete
796 The following routine provides a hook back to any class derivations, so that
797 they can react to parameter changes before any value is set/reset as a result of
798 those changes. (eg. masked.ComboBox needs to detect when the choices list is
799 modified, either implicitly or explicitly, so it can reset the base control
800 to have the appropriate choice list *before* the initial value is reset to match.)
802 _OnCtrlParametersChanged()
806 For convenience, each class derived from MaskedEditMixin should
807 define an accessors mixin, so that it exposes only those parameters
808 that make sense for the derivation. This is done with an intermediate
809 level of inheritance, ie:
811 class BaseMaskedTextCtrl( TextCtrl, MaskedEditMixin ):
813 class TextCtrl( BaseMaskedTextCtrl, MaskedEditAccessorsMixin ):
814 class ComboBox( BaseMaskedComboBox, MaskedEditAccessorsMixin ):
815 class NumCtrl( BaseMaskedTextCtrl, MaskedNumCtrlAccessorsMixin ):
816 class IpAddrCtrl( BaseMaskedTextCtrl, IpAddrCtrlAccessorsMixin ):
817 class TimeCtrl( BaseMaskedTextCtrl, TimeCtrlAccessorsMixin ):
821 Each accessors mixin defines Get/Set functions for the base class parameters
822 that are appropriate for that derivation.
823 This allows the base classes to be "more generic," exposing the widest
824 set of options, while not requiring derived classes to be so general.
835 # jmg 12/9/03 - when we cut ties with Py 2.2 and earlier, this would
836 # be a good place to implement the 2.3 logger class
837 from wx
.tools
.dbg
import Logger
842 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
844 ## Constants for identifying control keys and classes of keys:
846 WXK_CTRL_A
= (ord('A')+1) - ord('A') ## These keys are not already defined in wx
847 WXK_CTRL_C
= (ord('C')+1) - ord('A')
848 WXK_CTRL_S
= (ord('S')+1) - ord('A')
849 WXK_CTRL_V
= (ord('V')+1) - ord('A')
850 WXK_CTRL_X
= (ord('X')+1) - ord('A')
851 WXK_CTRL_Z
= (ord('Z')+1) - ord('A')
854 wx
.WXK_BACK
, wx
.WXK_LEFT
, wx
.WXK_RIGHT
, wx
.WXK_UP
, wx
.WXK_DOWN
, wx
.WXK_TAB
,
855 wx
.WXK_HOME
, wx
.WXK_END
, wx
.WXK_RETURN
, wx
.WXK_PRIOR
, wx
.WXK_NEXT
,
856 wx
.WXK_NUMPAD_LEFT
, wx
.WXK_NUMPAD_RIGHT
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_DOWN
,
857 wx
.WXK_NUMPAD_HOME
, wx
.WXK_NUMPAD_END
, wx
.WXK_NUMPAD_ENTER
, wx
.WXK_NUMPAD_PRIOR
, wx
.WXK_NUMPAD_NEXT
861 wx
.WXK_BACK
, wx
.WXK_DELETE
, wx
.WXK_INSERT
,
862 wx
.WXK_NUMPAD_DELETE
, wx
.WXK_NUMPAD_INSERT
,
863 WXK_CTRL_A
, WXK_CTRL_C
, WXK_CTRL_S
, WXK_CTRL_V
,
864 WXK_CTRL_X
, WXK_CTRL_Z
867 # Because unicode can go over the ansi character range, we need to explicitly test
868 # for all non-visible keystrokes, rather than just assuming a particular range for
869 # visible characters:
870 wx_control_keycodes
= range(32) + list(nav
) + list(control
) + [
871 wx
.WXK_START
, wx
.WXK_LBUTTON
, wx
.WXK_RBUTTON
, wx
.WXK_CANCEL
, wx
.WXK_MBUTTON
,
872 wx
.WXK_CLEAR
, wx
.WXK_SHIFT
, wx
.WXK_CONTROL
, wx
.WXK_MENU
, wx
.WXK_PAUSE
,
873 wx
.WXK_CAPITAL
, wx
.WXK_SELECT
, wx
.WXK_PRINT
, wx
.WXK_EXECUTE
, wx
.WXK_SNAPSHOT
,
874 wx
.WXK_HELP
, wx
.WXK_NUMPAD0
, wx
.WXK_NUMPAD1
, wx
.WXK_NUMPAD2
, wx
.WXK_NUMPAD3
,
875 wx
.WXK_NUMPAD4
, wx
.WXK_NUMPAD5
, wx
.WXK_NUMPAD6
, wx
.WXK_NUMPAD7
, wx
.WXK_NUMPAD8
,
876 wx
.WXK_NUMPAD9
, wx
.WXK_MULTIPLY
, wx
.WXK_ADD
, wx
.WXK_SEPARATOR
, wx
.WXK_SUBTRACT
,
877 wx
.WXK_DECIMAL
, wx
.WXK_DIVIDE
, wx
.WXK_F1
, wx
.WXK_F2
, wx
.WXK_F3
, wx
.WXK_F4
,
878 wx
.WXK_F5
, wx
.WXK_F6
, wx
.WXK_F7
, wx
.WXK_F8
, wx
.WXK_F9
, wx
.WXK_F10
, wx
.WXK_F11
,
879 wx
.WXK_F12
, wx
.WXK_F13
, wx
.WXK_F14
, wx
.WXK_F15
, wx
.WXK_F16
, wx
.WXK_F17
,
880 wx
.WXK_F18
, wx
.WXK_F19
, wx
.WXK_F20
, wx
.WXK_F21
, wx
.WXK_F22
, wx
.WXK_F23
,
881 wx
.WXK_F24
, wx
.WXK_NUMLOCK
, wx
.WXK_SCROLL
, wx
.WXK_PAGEUP
, wx
.WXK_PAGEDOWN
,
882 wx
.WXK_NUMPAD_SPACE
, wx
.WXK_NUMPAD_TAB
, wx
.WXK_NUMPAD_ENTER
, wx
.WXK_NUMPAD_F1
,
883 wx
.WXK_NUMPAD_F2
, wx
.WXK_NUMPAD_F3
, wx
.WXK_NUMPAD_F4
, wx
.WXK_NUMPAD_HOME
,
884 wx
.WXK_NUMPAD_LEFT
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_RIGHT
, wx
.WXK_NUMPAD_DOWN
,
885 wx
.WXK_NUMPAD_PRIOR
, wx
.WXK_NUMPAD_PAGEUP
, wx
.WXK_NUMPAD_NEXT
, wx
.WXK_NUMPAD_PAGEDOWN
,
886 wx
.WXK_NUMPAD_END
, wx
.WXK_NUMPAD_BEGIN
, wx
.WXK_NUMPAD_INSERT
, wx
.WXK_NUMPAD_DELETE
,
887 wx
.WXK_NUMPAD_EQUAL
, wx
.WXK_NUMPAD_MULTIPLY
, wx
.WXK_NUMPAD_ADD
, wx
.WXK_NUMPAD_SEPARATOR
,
888 wx
.WXK_NUMPAD_SUBTRACT
, wx
.WXK_NUMPAD_DECIMAL
, wx
.WXK_NUMPAD_DIVIDE
, wx
.WXK_WINDOWS_LEFT
,
889 wx
.WXK_WINDOWS_RIGHT
, wx
.WXK_WINDOWS_MENU
, wx
.WXK_COMMAND
,
890 # Hardware-specific buttons
891 wx
.WXK_SPECIAL1
, wx
.WXK_SPECIAL2
, wx
.WXK_SPECIAL3
, wx
.WXK_SPECIAL4
, wx
.WXK_SPECIAL5
,
892 wx
.WXK_SPECIAL6
, wx
.WXK_SPECIAL7
, wx
.WXK_SPECIAL8
, wx
.WXK_SPECIAL9
, wx
.WXK_SPECIAL10
,
893 wx
.WXK_SPECIAL11
, wx
.WXK_SPECIAL12
, wx
.WXK_SPECIAL13
, wx
.WXK_SPECIAL14
, wx
.WXK_SPECIAL15
,
894 wx
.WXK_SPECIAL16
, wx
.WXK_SPECIAL17
, wx
.WXK_SPECIAL18
, wx
.WXK_SPECIAL19
, wx
.WXK_SPECIAL20
898 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
900 ## Constants for masking. This is where mask characters
902 ## maskchars used to identify valid mask characters from all others
903 ## # - allow numeric 0-9 only
904 ## A - allow uppercase only. Combine with forceupper to force lowercase to upper
905 ## a - allow lowercase only. Combine with forcelower to force upper to lowercase
906 ## C - allow any letter, upper or lower
907 ## X - allow string.letters, string.punctuation, string.digits
908 ## & - allow string.punctuation only (doesn't include all unicode symbols)
909 ## * - allow any visible character
911 ## Note: locale settings affect what "uppercase", lowercase, etc comprise.
912 ## Note: '|' is not a maskchar, in that it is a mask processing directive, and so
913 ## does not appear here.
915 maskchars
= ("#","A","a","X","C","N",'*','&')
917 for i
in xrange(32, 256):
920 months
= '(01|02|03|04|05|06|07|08|09|10|11|12)'
921 charmonths
= '(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)'
922 charmonths_dict
= {'jan': 1, 'feb': 2, 'mar': 3, 'apr': 4, 'may': 5, 'jun': 6,
923 'jul': 7, 'aug': 8, 'sep': 9, 'oct': 10, 'nov': 11, 'dec': 12}
925 days
= '(01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31)'
926 hours
= '(0\d| \d|1[012])'
927 milhours
= '(00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23)'
928 minutes
= """(00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|\
929 16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|\
930 36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|\
933 am_pm_exclude
= 'BCDEFGHIJKLMNOQRSTUVWXYZ\x8a\x8c\x8e\x9f\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd8\xd9\xda\xdb\xdc\xdd\xde'
935 states
= "AL,AK,AZ,AR,CA,CO,CT,DE,DC,FL,GA,GU,HI,ID,IL,IN,IA,KS,KY,LA,MA,ME,MD,MI,MN,MS,MO,MT,NE,NV,NH,NJ,NM,NY,NC,ND,OH,OK,OR,PA,PR,RI,SC,SD,TN,TX,UT,VA,VT,VI,WA,WV,WI,WY".split(',')
937 state_names
= ['Alabama','Alaska','Arizona','Arkansas',
938 'California','Colorado','Connecticut',
939 'Delaware','District of Columbia',
940 'Florida','Georgia','Hawaii',
941 'Idaho','Illinois','Indiana','Iowa',
942 'Kansas','Kentucky','Louisiana',
943 'Maine','Maryland','Massachusetts','Michigan',
944 'Minnesota','Mississippi','Missouri','Montana',
945 'Nebraska','Nevada','New Hampshire','New Jersey',
946 'New Mexico','New York','North Carolina','North Dakokta',
947 'Ohio','Oklahoma','Oregon',
948 'Pennsylvania','Puerto Rico','Rhode Island',
949 'South Carolina','South Dakota',
950 'Tennessee','Texas','Utah',
951 'Vermont','Virginia',
952 'Washington','West Virginia',
953 'Wisconsin','Wyoming']
955 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
957 ## The following dictionary defines the current set of autoformats:
961 'mask': "(###) ###-#### x:###",
962 'formatcodes': 'F^->',
963 'validRegex': "^\(\d{3}\) \d{3}-\d{4}",
964 'description': "Phone Number w/opt. ext"
967 'mask': "###-###-#### x:###",
968 'formatcodes': 'F^->',
969 'validRegex': "^\d{3}-\d{3}-\d{4}",
970 'description': "Phone Number\n (w/hyphens and opt. ext)"
973 'mask': "(###) ###-####",
974 'formatcodes': 'F^->',
975 'validRegex': "^\(\d{3}\) \d{3}-\d{4}",
976 'description': "Phone Number only"
979 'mask': "###-###-####",
980 'formatcodes': 'F^->',
981 'validRegex': "^\d{3}-\d{3}-\d{4}",
982 'description': "Phone Number\n(w/hyphens)"
986 'formatcodes': 'F!V',
987 'validRegex': "([ACDFGHIKLMNOPRSTUVW] |%s)" % string
.join(states
,'|'),
989 'choiceRequired': True,
990 'description': "US State Code"
993 'mask': "ACCCCCCCCCCCCCCCCCCC",
995 'validRegex': "([ACDFGHIKLMNOPRSTUVW] |%s)" % string
.join(state_names
,'|'),
996 'choices': state_names
,
997 'choiceRequired': True,
998 'description': "US State Name"
1001 "USDATETIMEMMDDYYYY/HHMMSS": {
1002 'mask': "##/##/#### ##:##:## AM",
1003 'excludeChars': am_pm_exclude
,
1004 'formatcodes': 'DF!',
1005 'validRegex': '^' + months
+ '/' + days
+ '/' + '\d{4} ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1006 'description': "US Date + Time"
1008 "USDATETIMEMMDDYYYY-HHMMSS": {
1009 'mask': "##-##-#### ##:##:## AM",
1010 'excludeChars': am_pm_exclude
,
1011 'formatcodes': 'DF!',
1012 'validRegex': '^' + months
+ '-' + days
+ '-' + '\d{4} ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1013 'description': "US Date + Time\n(w/hypens)"
1015 "USDATE24HRTIMEMMDDYYYY/HHMMSS": {
1016 'mask': "##/##/#### ##:##:##",
1017 'formatcodes': 'DF',
1018 'validRegex': '^' + months
+ '/' + days
+ '/' + '\d{4} ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1019 'description': "US Date + 24Hr (Military) Time"
1021 "USDATE24HRTIMEMMDDYYYY-HHMMSS": {
1022 'mask': "##-##-#### ##:##:##",
1023 'formatcodes': 'DF',
1024 'validRegex': '^' + months
+ '-' + days
+ '-' + '\d{4} ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1025 'description': "US Date + 24Hr Time\n(w/hypens)"
1027 "USDATETIMEMMDDYYYY/HHMM": {
1028 'mask': "##/##/#### ##:## AM",
1029 'excludeChars': am_pm_exclude
,
1030 'formatcodes': 'DF!',
1031 'validRegex': '^' + months
+ '/' + days
+ '/' + '\d{4} ' + hours
+ ':' + minutes
+ ' (A|P)M',
1032 'description': "US Date + Time\n(without seconds)"
1034 "USDATE24HRTIMEMMDDYYYY/HHMM": {
1035 'mask': "##/##/#### ##:##",
1036 'formatcodes': 'DF',
1037 'validRegex': '^' + months
+ '/' + days
+ '/' + '\d{4} ' + milhours
+ ':' + minutes
,
1038 'description': "US Date + 24Hr Time\n(without seconds)"
1040 "USDATETIMEMMDDYYYY-HHMM": {
1041 'mask': "##-##-#### ##:## AM",
1042 'excludeChars': am_pm_exclude
,
1043 'formatcodes': 'DF!',
1044 'validRegex': '^' + months
+ '-' + days
+ '-' + '\d{4} ' + hours
+ ':' + minutes
+ ' (A|P)M',
1045 'description': "US Date + Time\n(w/hypens and w/o secs)"
1047 "USDATE24HRTIMEMMDDYYYY-HHMM": {
1048 'mask': "##-##-#### ##:##",
1049 'formatcodes': 'DF',
1050 'validRegex': '^' + months
+ '-' + days
+ '-' + '\d{4} ' + milhours
+ ':' + minutes
,
1051 'description': "US Date + 24Hr Time\n(w/hyphens and w/o seconds)"
1053 "USDATEMMDDYYYY/": {
1054 'mask': "##/##/####",
1055 'formatcodes': 'DF',
1056 'validRegex': '^' + months
+ '/' + days
+ '/' + '\d{4}',
1057 'description': "US Date\n(MMDDYYYY)"
1061 'formatcodes': 'DF',
1062 'validRegex': '^' + months
+ '/' + days
+ '/\d\d',
1063 'description': "US Date\n(MMDDYY)"
1065 "USDATEMMDDYYYY-": {
1066 'mask': "##-##-####",
1067 'formatcodes': 'DF',
1068 'validRegex': '^' + months
+ '-' + days
+ '-' +'\d{4}',
1069 'description': "MM-DD-YYYY"
1072 "EUDATEYYYYMMDD/": {
1073 'mask': "####/##/##",
1074 'formatcodes': 'DF',
1075 'validRegex': '^' + '\d{4}'+ '/' + months
+ '/' + days
,
1076 'description': "YYYY/MM/DD"
1078 "EUDATEYYYYMMDD.": {
1079 'mask': "####.##.##",
1080 'formatcodes': 'DF',
1081 'validRegex': '^' + '\d{4}'+ '.' + months
+ '.' + days
,
1082 'description': "YYYY.MM.DD"
1084 "EUDATEDDMMYYYY/": {
1085 'mask': "##/##/####",
1086 'formatcodes': 'DF',
1087 'validRegex': '^' + days
+ '/' + months
+ '/' + '\d{4}',
1088 'description': "DD/MM/YYYY"
1090 "EUDATEDDMMYYYY.": {
1091 'mask': "##.##.####",
1092 'formatcodes': 'DF',
1093 'validRegex': '^' + days
+ '.' + months
+ '.' + '\d{4}',
1094 'description': "DD.MM.YYYY"
1096 "EUDATEDDMMMYYYY.": {
1097 'mask': "##.CCC.####",
1098 'formatcodes': 'DF',
1099 'validRegex': '^' + days
+ '.' + charmonths
+ '.' + '\d{4}',
1100 'description': "DD.Month.YYYY"
1102 "EUDATEDDMMMYYYY/": {
1103 'mask': "##/CCC/####",
1104 'formatcodes': 'DF',
1105 'validRegex': '^' + days
+ '/' + charmonths
+ '/' + '\d{4}',
1106 'description': "DD/Month/YYYY"
1109 "EUDATETIMEYYYYMMDD/HHMMSS": {
1110 'mask': "####/##/## ##:##:## AM",
1111 'excludeChars': am_pm_exclude
,
1112 'formatcodes': 'DF!',
1113 'validRegex': '^' + '\d{4}'+ '/' + months
+ '/' + days
+ ' ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1114 'description': "YYYY/MM/DD HH:MM:SS"
1116 "EUDATETIMEYYYYMMDD.HHMMSS": {
1117 'mask': "####.##.## ##:##:## AM",
1118 'excludeChars': am_pm_exclude
,
1119 'formatcodes': 'DF!',
1120 'validRegex': '^' + '\d{4}'+ '.' + months
+ '.' + days
+ ' ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1121 'description': "YYYY.MM.DD HH:MM:SS"
1123 "EUDATETIMEDDMMYYYY/HHMMSS": {
1124 'mask': "##/##/#### ##:##:## AM",
1125 'excludeChars': am_pm_exclude
,
1126 'formatcodes': 'DF!',
1127 'validRegex': '^' + days
+ '/' + months
+ '/' + '\d{4} ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1128 'description': "DD/MM/YYYY HH:MM:SS"
1130 "EUDATETIMEDDMMYYYY.HHMMSS": {
1131 'mask': "##.##.#### ##:##:## AM",
1132 'excludeChars': am_pm_exclude
,
1133 'formatcodes': 'DF!',
1134 'validRegex': '^' + days
+ '.' + months
+ '.' + '\d{4} ' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1135 'description': "DD.MM.YYYY HH:MM:SS"
1138 "EUDATETIMEYYYYMMDD/HHMM": {
1139 'mask': "####/##/## ##:## AM",
1140 'excludeChars': am_pm_exclude
,
1141 'formatcodes': 'DF!',
1142 'validRegex': '^' + '\d{4}'+ '/' + months
+ '/' + days
+ ' ' + hours
+ ':' + minutes
+ ' (A|P)M',
1143 'description': "YYYY/MM/DD HH:MM"
1145 "EUDATETIMEYYYYMMDD.HHMM": {
1146 'mask': "####.##.## ##:## AM",
1147 'excludeChars': am_pm_exclude
,
1148 'formatcodes': 'DF!',
1149 'validRegex': '^' + '\d{4}'+ '.' + months
+ '.' + days
+ ' ' + hours
+ ':' + minutes
+ ' (A|P)M',
1150 'description': "YYYY.MM.DD HH:MM"
1152 "EUDATETIMEDDMMYYYY/HHMM": {
1153 'mask': "##/##/#### ##:## AM",
1154 'excludeChars': am_pm_exclude
,
1155 'formatcodes': 'DF!',
1156 'validRegex': '^' + days
+ '/' + months
+ '/' + '\d{4} ' + hours
+ ':' + minutes
+ ' (A|P)M',
1157 'description': "DD/MM/YYYY HH:MM"
1159 "EUDATETIMEDDMMYYYY.HHMM": {
1160 'mask': "##.##.#### ##:## AM",
1161 'excludeChars': am_pm_exclude
,
1162 'formatcodes': 'DF!',
1163 'validRegex': '^' + days
+ '.' + months
+ '.' + '\d{4} ' + hours
+ ':' + minutes
+ ' (A|P)M',
1164 'description': "DD.MM.YYYY HH:MM"
1167 "EUDATE24HRTIMEYYYYMMDD/HHMMSS": {
1168 'mask': "####/##/## ##:##:##",
1169 'formatcodes': 'DF',
1170 'validRegex': '^' + '\d{4}'+ '/' + months
+ '/' + days
+ ' ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1171 'description': "YYYY/MM/DD 24Hr Time"
1173 "EUDATE24HRTIMEYYYYMMDD.HHMMSS": {
1174 'mask': "####.##.## ##:##:##",
1175 'formatcodes': 'DF',
1176 'validRegex': '^' + '\d{4}'+ '.' + months
+ '.' + days
+ ' ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1177 'description': "YYYY.MM.DD 24Hr Time"
1179 "EUDATE24HRTIMEDDMMYYYY/HHMMSS": {
1180 'mask': "##/##/#### ##:##:##",
1181 'formatcodes': 'DF',
1182 'validRegex': '^' + days
+ '/' + months
+ '/' + '\d{4} ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1183 'description': "DD/MM/YYYY 24Hr Time"
1185 "EUDATE24HRTIMEDDMMYYYY.HHMMSS": {
1186 'mask': "##.##.#### ##:##:##",
1187 'formatcodes': 'DF',
1188 'validRegex': '^' + days
+ '.' + months
+ '.' + '\d{4} ' + milhours
+ ':' + minutes
+ ':' + seconds
,
1189 'description': "DD.MM.YYYY 24Hr Time"
1191 "EUDATE24HRTIMEYYYYMMDD/HHMM": {
1192 'mask': "####/##/## ##:##",
1193 'formatcodes': 'DF','validRegex': '^' + '\d{4}'+ '/' + months
+ '/' + days
+ ' ' + milhours
+ ':' + minutes
,
1194 'description': "YYYY/MM/DD 24Hr Time\n(w/o seconds)"
1196 "EUDATE24HRTIMEYYYYMMDD.HHMM": {
1197 'mask': "####.##.## ##:##",
1198 'formatcodes': 'DF',
1199 'validRegex': '^' + '\d{4}'+ '.' + months
+ '.' + days
+ ' ' + milhours
+ ':' + minutes
,
1200 'description': "YYYY.MM.DD 24Hr Time\n(w/o seconds)"
1202 "EUDATE24HRTIMEDDMMYYYY/HHMM": {
1203 'mask': "##/##/#### ##:##",
1204 'formatcodes': 'DF',
1205 'validRegex': '^' + days
+ '/' + months
+ '/' + '\d{4} ' + milhours
+ ':' + minutes
,
1206 'description': "DD/MM/YYYY 24Hr Time\n(w/o seconds)"
1208 "EUDATE24HRTIMEDDMMYYYY.HHMM": {
1209 'mask': "##.##.#### ##:##",
1210 'formatcodes': 'DF',
1211 'validRegex': '^' + days
+ '.' + months
+ '.' + '\d{4} ' + milhours
+ ':' + minutes
,
1212 'description': "DD.MM.YYYY 24Hr Time\n(w/o seconds)"
1216 'mask': "##:##:## AM",
1217 'excludeChars': am_pm_exclude
,
1218 'formatcodes': 'TF!',
1219 'validRegex': '^' + hours
+ ':' + minutes
+ ':' + seconds
+ ' (A|P)M',
1220 'description': "HH:MM:SS (A|P)M\n(see TimeCtrl)"
1224 'excludeChars': am_pm_exclude
,
1225 'formatcodes': 'TF!',
1226 'validRegex': '^' + hours
+ ':' + minutes
+ ' (A|P)M',
1227 'description': "HH:MM (A|P)M\n(see TimeCtrl)"
1231 'formatcodes': 'TF',
1232 'validRegex': '^' + milhours
+ ':' + minutes
+ ':' + seconds
,
1233 'description': "24Hr HH:MM:SS\n(see TimeCtrl)"
1237 'formatcodes': 'TF',
1238 'validRegex': '^' + milhours
+ ':' + minutes
,
1239 'description': "24Hr HH:MM\n(see TimeCtrl)"
1242 'mask': "###-##-####",
1244 'validRegex': "\d{3}-\d{2}-\d{4}",
1245 'description': "Social Sec#"
1248 'mask': "####-####-####-####",
1250 'validRegex': "\d{4}-\d{4}-\d{4}-\d{4}",
1251 'description': "Credit Card"
1256 'validRegex': "^" + months
+ "/\d\d",
1257 'description': "Expiration MM/YY"
1262 'validRegex': "^\d{5}",
1263 'description': "US 5-digit zip code"
1266 'mask': "#####-####",
1268 'validRegex': "\d{5}-(\s{4}|\d{4})",
1269 'description': "US zip+4 code"
1274 'validRegex': "^0.\d\d",
1275 'description': "Percentage"
1280 'validRegex': "^[1-9]{1} |[1-9][0-9] |1[0|1|2][0-9]",
1281 'description': "Age"
1284 'mask': "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
1285 'excludeChars': " \\/*&%$#!+='\"",
1286 'formatcodes': "F>",
1287 'validRegex': "^\w+([\-\.]\w+)*@((([a-zA-Z0-9]+(\-[a-zA-Z0-9]+)*\.)+)[a-zA-Z]{2,4}|\[(\d|\d\d|(1\d\d|2[0-4]\d|25[0-5]))(\.(\d|\d\d|(1\d\d|2[0-4]\d|25[0-5]))){3}\]) *$",
1288 'description': "Email address"
1291 'mask': "###.###.###.###",
1292 'formatcodes': 'F_Sr',
1293 'validRegex': "( \d| \d\d|(1\d\d|2[0-4]\d|25[0-5]))(\.( \d| \d\d|(1\d\d|2[0-4]\d|25[0-5]))){3}",
1294 'description': "IP Address\n(see IpAddrCtrl)"
1298 # build demo-friendly dictionary of descriptions of autoformats
1300 for key
, value
in masktags
.items():
1301 autoformats
.append((key
, value
['description']))
1304 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
1308 This class manages the individual fields in a masked edit control.
1309 Each field has a zero-based index, indicating its position in the
1310 control, an extent, an associated mask, and a plethora of optional
1311 parameters. Fields can be instantiated and then associated with
1312 parent masked controls, in order to provide field-specific configuration.
1313 Alternatively, fields will be implicitly created by the parent control
1314 if not provided at construction, at which point, the fields can then
1315 manipulated by the controls .SetFieldParameters() method.
1318 'index': None, ## which field of mask; set by parent control.
1319 'mask': "", ## mask chars for this field
1320 'extent': (), ## (edit start, edit_end) of field; set by parent control.
1321 'formatcodes': "", ## codes indicating formatting options for the control
1322 'fillChar': ' ', ## used as initial value for each mask position if initial value is not given
1323 'groupChar': ',', ## used with numeric fields; indicates what char groups 3-tuple digits
1324 'decimalChar': '.', ## used with numeric fields; indicates what char separates integer from fraction
1325 'shiftDecimalChar': '>', ## used with numeric fields, indicates what is above the decimal point char on keyboard
1326 'useParensForNegatives': False, ## used with numeric fields, indicates that () should be used vs. - to show negative numbers.
1327 'defaultValue': "", ## use if you want different positional defaults vs. all the same fillChar
1328 'excludeChars': "", ## optional string of chars to exclude even if main mask type does
1329 'includeChars': "", ## optional string of chars to allow even if main mask type doesn't
1330 'validRegex': "", ## optional regular expression to use to validate the control
1331 'validRange': (), ## Optional hi-low range for numerics
1332 'choices': [], ## Optional list for character expressions
1333 'choiceRequired': False, ## If choices supplied this specifies if valid value must be in the list
1334 'compareNoCase': False, ## Optional flag to indicate whether or not to use case-insensitive list search
1335 'autoSelect': False, ## Set to True to try auto-completion on each keystroke:
1336 'validFunc': None, ## Optional function for defining additional, possibly dynamic validation constraints on contrl
1337 'validRequired': False, ## Set to True to disallow input that results in an invalid value
1338 'emptyInvalid': False, ## Set to True to make EMPTY = INVALID
1339 'description': "", ## primarily for autoformats, but could be useful elsewhere
1340 'raiseOnInvalidPaste': False, ## if True, paste into field will cause ValueError
1341 'stopFieldChangeIfInvalid': False,## if True, disallow field navigation out of invalid field
1344 # This list contains all parameters that when set at the control level should
1345 # propagate down to each field:
1346 propagating_params
= ('fillChar', 'groupChar', 'decimalChar','useParensForNegatives',
1347 'compareNoCase', 'emptyInvalid', 'validRequired', 'raiseOnInvalidPaste',
1348 'stopFieldChangeIfInvalid')
1350 def __init__(self
, **kwargs
):
1352 This is the "constructor" for setting up parameters for fields.
1353 a field_index of -1 is used to indicate "the entire control."
1355 #### dbg('Field::Field', indent=1)
1356 # Validate legitimate set of parameters:
1357 for key
in kwargs
.keys():
1358 if key
not in Field
.valid_params
.keys():
1360 ae
= AttributeError('invalid parameter "%s"' % (key
))
1364 # Set defaults for each parameter for this instance, and fully
1365 # populate initial parameter list for configuration:
1366 for key
, value
in Field
.valid_params
.items():
1367 setattr(self
, '_' + key
, copy
.copy(value
))
1368 if not kwargs
.has_key(key
):
1369 kwargs
[key
] = copy
.copy(value
)
1371 self
._autoCompleteIndex
= -1
1372 self
._SetParameters
(**kwargs
)
1373 self
._ValidateParameters
(**kwargs
)
1378 def _SetParameters(self
, **kwargs
):
1380 This function can be used to set individual or multiple parameters for
1381 a masked edit field parameter after construction.
1384 ## dbg('maskededit.Field::_SetParameters', indent=1)
1385 # Validate keyword arguments:
1386 for key
in kwargs
.keys():
1387 if key
not in Field
.valid_params
.keys():
1388 ## dbg(indent=0, suspend=0)
1389 ae
= AttributeError('invalid keyword argument "%s"' % key
)
1393 ## if self._index is not None: dbg('field index:', self._index)
1394 ## dbg('parameters:', indent=1)
1395 for key
, value
in kwargs
.items():
1396 ## dbg('%s:' % key, value)
1401 old_fillChar
= self
._fillChar
# store so we can change choice lists accordingly if it changes
1403 # First, Assign all parameters specified:
1404 for key
in Field
.valid_params
.keys():
1405 if kwargs
.has_key(key
):
1406 setattr(self
, '_' + key
, kwargs
[key
] )
1408 if kwargs
.has_key('formatcodes'): # (set/changed)
1409 self
._forceupper
= '!' in self
._formatcodes
1410 self
._forcelower
= '^' in self
._formatcodes
1411 self
._groupdigits
= ',' in self
._formatcodes
1412 self
._okSpaces
= '_' in self
._formatcodes
1413 self
._padZero
= '0' in self
._formatcodes
1414 self
._autofit
= 'F' in self
._formatcodes
1415 self
._insertRight
= 'r' in self
._formatcodes
1416 self
._allowInsert
= '>' in self
._formatcodes
1417 self
._alignRight
= 'R' in self
._formatcodes
or 'r' in self
._formatcodes
1418 self
._moveOnFieldFull
= not '<' in self
._formatcodes
1419 self
._selectOnFieldEntry
= 'S' in self
._formatcodes
1421 if kwargs
.has_key('groupChar'):
1422 self
._groupChar
= kwargs
['groupChar']
1423 if kwargs
.has_key('decimalChar'):
1424 self
._decimalChar
= kwargs
['decimalChar']
1425 if kwargs
.has_key('shiftDecimalChar'):
1426 self
._shiftDecimalChar
= kwargs
['shiftDecimalChar']
1428 if kwargs
.has_key('formatcodes') or kwargs
.has_key('validRegex'):
1429 self
._regexMask
= 'V' in self
._formatcodes
and self
._validRegex
1431 if kwargs
.has_key('fillChar'):
1432 self
._old
_fillChar
= old_fillChar
1433 #### dbg("self._old_fillChar: '%s'" % self._old_fillChar)
1435 if kwargs
.has_key('mask') or kwargs
.has_key('validRegex'): # (set/changed)
1436 self
._isInt
= _isInteger(self
._mask
)
1437 ## dbg('isInt?', self._isInt, 'self._mask:"%s"' % self._mask)
1439 ## dbg(indent=0, suspend=0)
1442 def _ValidateParameters(self
, **kwargs
):
1444 This function can be used to validate individual or multiple parameters for
1445 a masked edit field parameter after construction.
1448 ## dbg('maskededit.Field::_ValidateParameters', indent=1)
1449 ## if self._index is not None: dbg('field index:', self._index)
1450 #### dbg('parameters:', indent=1)
1451 ## for key, value in kwargs.items():
1452 #### dbg('%s:' % key, value)
1454 #### dbg("self._old_fillChar: '%s'" % self._old_fillChar)
1456 # Verify proper numeric format params:
1457 if self
._groupdigits
and self
._groupChar
== self
._decimalChar
:
1458 ## dbg(indent=0, suspend=0)
1459 ae
= AttributeError("groupChar '%s' cannot be the same as decimalChar '%s'" % (self
._groupChar
, self
._decimalChar
))
1460 ae
.attribute
= self
._groupChar
1464 # Now go do validation, semantic and inter-dependency parameter processing:
1465 if kwargs
.has_key('choices') or kwargs
.has_key('compareNoCase') or kwargs
.has_key('choiceRequired'): # (set/changed)
1467 self
._compareChoices
= [choice
.strip() for choice
in self
._choices
]
1469 if self
._compareNoCase
and self
._choices
:
1470 self
._compareChoices
= [item
.lower() for item
in self
._compareChoices
]
1472 if kwargs
.has_key('choices'):
1473 self
._autoCompleteIndex
= -1
1476 if kwargs
.has_key('validRegex'): # (set/changed)
1477 if self
._validRegex
:
1479 if self
._compareNoCase
:
1480 self
._filter
= re
.compile(self
._validRegex
, re
.IGNORECASE
)
1482 self
._filter
= re
.compile(self
._validRegex
)
1484 ## dbg(indent=0, suspend=0)
1485 raise TypeError('%s: validRegex "%s" not a legal regular expression' % (str(self
._index
), self
._validRegex
))
1489 if kwargs
.has_key('validRange'): # (set/changed)
1490 self
._hasRange
= False
1493 if self
._validRange
:
1494 if type(self
._validRange
) != types
.TupleType
or len( self
._validRange
)!= 2 or self
._validRange
[0] > self
._validRange
[1]:
1495 ## dbg(indent=0, suspend=0)
1496 raise TypeError('%s: validRange %s parameter must be tuple of form (a,b) where a <= b'
1497 % (str(self
._index
), repr(self
._validRange
)) )
1499 self
._hasRange
= True
1500 self
._rangeLow
= self
._validRange
[0]
1501 self
._rangeHigh
= self
._validRange
[1]
1503 if kwargs
.has_key('choices') or (len(self
._choices
) and len(self
._choices
[0]) != len(self
._mask
)): # (set/changed)
1504 self
._hasList
= False
1505 if self
._choices
and type(self
._choices
) not in (types
.TupleType
, types
.ListType
):
1506 ## dbg(indent=0, suspend=0)
1507 raise TypeError('%s: choices must be a sequence of strings' % str(self
._index
))
1508 elif len( self
._choices
) > 0:
1509 for choice
in self
._choices
:
1510 if type(choice
) not in (types
.StringType
, types
.UnicodeType
):
1511 ## dbg(indent=0, suspend=0)
1512 raise TypeError('%s: choices must be a sequence of strings' % str(self
._index
))
1514 length
= len(self
._mask
)
1515 ## dbg('len(%s)' % self._mask, length, 'len(self._choices):', len(self._choices), 'length:', length, 'self._alignRight?', self._alignRight)
1516 if len(self
._choices
) and length
:
1517 if len(self
._choices
[0]) > length
:
1518 # changed mask without respecifying choices; readjust the width as appropriate:
1519 self
._choices
= [choice
.strip() for choice
in self
._choices
]
1520 if self
._alignRight
:
1521 self
._choices
= [choice
.rjust( length
) for choice
in self
._choices
]
1523 self
._choices
= [choice
.ljust( length
) for choice
in self
._choices
]
1524 ## dbg('aligned choices:', self._choices)
1526 if hasattr(self
, '_template'):
1527 # Verify each choice specified is valid:
1528 for choice
in self
._choices
:
1529 if self
.IsEmpty(choice
) and not self
._validRequired
:
1530 # allow empty values even if invalid, (just colored differently)
1532 if not self
.IsValid(choice
):
1533 ## dbg(indent=0, suspend=0)
1534 ve
= ValueError('%s: "%s" is not a valid value for the control as specified.' % (str(self
._index
), choice
))
1537 self
._hasList
= True
1539 #### dbg("kwargs.has_key('fillChar')?", kwargs.has_key('fillChar'), "len(self._choices) > 0?", len(self._choices) > 0)
1540 #### dbg("self._old_fillChar:'%s'" % self._old_fillChar, "self._fillChar: '%s'" % self._fillChar)
1541 if kwargs
.has_key('fillChar') and len(self
._choices
) > 0:
1542 if kwargs
['fillChar'] != ' ':
1543 self
._choices
= [choice
.replace(' ', self
._fillChar
) for choice
in self
._choices
]
1545 self
._choices
= [choice
.replace(self
._old
_fillChar
, self
._fillChar
) for choice
in self
._choices
]
1546 ## dbg('updated choices:', self._choices)
1549 if kwargs
.has_key('autoSelect') and kwargs
['autoSelect']:
1550 if not self
._hasList
:
1551 ## dbg('no list to auto complete; ignoring "autoSelect=True"')
1552 self
._autoSelect
= False
1554 # reset field validity assumption:
1556 ## dbg(indent=0, suspend=0)
1559 def _GetParameter(self
, paramname
):
1561 Routine for retrieving the value of any given parameter
1563 if Field
.valid_params
.has_key(paramname
):
1564 return getattr(self
, '_' + paramname
)
1566 TypeError('Field._GetParameter: invalid parameter "%s"' % key
)
1569 def IsEmpty(self
, slice):
1571 Indicates whether the specified slice is considered empty for the
1574 ## dbg('Field::IsEmpty("%s")' % slice, indent=1)
1575 if not hasattr(self
, '_template'):
1577 raise AttributeError('_template')
1579 ## dbg('self._template: "%s"' % self._template)
1580 ## dbg('self._defaultValue: "%s"' % str(self._defaultValue))
1581 if slice == self
._template
and not self
._defaultValue
:
1585 elif slice == self
._template
:
1587 for pos
in range(len(self
._template
)):
1588 #### dbg('slice[%(pos)d] != self._fillChar?' %locals(), slice[pos] != self._fillChar[pos])
1589 if slice[pos
] not in (' ', self
._fillChar
):
1592 ## dbg("IsEmpty? %(empty)d (do all mask chars == fillChar?)" % locals(), indent=0)
1595 ## dbg("IsEmpty? 0 (slice doesn't match template)", indent=0)
1599 def IsValid(self
, slice):
1601 Indicates whether the specified slice is considered a valid value for the
1605 ## dbg('Field[%s]::IsValid("%s")' % (str(self._index), slice), indent=1)
1606 valid
= True # assume true to start
1608 if self
.IsEmpty(slice):
1609 ## dbg(indent=0, suspend=0)
1610 if self
._emptyInvalid
:
1615 elif self
._hasList
and self
._choiceRequired
:
1616 ## dbg("(member of list required)")
1617 # do case-insensitive match on list; strip surrounding whitespace from slice (already done for choices):
1618 if self
._fillChar
!= ' ':
1619 slice = slice.replace(self
._fillChar
, ' ')
1620 ## dbg('updated slice:"%s"' % slice)
1621 compareStr
= slice.strip()
1623 if self
._compareNoCase
:
1624 compareStr
= compareStr
.lower()
1625 valid
= compareStr
in self
._compareChoices
1627 elif self
._hasRange
and not self
.IsEmpty(slice):
1628 ## dbg('validating against range')
1630 # allow float as well as int ranges (int comparisons for free.)
1631 valid
= self
._rangeLow
<= float(slice) <= self
._rangeHigh
1635 elif self
._validRegex
and self
._filter
:
1636 ## dbg('validating against regex')
1637 valid
= (re
.match( self
._filter
, slice) is not None)
1639 if valid
and self
._validFunc
:
1640 ## dbg('validating against supplied function')
1641 valid
= self
._validFunc
(slice)
1642 ## dbg('valid?', valid, indent=0, suspend=0)
1646 def _AdjustField(self
, slice):
1647 """ 'Fixes' an integer field. Right or left-justifies, as required."""
1648 ## dbg('Field::_AdjustField("%s")' % slice, indent=1)
1649 length
= len(self
._mask
)
1650 #### dbg('length(self._mask):', length)
1651 #### dbg('self._useParensForNegatives?', self._useParensForNegatives)
1653 if self
._useParensForNegatives
:
1654 signpos
= slice.find('(')
1655 right_signpos
= slice.find(')')
1656 intStr
= slice.replace('(', '').replace(')', '') # drop sign, if any
1658 signpos
= slice.find('-')
1659 intStr
= slice.replace( '-', '' ) # drop sign, if any
1662 intStr
= intStr
.replace(' ', '') # drop extra spaces
1663 intStr
= string
.replace(intStr
,self
._fillChar
,"") # drop extra fillchars
1664 intStr
= string
.replace(intStr
,"-","") # drop sign, if any
1665 intStr
= string
.replace(intStr
, self
._groupChar
, "") # lose commas/dots
1666 #### dbg('intStr:"%s"' % intStr)
1667 start
, end
= self
._extent
1668 field_len
= end
- start
1669 if not self
._padZero
and len(intStr
) != field_len
and intStr
.strip():
1670 intStr
= str(long(intStr
))
1671 #### dbg('raw int str: "%s"' % intStr)
1672 #### dbg('self._groupdigits:', self._groupdigits, 'self._formatcodes:', self._formatcodes)
1673 if self
._groupdigits
:
1676 for i
in range(len(intStr
)-1, -1, -1):
1677 new
= intStr
[i
] + new
1679 new
= self
._groupChar
+ new
1681 if new
and new
[0] == self
._groupChar
:
1683 if len(new
) <= length
:
1684 # expanded string will still fit and leave room for sign:
1686 # else... leave it without the commas...
1688 ## dbg('padzero?', self._padZero)
1689 ## dbg('len(intStr):', len(intStr), 'field length:', length)
1690 if self
._padZero
and len(intStr
) < length
:
1691 intStr
= '0' * (length
- len(intStr
)) + intStr
1692 if signpos
!= -1: # we had a sign before; restore it
1693 if self
._useParensForNegatives
:
1694 intStr
= '(' + intStr
[1:]
1695 if right_signpos
!= -1:
1698 intStr
= '-' + intStr
[1:]
1699 elif signpos
!= -1 and slice[0:signpos
].strip() == '': # - was before digits
1700 if self
._useParensForNegatives
:
1701 intStr
= '(' + intStr
1702 if right_signpos
!= -1:
1705 intStr
= '-' + intStr
1706 elif right_signpos
!= -1:
1707 # must have had ')' but '(' was before field; re-add ')'
1711 slice = slice.strip() # drop extra spaces
1713 if self
._alignRight
: ## Only if right-alignment is enabled
1714 slice = slice.rjust( length
)
1716 slice = slice.ljust( length
)
1717 if self
._fillChar
!= ' ':
1718 slice = slice.replace(' ', self
._fillChar
)
1719 ## dbg('adjusted slice: "%s"' % slice, indent=0)
1723 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
1725 class MaskedEditMixin
:
1727 This class allows us to abstract the masked edit functionality that could
1728 be associated with any text entry control. (eg. wx.TextCtrl, wx.ComboBox, etc.)
1729 It forms the basis for all of the lib.masked controls.
1731 valid_ctrl_params
= {
1732 'mask': 'XXXXXXXXXXXXX', ## mask string for formatting this control
1733 'autoformat': "", ## optional auto-format code to set format from masktags dictionary
1734 'fields': {}, ## optional list/dictionary of maskededit.Field class instances, indexed by position in mask
1735 'datestyle': 'MDY', ## optional date style for date-type values. Can trigger autocomplete year
1736 'autoCompleteKeycodes': [], ## Optional list of additional keycodes which will invoke field-auto-complete
1737 'useFixedWidthFont': True, ## Use fixed-width font instead of default for base control
1738 'defaultEncoding': 'latin1', ## optional argument to indicate unicode codec to use (unicode ctrls only)
1739 'retainFieldValidation': False, ## Set this to true if setting control-level parameters independently,
1740 ## from field validation constraints
1741 'emptyBackgroundColour': "White",
1742 'validBackgroundColour': "White",
1743 'invalidBackgroundColour': "Yellow",
1744 'foregroundColour': "Black",
1745 'signedForegroundColour': "Red",
1749 def __init__(self
, name
= 'MaskedEdit', **kwargs
):
1751 This is the "constructor" for setting up the mixin variable parameters for the composite class.
1756 # set up flag for doing optional things to base control if possible
1757 if not hasattr(self
, 'controlInitialized'):
1758 self
.controlInitialized
= False
1760 # Set internal state var for keeping track of whether or not a character
1761 # action results in a modification of the control, since .SetValue()
1762 # doesn't modify the base control's internal state:
1763 self
.modified
= False
1764 self
._previous
_mask
= None
1766 # Validate legitimate set of parameters:
1767 for key
in kwargs
.keys():
1768 if key
.replace('Color', 'Colour') not in MaskedEditMixin
.valid_ctrl_params
.keys() + Field
.valid_params
.keys():
1769 raise TypeError('%s: invalid parameter "%s"' % (name
, key
))
1771 ## Set up dictionary that can be used by subclasses to override or add to default
1772 ## behavior for individual characters. Derived subclasses needing to change
1773 ## default behavior for keys can either redefine the default functions for the
1774 ## common keys or add functions for specific keys to this list. Each function
1775 ## added should take the key event as argument, and return False if the key
1776 ## requires no further processing.
1778 ## Initially populated with navigation and function control keys:
1779 self
._keyhandlers
= {
1780 # default navigation keys and handlers:
1781 wx
.WXK_BACK
: self
._OnErase
,
1782 wx
.WXK_LEFT
: self
._OnArrow
,
1783 wx
.WXK_NUMPAD_LEFT
: self
._OnArrow
,
1784 wx
.WXK_RIGHT
: self
._OnArrow
,
1785 wx
.WXK_NUMPAD_RIGHT
: self
._OnArrow
,
1786 wx
.WXK_UP
: self
._OnAutoCompleteField
,
1787 wx
.WXK_NUMPAD_UP
: self
._OnAutoCompleteField
,
1788 wx
.WXK_DOWN
: self
._OnAutoCompleteField
,
1789 wx
.WXK_NUMPAD_DOWN
: self
._OnAutoCompleteField
,
1790 wx
.WXK_TAB
: self
._OnChangeField
,
1791 wx
.WXK_HOME
: self
._OnHome
,
1792 wx
.WXK_NUMPAD_HOME
: self
._OnHome
,
1793 wx
.WXK_END
: self
._OnEnd
,
1794 wx
.WXK_NUMPAD_END
: self
._OnEnd
,
1795 wx
.WXK_RETURN
: self
._OnReturn
,
1796 wx
.WXK_NUMPAD_ENTER
: self
._OnReturn
,
1797 wx
.WXK_PRIOR
: self
._OnAutoCompleteField
,
1798 wx
.WXK_NUMPAD_PRIOR
: self
._OnAutoCompleteField
,
1799 wx
.WXK_NEXT
: self
._OnAutoCompleteField
,
1800 wx
.WXK_NUMPAD_NEXT
: self
._OnAutoCompleteField
,
1802 # default function control keys and handlers:
1803 wx
.WXK_DELETE
: self
._OnDelete
,
1804 wx
.WXK_NUMPAD_DELETE
: self
._OnDelete
,
1805 wx
.WXK_INSERT
: self
._OnInsert
,
1806 wx
.WXK_NUMPAD_INSERT
: self
._OnInsert
,
1808 WXK_CTRL_A
: self
._OnCtrl
_A
,
1809 WXK_CTRL_C
: self
._OnCtrl
_C
,
1810 WXK_CTRL_S
: self
._OnCtrl
_S
,
1811 WXK_CTRL_V
: self
._OnCtrl
_V
,
1812 WXK_CTRL_X
: self
._OnCtrl
_X
,
1813 WXK_CTRL_Z
: self
._OnCtrl
_Z
,
1816 ## bind standard navigational and control keycodes to this instance,
1817 ## so that they can be augmented and/or changed in derived classes:
1818 self
._nav
= list(nav
)
1819 self
._control
= list(control
)
1821 ## Dynamically evaluate and store string constants for mask chars
1822 ## so that locale settings can be made after this module is imported
1823 ## and the controls created after that is done can allow the
1824 ## appropriate characters:
1825 self
.maskchardict
= {
1827 'A': string
.uppercase
,
1828 'a': string
.lowercase
,
1829 'X': string
.letters
+ string
.punctuation
+ string
.digits
,
1830 'C': string
.letters
,
1831 'N': string
.letters
+ string
.digits
,
1832 '&': string
.punctuation
,
1833 '*': ansichars
# to give it a value, but now allows any non-wxcontrol character
1836 ## self._ignoreChange is used by MaskedComboBox, because
1837 ## of the hack necessary to determine the selection; it causes
1838 ## EVT_TEXT messages from the combobox to be ignored if set.
1839 self
._ignoreChange
= False
1841 # These are used to keep track of previous value, for undo functionality:
1842 self
._curValue
= None
1843 self
._prevValue
= None
1847 # Set defaults for each parameter for this instance, and fully
1848 # populate initial parameter list for configuration:
1849 for key
, value
in MaskedEditMixin
.valid_ctrl_params
.items():
1850 setattr(self
, '_' + key
, copy
.copy(value
))
1851 if not kwargs
.has_key(key
):
1852 #### dbg('%s: "%s"' % (key, repr(value)))
1853 kwargs
[key
] = copy
.copy(value
)
1855 # Create a "field" that holds global parameters for control constraints
1856 self
._ctrl
_constraints
= self
._fields
[-1] = Field(index
=-1)
1857 self
.SetCtrlParameters(**kwargs
)
1861 def SetCtrlParameters(self
, **kwargs
):
1863 This public function can be used to set individual or multiple masked edit
1864 parameters after construction. (See maskededit module overview for the list
1865 of valid parameters.)
1868 ## dbg('MaskedEditMixin::SetCtrlParameters', indent=1)
1869 #### dbg('kwargs:', indent=1)
1870 ## for key, value in kwargs.items():
1871 #### dbg(key, '=', value)
1874 # Validate keyword arguments:
1875 constraint_kwargs
= {}
1877 for key
, value
in kwargs
.items():
1878 key
= key
.replace('Color', 'Colour') # for b-c, and standard wxPython spelling
1879 if key
not in MaskedEditMixin
.valid_ctrl_params
.keys() + Field
.valid_params
.keys():
1880 ## dbg(indent=0, suspend=0)
1881 ae
= AttributeError('Invalid keyword argument "%s" for control "%s"' % (key
, self
.name
))
1884 elif key
in Field
.valid_params
.keys():
1885 constraint_kwargs
[key
] = value
1887 ctrl_kwargs
[key
] = value
1892 if ctrl_kwargs
.has_key('autoformat'):
1893 autoformat
= ctrl_kwargs
['autoformat']
1897 # handle "parochial name" backward compatibility:
1898 if autoformat
and autoformat
.find('MILTIME') != -1 and autoformat
not in masktags
.keys():
1899 autoformat
= autoformat
.replace('MILTIME', '24HRTIME')
1901 if autoformat
!= self
._autoformat
and autoformat
in masktags
.keys():
1902 ## dbg('autoformat:', autoformat)
1903 self
._autoformat
= autoformat
1904 mask
= masktags
[self
._autoformat
]['mask']
1905 # gather rest of any autoformat parameters:
1906 for param
, value
in masktags
[self
._autoformat
].items():
1907 if param
== 'mask': continue # (must be present; already accounted for)
1908 constraint_kwargs
[param
] = value
1910 elif autoformat
and not autoformat
in masktags
.keys():
1911 ae
= AttributeError('invalid value for autoformat parameter: %s' % repr(autoformat
))
1912 ae
.attribute
= autoformat
1915 ## dbg('autoformat not selected')
1916 if kwargs
.has_key('mask'):
1917 mask
= kwargs
['mask']
1918 ## dbg('mask:', mask)
1920 ## Assign style flags
1922 ## dbg('preserving previous mask')
1923 mask
= self
._previous
_mask
# preserve previous mask
1925 ## dbg('mask (re)set')
1926 reset_args
['reset_mask'] = mask
1927 constraint_kwargs
['mask'] = mask
1929 # wipe out previous fields; preserve new control-level constraints
1930 self
._fields
= {-1: self._ctrl_constraints}
1933 if ctrl_kwargs
.has_key('fields'):
1934 # do field parameter type validation, and conversion to internal dictionary
1936 fields
= ctrl_kwargs
['fields']
1937 if type(fields
) in (types
.ListType
, types
.TupleType
):
1938 for i
in range(len(fields
)):
1940 if not isinstance(field
, Field
):
1941 ## dbg(indent=0, suspend=0)
1942 raise TypeError('invalid type for field parameter: %s' % repr(field
))
1943 self
._fields
[i
] = field
1945 elif type(fields
) == types
.DictionaryType
:
1946 for index
, field
in fields
.items():
1947 if not isinstance(field
, Field
):
1948 ## dbg(indent=0, suspend=0)
1949 raise TypeError('invalid type for field parameter: %s' % repr(field
))
1950 self
._fields
[index
] = field
1952 ## dbg(indent=0, suspend=0)
1953 raise TypeError('fields parameter must be a list or dictionary; not %s' % repr(fields
))
1955 # Assign constraint parameters for entire control:
1956 #### dbg('control constraints:', indent=1)
1957 ## for key, value in constraint_kwargs.items():
1958 #### dbg('%s:' % key, value)
1961 # determine if changing parameters that should affect the entire control:
1962 for key
in MaskedEditMixin
.valid_ctrl_params
.keys():
1963 if key
in ( 'mask', 'fields' ): continue # (processed separately)
1964 if ctrl_kwargs
.has_key(key
):
1965 setattr(self
, '_' + key
, ctrl_kwargs
[key
])
1967 # Validate color parameters, converting strings to named colors and validating
1968 # result if appropriate:
1969 for key
in ('emptyBackgroundColour', 'invalidBackgroundColour', 'validBackgroundColour',
1970 'foregroundColour', 'signedForegroundColour'):
1971 if ctrl_kwargs
.has_key(key
):
1972 if type(ctrl_kwargs
[key
]) in (types
.StringType
, types
.UnicodeType
):
1973 c
= wx
.NamedColour(ctrl_kwargs
[key
])
1974 if c
.Get() == (-1, -1, -1):
1975 raise TypeError('%s not a legal color specification for %s' % (repr(ctrl_kwargs
[key
]), key
))
1977 # replace attribute with wxColour object:
1978 setattr(self
, '_' + key
, c
)
1979 # attach a python dynamic attribute to wxColour for debug printouts
1980 c
._name
= ctrl_kwargs
[key
]
1982 elif type(ctrl_kwargs
[key
]) != type(wx
.BLACK
):
1983 raise TypeError('%s not a legal color specification for %s' % (repr(ctrl_kwargs
[key
]), key
))
1986 ## dbg('self._retainFieldValidation:', self._retainFieldValidation)
1987 if not self
._retainFieldValidation
:
1988 # Build dictionary of any changing parameters which should be propagated to the
1990 for arg
in Field
.propagating_params
:
1991 #### dbg('kwargs.has_key(%s)?' % arg, kwargs.has_key(arg))
1992 #### dbg('getattr(self._ctrl_constraints, _%s)?' % arg, getattr(self._ctrl_constraints, '_'+arg))
1993 reset_args
[arg
] = kwargs
.has_key(arg
) and kwargs
[arg
] != getattr(self
._ctrl
_constraints
, '_'+arg
)
1994 #### dbg('reset_args[%s]?' % arg, reset_args[arg])
1996 # Set the control-level constraints:
1997 self
._ctrl
_constraints
._SetParameters
(**constraint_kwargs
)
1999 # This routine does the bulk of the interdependent parameter processing, determining
2000 # the field extents of the mask if changed, resetting parameters as appropriate,
2001 # determining the overall template value for the control, etc.
2002 self
._configure
(mask
, **reset_args
)
2004 # now that we've propagated the field constraints and mask portions to the
2005 # various fields, validate the constraints
2006 self
._ctrl
_constraints
._ValidateParameters
(**constraint_kwargs
)
2008 # Validate that all choices for given fields are at least of the
2009 # necessary length, and that they all would be valid pastes if pasted
2010 # into their respective fields:
2011 #### dbg('validating choices')
2012 self
._validateChoices
()
2015 self
._autofit
= self
._ctrl
_constraints
._autofit
2018 self
._isDate
= 'D' in self
._ctrl
_constraints
._formatcodes
and _isDateType(mask
)
2019 self
._isTime
= 'T' in self
._ctrl
_constraints
._formatcodes
and _isTimeType(mask
)
2021 # Set _dateExtent, used in date validation to locate date in string;
2022 # always set as though year will be 4 digits, even if mask only has
2023 # 2 digits, so we can always properly process the intended year for
2024 # date validation (leap years, etc.)
2025 if self
._mask
.find('CCC') != -1: self
._dateExtent
= 11
2026 else: self
._dateExtent
= 10
2028 self
._4digityear
= len(self
._mask
) > 8 and self
._mask
[9] == '#'
2030 if self
._isDate
and self
._autoformat
:
2031 # Auto-decide datestyle:
2032 if self
._autoformat
.find('MDDY') != -1: self
._datestyle
= 'MDY'
2033 elif self
._autoformat
.find('YMMD') != -1: self
._datestyle
= 'YMD'
2034 elif self
._autoformat
.find('YMMMD') != -1: self
._datestyle
= 'YMD'
2035 elif self
._autoformat
.find('DMMY') != -1: self
._datestyle
= 'DMY'
2036 elif self
._autoformat
.find('DMMMY') != -1: self
._datestyle
= 'DMY'
2038 # Give derived controls a chance to react to parameter changes before
2039 # potentially changing current value of the control.
2040 self
._OnCtrlParametersChanged
()
2042 if self
.controlInitialized
:
2043 # Then the base control is available for configuration;
2044 # take action on base control based on new settings, as appropriate.
2045 if kwargs
.has_key('useFixedWidthFont'):
2046 # Set control font - fixed width by default
2049 if reset_args
.has_key('reset_mask'):
2050 ## dbg('reset mask')
2051 curvalue
= self
._GetValue
()
2052 if curvalue
.strip():
2054 ## dbg('attempting to _SetInitialValue(%s)' % self._GetValue())
2055 self
._SetInitialValue
(self
._GetValue
())
2056 except Exception, e
:
2057 ## dbg('exception caught:', e)
2058 ## dbg("current value doesn't work; attempting to reset to template")
2059 self
._SetInitialValue
()
2061 ## dbg('attempting to _SetInitialValue() with template')
2062 self
._SetInitialValue
()
2064 elif kwargs
.has_key('useParensForNegatives'):
2065 newvalue
= self
._getSignedValue
()[0]
2067 if newvalue
is not None:
2068 # Adjust for new mask:
2069 if len(newvalue
) < len(self
._mask
):
2071 elif len(newvalue
) > len(self
._mask
):
2072 if newvalue
[-1] in (' ', ')'):
2073 newvalue
= newvalue
[:-1]
2075 ## dbg('reconfiguring value for parens:"%s"' % newvalue)
2076 self
._SetValue
(newvalue
)
2078 if self
._prevValue
!= newvalue
:
2079 self
._prevValue
= newvalue
# disallow undo of sign type
2082 ## dbg('calculated size:', self._CalcSize())
2083 self
.SetClientSize(self
._CalcSize
())
2084 width
= self
.GetSize().width
2085 height
= self
.GetBestSize().height
2086 ## dbg('setting client size to:', (width, height))
2087 self
.SetInitialSize((width
, height
))
2089 # Set value/type-specific formatting
2090 self
._applyFormatting
()
2091 ## dbg(indent=0, suspend=0)
2093 def SetMaskParameters(self
, **kwargs
):
2094 """ old name for the SetCtrlParameters function (DEPRECATED)"""
2095 return self
.SetCtrlParameters(**kwargs
)
2098 def GetCtrlParameter(self
, paramname
):
2100 Routine for retrieving the value of any given parameter
2102 if MaskedEditMixin
.valid_ctrl_params
.has_key(paramname
.replace('Color','Colour')):
2103 return getattr(self
, '_' + paramname
.replace('Color', 'Colour'))
2104 elif Field
.valid_params
.has_key(paramname
):
2105 return self
._ctrl
_constraints
._GetParameter
(paramname
)
2107 TypeError('"%s".GetCtrlParameter: invalid parameter "%s"' % (self
.name
, paramname
))
2109 def GetMaskParameter(self
, paramname
):
2110 """ old name for the GetCtrlParameters function (DEPRECATED)"""
2111 return self
.GetCtrlParameter(paramname
)
2114 ## This idea worked, but Boa was unable to use this solution...
2115 ## def _attachMethod(self, func):
2117 ## setattr(self, func.__name__, new.instancemethod(func, self, self.__class__))
2120 ## def _DefinePropertyFunctions(exposed_params):
2121 ## for param in exposed_params:
2122 ## propname = param[0].upper() + param[1:]
2124 ## exec('def Set%s(self, value): self.SetCtrlParameters(%s=value)' % (propname, param))
2125 ## exec('def Get%s(self): return self.GetCtrlParameter("%s")''' % (propname, param))
2126 ## self._attachMethod(locals()['Set%s' % propname])
2127 ## self._attachMethod(locals()['Get%s' % propname])
2129 ## if param.find('Colour') != -1:
2130 ## # add non-british spellings, for backward-compatibility
2131 ## propname.replace('Colour', 'Color')
2133 ## exec('def Set%s(self, value): self.SetCtrlParameters(%s=value)' % (propname, param))
2134 ## exec('def Get%s(self): return self.GetCtrlParameter("%s")''' % (propname, param))
2135 ## self._attachMethod(locals()['Set%s' % propname])
2136 ## self._attachMethod(locals()['Get%s' % propname])
2140 def SetFieldParameters(self
, field_index
, **kwargs
):
2142 Routine provided to modify the parameters of a given field.
2143 Because changes to fields can affect the overall control,
2144 direct access to the fields is prevented, and the control
2145 is always "reconfigured" after setting a field parameter.
2146 (See maskededit module overview for the list of valid field-level
2149 if field_index
not in self
._field
_indices
:
2150 ie
= IndexError('%s is not a valid field for control "%s".' % (str(field_index
), self
.name
))
2151 ie
.index
= field_index
2153 # set parameters as requested:
2154 self
._fields
[field_index
]._SetParameters
(**kwargs
)
2156 # Possibly reprogram control template due to resulting changes, and ensure
2157 # control-level params are still propagated to fields:
2158 self
._configure
(self
._previous
_mask
)
2159 self
._fields
[field_index
]._ValidateParameters
(**kwargs
)
2161 if self
.controlInitialized
:
2162 if kwargs
.has_key('fillChar') or kwargs
.has_key('defaultValue'):
2163 self
._SetInitialValue
()
2166 # this is tricky, because, as Robin explains:
2167 # "Basically there are two sizes to deal with, that are potentially
2168 # different. The client size is the inside size and may, depending
2169 # on platform, exclude the borders and such. The normal size is
2170 # the outside size that does include the borders. What you are
2171 # calculating (in _CalcSize) is the client size, but the sizers
2172 # deal with the full size and so that is the minimum size that
2173 # we need to set with SetInitialSize. The root of the problem is
2174 # that in _calcSize the current client size height is returned,
2175 # instead of a height based on the current font. So I suggest using
2176 # _calcSize to just get the width, and then use GetBestSize to
2178 self
.SetClientSize(self
._CalcSize
())
2179 width
= self
.GetSize().width
2180 height
= self
.GetBestSize().height
2181 self
.SetInitialSize((width
, height
))
2184 # Set value/type-specific formatting
2185 self
._applyFormatting
()
2188 def GetFieldParameter(self
, field_index
, paramname
):
2190 Routine provided for getting a parameter of an individual field.
2192 if field_index
not in self
._field
_indices
:
2193 ie
= IndexError('%s is not a valid field for control "%s".' % (str(field_index
), self
.name
))
2194 ie
.index
= field_index
2196 elif Field
.valid_params
.has_key(paramname
):
2197 return self
._fields
[field_index
]._GetParameter
(paramname
)
2199 ae
= AttributeError('"%s".GetFieldParameter: invalid parameter "%s"' % (self
.name
, paramname
))
2200 ae
.attribute
= paramname
2204 def _SetKeycodeHandler(self
, keycode
, func
):
2206 This function adds and/or replaces key event handling functions
2207 used by the control. <func> should take the event as argument
2208 and return False if no further action on the key is necessary.
2211 self
._keyhandlers
[keycode
] = func
2212 elif self
._keyhandlers
.has_key(keycode
):
2213 del self
._keyhandlers
[keycode
]
2216 def _SetKeyHandler(self
, char
, func
):
2218 This function adds and/or replaces key event handling functions
2219 for ascii characters. <func> should take the event as argument
2220 and return False if no further action on the key is necessary.
2222 self
._SetKeycodeHandler
(ord(char
), func
)
2225 def _AddNavKeycode(self
, keycode
, handler
=None):
2227 This function allows a derived subclass to augment the list of
2228 keycodes that are considered "navigational" keys.
2230 self
._nav
.append(keycode
)
2232 self
._keyhandlers
[keycode
] = handler
2233 elif self
.keyhandlers
.has_key(keycode
):
2234 del self
._keyhandlers
[keycode
]
2238 def _AddNavKey(self
, char
, handler
=None):
2240 This function is a convenience function so you don't have to
2241 remember to call ord() for ascii chars to be used for navigation.
2243 self
._AddNavKeycode
(ord(char
), handler
)
2246 def _GetNavKeycodes(self
):
2248 This function retrieves the current list of navigational keycodes for
2254 def _SetNavKeycodes(self
, keycode_func_tuples
):
2256 This function allows you to replace the current list of keycode processed
2257 as navigation keys, and bind associated optional keyhandlers.
2260 for keycode
, func
in keycode_func_tuples
:
2261 self
._nav
.append(keycode
)
2263 self
._keyhandlers
[keycode
] = func
2264 elif self
.keyhandlers
.has_key(keycode
):
2265 del self
._keyhandlers
[keycode
]
2268 def _processMask(self
, mask
):
2270 This subroutine expands {n} syntax in mask strings, and looks for escaped
2271 special characters and returns the expanded mask, and an dictionary
2272 of booleans indicating whether or not a given position in the mask is
2273 a mask character or not.
2275 ## dbg('_processMask: mask', mask, indent=1)
2276 # regular expression for parsing c{n} syntax:
2277 rex
= re
.compile('([' +string
.join(maskchars
,"") + '])\{(\d+)\}')
2279 match
= rex
.search(s
)
2280 while match
: # found an(other) occurrence
2281 maskchr
= s
[match
.start(1):match
.end(1)] # char to be repeated
2282 repcount
= int(s
[match
.start(2):match
.end(2)]) # the number of times
2283 replacement
= string
.join( maskchr
* repcount
, "") # the resulting substr
2284 s
= s
[:match
.start(1)] + replacement
+ s
[match
.end(2)+1:] #account for trailing '}'
2285 match
= rex
.search(s
) # look for another such entry in mask
2287 self
._decimalChar
= self
._ctrl
_constraints
._decimalChar
2288 self
._shiftDecimalChar
= self
._ctrl
_constraints
._shiftDecimalChar
2290 self
._isFloat
= _isFloatingPoint(s
) and not self
._ctrl
_constraints
._validRegex
2291 self
._isInt
= _isInteger(s
) and not self
._ctrl
_constraints
._validRegex
2292 self
._signOk
= '-' in self
._ctrl
_constraints
._formatcodes
and (self
._isFloat
or self
._isInt
)
2293 self
._useParens
= self
._ctrl
_constraints
._useParensForNegatives
2295 #### dbg('self._signOk?', self._signOk, 'self._useParens?', self._useParens)
2296 #### dbg('isFloatingPoint(%s)?' % (s), _isFloatingPoint(s),
2297 ## 'ctrl regex:', self._ctrl_constraints._validRegex)
2299 if self
._signOk
and s
[0] != ' ':
2301 if self
._ctrl
_constraints
._defaultValue
and self
._ctrl
_constraints
._defaultValue
[0] != ' ':
2302 self
._ctrl
_constraints
._defaultValue
= ' ' + self
._ctrl
_constraints
._defaultValue
2307 self
._ctrl
_constraints
._defaultValue
+= ' '
2310 # Now, go build up a dictionary of booleans, indexed by position,
2311 # indicating whether or not a given position is masked or not.
2312 # Also, strip out any '|' chars, adjusting the mask as necessary,
2313 # marking the appropriate positions for field boundaries:
2315 explicit_field_boundaries
= []
2318 if s
[i
] == '\\': # if escaped character:
2319 ismasked
[i
] = False # mark position as not a mask char
2320 if i
+1 < len(s
): # if another char follows...
2321 s
= s
[:i
] + s
[i
+1:] # elide the '\'
2322 if i
+2 < len(s
) and s
[i
+1] == '\\':
2323 # if next char also a '\', char is a literal '\'
2324 s
= s
[:i
] + s
[i
+1:] # elide the 2nd '\' as well
2325 i
+= 1 # increment to next char
2327 s
= s
[:i
] + s
[i
+1:] # elide the '|'
2328 explicit_field_boundaries
.append(i
)
2329 # keep index where it is:
2330 else: # else if special char, mark position accordingly
2331 ismasked
[i
] = s
[i
] in maskchars
2332 #### dbg('ismasked[%d]:' % i, ismasked[i], s)
2333 i
+= 1 # increment to next char
2334 #### dbg('ismasked:', ismasked)
2335 ## dbg('new mask: "%s"' % s, indent=0)
2337 return s
, ismasked
, explicit_field_boundaries
2340 def _calcFieldExtents(self
):
2342 Subroutine responsible for establishing/configuring field instances with
2343 indices and editable extents appropriate to the specified mask, and building
2344 the lookup table mapping each position to the corresponding field.
2346 self
._lookupField
= {}
2349 ## Create dictionary of positions,characters in mask
2351 for charnum
in range( len( self
._mask
)):
2352 self
.maskdict
[charnum
] = self
._mask
[charnum
:charnum
+1]
2354 # For the current mask, create an ordered list of field extents
2355 # and a dictionary of positions that map to field indices:
2357 if self
._signOk
: start
= 1
2361 # Skip field "discovery", and just construct a 2-field control with appropriate
2362 # constraints for a floating-point entry.
2364 # .setdefault always constructs 2nd argument even if not needed, so we do this
2365 # the old-fashioned way...
2366 if not self
._fields
.has_key(0):
2367 self
._fields
[0] = Field()
2368 if not self
._fields
.has_key(1):
2369 self
._fields
[1] = Field()
2371 self
._decimalpos
= string
.find( self
._mask
, '.')
2372 ## dbg('decimal pos =', self._decimalpos)
2374 formatcodes
= self
._fields
[0]._GetParameter
('formatcodes')
2375 if 'R' not in formatcodes
: formatcodes
+= 'R'
2376 self
._fields
[0]._SetParameters
(index
=0, extent
=(start
, self
._decimalpos
),
2377 mask
=self
._mask
[start
:self
._decimalpos
], formatcodes
=formatcodes
)
2378 end
= len(self
._mask
)
2379 if self
._signOk
and self
._useParens
:
2381 self
._fields
[1]._SetParameters
(index
=1, extent
=(self
._decimalpos
+1, end
),
2382 mask
=self
._mask
[self
._decimalpos
+1:end
])
2384 for i
in range(self
._decimalpos
+1):
2385 self
._lookupField
[i
] = 0
2387 for i
in range(self
._decimalpos
+1, len(self
._mask
)+1):
2388 self
._lookupField
[i
] = 1
2391 # Skip field "discovery", and just construct a 1-field control with appropriate
2392 # constraints for a integer entry.
2393 if not self
._fields
.has_key(0):
2394 self
._fields
[0] = Field(index
=0)
2395 end
= len(self
._mask
)
2396 if self
._signOk
and self
._useParens
:
2398 self
._fields
[0]._SetParameters
(index
=0, extent
=(start
, end
),
2399 mask
=self
._mask
[start
:end
])
2400 for i
in range(len(self
._mask
)+1):
2401 self
._lookupField
[i
] = 0
2403 # generic control; parse mask to figure out where the fields are:
2406 i
= self
._findNextEntry
(pos
,adjustInsert
=False) # go to 1st entry point:
2407 if i
< len(self
._mask
): # no editable chars!
2408 for j
in range(pos
, i
+1):
2409 self
._lookupField
[j
] = field_index
2410 pos
= i
# figure out field for 1st editable space:
2412 while i
<= len(self
._mask
):
2413 #### dbg('searching: outer field loop: i = ', i)
2414 if self
._isMaskChar
(i
):
2415 #### dbg('1st char is mask char; recording edit_start=', i)
2417 # Skip to end of editable part of current field:
2418 while i
< len(self
._mask
) and self
._isMaskChar
(i
):
2419 self
._lookupField
[i
] = field_index
2421 if i
in self
._explicit
_field
_boundaries
:
2423 #### dbg('edit_end =', i)
2425 self
._lookupField
[i
] = field_index
2426 #### dbg('self._fields.has_key(%d)?' % field_index, self._fields.has_key(field_index))
2427 if not self
._fields
.has_key(field_index
):
2428 kwargs
= Field
.valid_params
.copy()
2429 kwargs
['index'] = field_index
2430 kwargs
['extent'] = (edit_start
, edit_end
)
2431 kwargs
['mask'] = self
._mask
[edit_start
:edit_end
]
2432 self
._fields
[field_index
] = Field(**kwargs
)
2434 self
._fields
[field_index
]._SetParameters
(
2436 extent
=(edit_start
, edit_end
),
2437 mask
=self
._mask
[edit_start
:edit_end
])
2439 i
= self
._findNextEntry
(pos
, adjustInsert
=False) # go to next field:
2440 #### dbg('next entry:', i)
2442 for j
in range(pos
, i
+1):
2443 self
._lookupField
[j
] = field_index
2444 if i
>= len(self
._mask
):
2445 break # if past end, we're done
2448 #### dbg('next field:', field_index)
2450 indices
= self
._fields
.keys()
2452 self
._field
_indices
= indices
[1:]
2453 #### dbg('lookupField map:', indent=1)
2454 ## for i in range(len(self._mask)):
2455 #### dbg('pos %d:' % i, self._lookupField[i])
2458 # Verify that all field indices specified are valid for mask:
2459 for index
in self
._fields
.keys():
2460 if index
not in [-1] + self
._lookupField
.values():
2461 ie
= IndexError('field %d is not a valid field for mask "%s"' % (index
, self
._mask
))
2467 def _calcTemplate(self
, reset_fillchar
, reset_default
):
2469 Subroutine for processing current fillchars and default values for
2470 whole control and individual fields, constructing the resulting
2471 overall template, and adjusting the current value as necessary.
2474 if self
._ctrl
_constraints
._defaultValue
:
2477 for field
in self
._fields
.values():
2478 if field
._defaultValue
and not reset_default
:
2480 ## dbg('default set?', default_set)
2482 # Determine overall new template for control, and keep track of previous
2483 # values, so that current control value can be modified as appropriate:
2484 if self
.controlInitialized
: curvalue
= list(self
._GetValue
())
2485 else: curvalue
= None
2487 if hasattr(self
, '_fillChar'): old_fillchars
= self
._fillChar
2488 else: old_fillchars
= None
2490 if hasattr(self
, '_template'): old_template
= self
._template
2491 else: old_template
= None
2498 for field
in self
._fields
.values():
2499 field
._template
= ""
2501 for pos
in range(len(self
._mask
)):
2502 #### dbg('pos:', pos)
2503 field
= self
._FindField
(pos
)
2504 #### dbg('field:', field._index)
2505 start
, end
= field
._extent
2507 if pos
== 0 and self
._signOk
:
2508 self
._template
= ' ' # always make 1st 1st position blank, regardless of fillchar
2509 elif self
._isFloat
and pos
== self
._decimalpos
:
2510 self
._template
+= self
._decimalChar
2511 elif self
._isMaskChar
(pos
):
2512 if field
._fillChar
!= self
._ctrl
_constraints
._fillChar
and not reset_fillchar
:
2513 fillChar
= field
._fillChar
2515 fillChar
= self
._ctrl
_constraints
._fillChar
2516 self
._fillChar
[pos
] = fillChar
2518 # Replace any current old fillchar with new one in current value;
2519 # if action required, set reset_value flag so we can take that action
2520 # after we're all done
2521 if self
.controlInitialized
and old_fillchars
and old_fillchars
.has_key(pos
) and curvalue
:
2522 if curvalue
[pos
] == old_fillchars
[pos
] and old_fillchars
[pos
] != fillChar
:
2524 curvalue
[pos
] = fillChar
2526 if not field
._defaultValue
and not self
._ctrl
_constraints
._defaultValue
:
2527 #### dbg('no default value')
2528 self
._template
+= fillChar
2529 field
._template
+= fillChar
2531 elif field
._defaultValue
and not reset_default
:
2532 #### dbg('len(field._defaultValue):', len(field._defaultValue))
2533 #### dbg('pos-start:', pos-start)
2534 if len(field
._defaultValue
) > pos
-start
:
2535 #### dbg('field._defaultValue[pos-start]: "%s"' % field._defaultValue[pos-start])
2536 self
._template
+= field
._defaultValue
[pos
-start
]
2537 field
._template
+= field
._defaultValue
[pos
-start
]
2539 #### dbg('field default not long enough; using fillChar')
2540 self
._template
+= fillChar
2541 field
._template
+= fillChar
2543 if len(self
._ctrl
_constraints
._defaultValue
) > pos
:
2544 #### dbg('using control default')
2545 self
._template
+= self
._ctrl
_constraints
._defaultValue
[pos
]
2546 field
._template
+= self
._ctrl
_constraints
._defaultValue
[pos
]
2548 #### dbg('ctrl default not long enough; using fillChar')
2549 self
._template
+= fillChar
2550 field
._template
+= fillChar
2551 #### dbg('field[%d]._template now "%s"' % (field._index, field._template))
2552 #### dbg('self._template now "%s"' % self._template)
2554 self
._template
+= self
._mask
[pos
]
2556 self
._fields
[-1]._template
= self
._template
# (for consistency)
2558 if curvalue
: # had an old value, put new one back together
2559 newvalue
= string
.join(curvalue
, "")
2564 self
._defaultValue
= self
._template
2565 ## dbg('self._defaultValue:', self._defaultValue)
2566 if not self
.IsEmpty(self
._defaultValue
) and not self
.IsValid(self
._defaultValue
):
2568 ve
= ValueError('Default value of "%s" is not a valid value for control "%s"' % (self
._defaultValue
, self
.name
))
2569 ve
.value
= self
._defaultValue
2572 # if no fillchar change, but old value == old template, replace it:
2573 if newvalue
== old_template
:
2574 newvalue
= self
._template
2577 self
._defaultValue
= None
2580 ## dbg('resetting value to: "%s"' % newvalue)
2581 pos
= self
._GetInsertionPoint
()
2582 sel_start
, sel_to
= self
._GetSelection
()
2583 self
._SetValue
(newvalue
)
2584 self
._SetInsertionPoint
(pos
)
2585 self
._SetSelection
(sel_start
, sel_to
)
2588 def _propagateConstraints(self
, **reset_args
):
2590 Subroutine for propagating changes to control-level constraints and
2591 formatting to the individual fields as appropriate.
2593 parent_codes
= self
._ctrl
_constraints
._formatcodes
2594 parent_includes
= self
._ctrl
_constraints
._includeChars
2595 parent_excludes
= self
._ctrl
_constraints
._excludeChars
2596 for i
in self
._field
_indices
:
2597 field
= self
._fields
[i
]
2599 if len(self
._field
_indices
) == 1:
2600 inherit_args
['formatcodes'] = parent_codes
2601 inherit_args
['includeChars'] = parent_includes
2602 inherit_args
['excludeChars'] = parent_excludes
2604 field_codes
= current_codes
= field
._GetParameter
('formatcodes')
2605 for c
in parent_codes
:
2606 if c
not in field_codes
: field_codes
+= c
2607 if field_codes
!= current_codes
:
2608 inherit_args
['formatcodes'] = field_codes
2610 include_chars
= current_includes
= field
._GetParameter
('includeChars')
2611 for c
in parent_includes
:
2612 if not c
in include_chars
: include_chars
+= c
2613 if include_chars
!= current_includes
:
2614 inherit_args
['includeChars'] = include_chars
2616 exclude_chars
= current_excludes
= field
._GetParameter
('excludeChars')
2617 for c
in parent_excludes
:
2618 if not c
in exclude_chars
: exclude_chars
+= c
2619 if exclude_chars
!= current_excludes
:
2620 inherit_args
['excludeChars'] = exclude_chars
2622 if reset_args
.has_key('defaultValue') and reset_args
['defaultValue']:
2623 inherit_args
['defaultValue'] = "" # (reset for field)
2625 for param
in Field
.propagating_params
:
2626 #### dbg('reset_args.has_key(%s)?' % param, reset_args.has_key(param))
2627 #### dbg('reset_args.has_key(%(param)s) and reset_args[%(param)s]?' % locals(), reset_args.has_key(param) and reset_args[param])
2628 if reset_args
.has_key(param
):
2629 inherit_args
[param
] = self
.GetCtrlParameter(param
)
2630 #### dbg('inherit_args[%s]' % param, inherit_args[param])
2633 field
._SetParameters
(**inherit_args
)
2634 field
._ValidateParameters
(**inherit_args
)
2637 def _validateChoices(self
):
2639 Subroutine that validates that all choices for given fields are at
2640 least of the necessary length, and that they all would be valid pastes
2641 if pasted into their respective fields.
2643 for field
in self
._fields
.values():
2645 index
= field
._index
2646 if len(self
._field
_indices
) == 1 and index
== 0 and field
._choices
== self
._ctrl
_constraints
._choices
:
2647 ## dbg('skipping (duplicate) choice validation of field 0')
2649 #### dbg('checking for choices for field', field._index)
2650 start
, end
= field
._extent
2651 field_length
= end
- start
2652 #### dbg('start, end, length:', start, end, field_length)
2653 for choice
in field
._choices
:
2654 #### dbg('testing "%s"' % choice)
2655 valid_paste
, ignore
, replace_to
= self
._validatePaste
(choice
, start
, end
)
2658 ve
= ValueError('"%s" could not be entered into field %d of control "%s"' % (choice
, index
, self
.name
))
2662 elif replace_to
> end
:
2664 ve
= ValueError('"%s" will not fit into field %d of control "%s"' (choice
, index
, self
.name
))
2669 #### dbg(choice, 'valid in field', index)
2672 def _configure(self
, mask
, **reset_args
):
2674 This function sets flags for automatic styling options. It is
2675 called whenever a control or field-level parameter is set/changed.
2677 This routine does the bulk of the interdependent parameter processing, determining
2678 the field extents of the mask if changed, resetting parameters as appropriate,
2679 determining the overall template value for the control, etc.
2681 reset_args is supplied if called from control's .SetCtrlParameters()
2682 routine, and indicates which if any parameters which can be
2683 overridden by individual fields have been reset by request for the
2688 ## dbg('MaskedEditMixin::_configure("%s")' % mask, indent=1)
2690 # Preprocess specified mask to expand {n} syntax, handle escaped
2691 # mask characters, etc and build the resulting positionally keyed
2692 # dictionary for which positions are mask vs. template characters:
2693 self
._mask
, self
._ismasked
, self
._explicit
_field
_boundaries
= self
._processMask
(mask
)
2694 self
._masklength
= len(self
._mask
)
2695 #### dbg('processed mask:', self._mask)
2697 # Preserve original mask specified, for subsequent reprocessing
2698 # if parameters change.
2699 ## dbg('mask: "%s"' % self._mask, 'previous mask: "%s"' % self._previous_mask)
2700 self
._previous
_mask
= mask
# save unexpanded mask for next time
2701 # Set expanded mask and extent of field -1 to width of entire control:
2702 self
._ctrl
_constraints
._SetParameters
(mask
= self
._mask
, extent
=(0,self
._masklength
))
2704 # Go parse mask to determine where each field is, construct field
2705 # instances as necessary, configure them with those extents, and
2706 # build lookup table mapping each position for control to its corresponding
2708 #### dbg('calculating field extents')
2710 self
._calcFieldExtents
()
2713 # Go process defaultValues and fillchars to construct the overall
2714 # template, and adjust the current value as necessary:
2715 reset_fillchar
= reset_args
.has_key('fillChar') and reset_args
['fillChar']
2716 reset_default
= reset_args
.has_key('defaultValue') and reset_args
['defaultValue']
2718 #### dbg('calculating template')
2719 self
._calcTemplate
(reset_fillchar
, reset_default
)
2721 # Propagate control-level formatting and character constraints to each
2722 # field if they don't already have them; if only one field, propagate
2723 # control-level validation constraints to field as well:
2724 #### dbg('propagating constraints')
2725 self
._propagateConstraints
(**reset_args
)
2728 if self
._isFloat
and self
._fields
[0]._groupChar
== self
._decimalChar
:
2729 raise AttributeError('groupChar (%s) and decimalChar (%s) must be distinct.' %
2730 (self
._fields
[0]._groupChar
, self
._decimalChar
) )
2732 #### dbg('fields:', indent=1)
2733 ## for i in [-1] + self._field_indices:
2734 #### dbg('field %d:' % i, self._fields[i].__dict__)
2737 # Set up special parameters for numeric control, if appropriate:
2739 self
._signpos
= 0 # assume it starts here, but it will move around on floats
2740 signkeys
= ['-', '+', ' ']
2742 signkeys
+= ['(', ')']
2743 for key
in signkeys
:
2745 if not self
._keyhandlers
.has_key(keycode
):
2746 self
._SetKeyHandler
(key
, self
._OnChangeSign
)
2747 elif self
._isInt
or self
._isFloat
:
2748 signkeys
= ['-', '+', ' ', '(', ')']
2749 for key
in signkeys
:
2751 if self
._keyhandlers
.has_key(keycode
) and self
._keyhandlers
[keycode
] == self
._OnChangeSign
:
2752 self
._SetKeyHandler
(key
, None)
2756 if self
._isFloat
or self
._isInt
:
2757 if self
.controlInitialized
:
2758 value
= self
._GetValue
()
2759 #### dbg('value: "%s"' % value, 'len(value):', len(value),
2760 ## 'len(self._ctrl_constraints._mask):',len(self._ctrl_constraints._mask))
2761 if len(value
) < len(self
._ctrl
_constraints
._mask
):
2763 if self
._useParens
and len(newvalue
) < len(self
._ctrl
_constraints
._mask
) and newvalue
.find('(') == -1:
2765 if self
._signOk
and len(newvalue
) < len(self
._ctrl
_constraints
._mask
) and newvalue
.find(')') == -1:
2766 newvalue
= ' ' + newvalue
2767 if len(newvalue
) < len(self
._ctrl
_constraints
._mask
):
2768 if self
._ctrl
_constraints
._alignRight
:
2769 newvalue
= newvalue
.rjust(len(self
._ctrl
_constraints
._mask
))
2771 newvalue
= newvalue
.ljust(len(self
._ctrl
_constraints
._mask
))
2772 ## dbg('old value: "%s"' % value)
2773 ## dbg('new value: "%s"' % newvalue)
2775 self
._SetValue
(newvalue
)
2776 except Exception, e
:
2777 ## dbg('exception raised:', e, 'resetting to initial value')
2778 self
._SetInitialValue
()
2780 elif len(value
) > len(self
._ctrl
_constraints
._mask
):
2782 if not self
._useParens
and newvalue
[-1] == ' ':
2783 newvalue
= newvalue
[:-1]
2784 if not self
._signOk
and len(newvalue
) > len(self
._ctrl
_constraints
._mask
):
2785 newvalue
= newvalue
[1:]
2786 if not self
._signOk
:
2787 newvalue
, signpos
, right_signpos
= self
._getSignedValue
(newvalue
)
2789 ## dbg('old value: "%s"' % value)
2790 ## dbg('new value: "%s"' % newvalue)
2792 self
._SetValue
(newvalue
)
2793 except Exception, e
:
2794 ## dbg('exception raised:', e, 'resetting to initial value')
2795 self
._SetInitialValue
()
2796 elif not self
._signOk
and ('(' in value
or '-' in value
):
2797 newvalue
, signpos
, right_signpos
= self
._getSignedValue
(value
)
2798 ## dbg('old value: "%s"' % value)
2799 ## dbg('new value: "%s"' % newvalue)
2801 self
._SetValue
(newvalue
)
2803 ## dbg('exception raised:', e, 'resetting to initial value')
2804 self
._SetInitialValue
()
2806 # Replace up/down arrow default handling:
2807 # make down act like tab, up act like shift-tab:
2809 #### dbg('Registering numeric navigation and control handlers (if not already set)')
2810 if not self
._keyhandlers
.has_key(wx
.WXK_DOWN
):
2811 self
._SetKeycodeHandler
(wx
.WXK_DOWN
, self
._OnChangeField
)
2812 if not self
._keyhandlers
.has_key(wx
.WXK_NUMPAD_DOWN
):
2813 self
._SetKeycodeHandler
(wx
.WXK_DOWN
, self
._OnChangeField
)
2814 if not self
._keyhandlers
.has_key(wx
.WXK_UP
):
2815 self
._SetKeycodeHandler
(wx
.WXK_UP
, self
._OnUpNumeric
) # (adds "shift" to up arrow, and calls _OnChangeField)
2816 if not self
._keyhandlers
.has_key(wx
.WXK_NUMPAD_UP
):
2817 self
._SetKeycodeHandler
(wx
.WXK_UP
, self
._OnUpNumeric
) # (adds "shift" to up arrow, and calls _OnChangeField)
2819 # On ., truncate contents right of cursor to decimal point (if any)
2820 # leaves cursor after decimal point if floating point, otherwise at 0.
2821 if not self
._keyhandlers
.has_key(ord(self
._decimalChar
)) or self
._keyhandlers
[ord(self
._decimalChar
)] != self
._OnDecimalPoint
:
2822 self
._SetKeyHandler
(self
._decimalChar
, self
._OnDecimalPoint
)
2824 if not self
._keyhandlers
.has_key(ord(self
._shiftDecimalChar
)) or self
._keyhandlers
[ord(self
._shiftDecimalChar
)] != self
._OnChangeField
:
2825 self
._SetKeyHandler
(self
._shiftDecimalChar
, self
._OnChangeField
) # (Shift-'.' == '>' on US keyboards)
2827 # Allow selective insert of groupchar in numbers:
2828 if not self
._keyhandlers
.has_key(ord(self
._fields
[0]._groupChar
)) or self
._keyhandlers
[ord(self
._fields
[0]._groupChar
)] != self
._OnGroupChar
:
2829 self
._SetKeyHandler
(self
._fields
[0]._groupChar
, self
._OnGroupChar
)
2831 ## dbg(indent=0, suspend=0)
2834 def _SetInitialValue(self
, value
=""):
2836 fills the control with the generated or supplied default value.
2837 It will also set/reset the font if necessary and apply
2838 formatting to the control at this time.
2840 ## dbg('MaskedEditMixin::_SetInitialValue("%s")' % value, indent=1)
2842 self
._prevValue
= self
._curValue
= self
._template
2843 # don't apply external validation rules in this case, as template may
2844 # not coincide with "legal" value...
2846 self
._SetValue
(self
._curValue
) # note the use of "raw" ._SetValue()...
2847 except Exception, e
:
2848 ## dbg('exception thrown:', e, indent=0)
2851 # Otherwise apply validation as appropriate to passed value:
2852 #### dbg('value = "%s", length:' % value, len(value))
2853 self
._prevValue
= self
._curValue
= value
2855 self
.SetValue(value
) # use public (validating) .SetValue()
2856 except Exception, e
:
2857 ## dbg('exception thrown:', e, indent=0)
2861 # Set value/type-specific formatting
2862 self
._applyFormatting
()
2866 def _calcSize(self
, size
=None):
2867 """ Calculate automatic size if allowed; must be called after the base control is instantiated"""
2868 #### dbg('MaskedEditMixin::_calcSize', indent=1)
2869 cont
= (size
is None or size
== wx
.DefaultSize
)
2871 if cont
and self
._autofit
:
2872 sizing_text
= 'M' * self
._masklength
2873 if wx
.Platform
!= "__WXMSW__": # give it a little extra space
2875 if wx
.Platform
== "__WXMAC__": # give it even a little more...
2877 #### dbg('len(sizing_text):', len(sizing_text), 'sizing_text: "%s"' % sizing_text)
2878 w
, h
= self
.GetTextExtent(sizing_text
)
2879 size
= (w
+4, self
.GetSize().height
)
2880 #### dbg('size:', size, indent=0)
2885 """ Set the control's font typeface -- pass the font name as str."""
2886 #### dbg('MaskedEditMixin::_setFont', indent=1)
2887 if not self
._useFixedWidthFont
:
2888 self
._font
= wx
.SystemSettings_GetFont(wx
.SYS_DEFAULT_GUI_FONT
)
2890 font
= self
.GetFont() # get size, weight, etc from current font
2892 # Set to teletype font (guaranteed to be mappable to all wxWindows
2894 self
._font
= wx
.Font( font
.GetPointSize(), wx
.TELETYPE
, font
.GetStyle(),
2895 font
.GetWeight(), font
.GetUnderlined())
2896 #### dbg('font string: "%s"' % font.GetNativeFontInfo().ToString())
2898 self
.SetFont(self
._font
)
2902 def _OnTextChange(self
, event
):
2904 Handler for EVT_TEXT event.
2905 self._Change() is provided for subclasses, and may return False to
2906 skip this method logic. This function returns True if the event
2907 detected was a legitimate event, or False if it was a "bogus"
2908 EVT_TEXT event. (NOTE: There is currently an issue with calling
2909 .SetValue from within the EVT_CHAR handler that causes duplicate
2910 EVT_TEXT events for the same change.)
2912 newvalue
= self
._GetValue
()
2913 ## dbg('MaskedEditMixin::_OnTextChange: value: "%s"' % newvalue, indent=1)
2915 if self
._ignoreChange
: # ie. if an "intermediate text change event"
2919 ##! WS: For some inexplicable reason, every wx.TextCtrl.SetValue
2920 ## call is generating two (2) EVT_TEXT events. On certain platforms,
2921 ## (eg. linux/GTK) the 1st is an empty string value.
2922 ## This is the only mechanism I can find to mask this problem:
2923 if newvalue
== self
._curValue
or len(newvalue
) == 0:
2924 ## dbg('ignoring bogus text change event', indent=0)
2927 ## dbg('curvalue: "%s", newvalue: "%s", len(newvalue): %d' % (self._curValue, newvalue, len(newvalue)))
2929 if self
._signOk
and self
._isNeg
and newvalue
.find('-') == -1 and newvalue
.find('(') == -1:
2930 ## dbg('clearing self._isNeg')
2932 text
, self
._signpos
, self
._right
_signpos
= self
._getSignedValue
()
2933 self
._CheckValid
() # Recolor control as appropriate
2934 ## dbg('calling event.Skip()')
2937 self
._prevValue
= self
._curValue
# save for undo
2938 self
._curValue
= newvalue
# Save last seen value for next iteration
2943 def _OnKeyDown(self
, event
):
2945 This function allows the control to capture Ctrl-events like Ctrl-tab,
2946 that are not normally seen by the "cooked" EVT_CHAR routine.
2948 # Get keypress value, adjusted by control options (e.g. convert to upper etc)
2949 key
= event
.GetKeyCode()
2950 if key
in self
._nav
and event
.ControlDown():
2951 # then this is the only place we will likely see these events;
2953 ## dbg('MaskedEditMixin::OnKeyDown: calling _OnChar')
2956 # else allow regular EVT_CHAR key processing
2960 def _OnChar(self
, event
):
2962 This is the engine of MaskedEdit controls. It examines each keystroke,
2963 decides if it's allowed, where it should go or what action to take.
2965 ## dbg('MaskedEditMixin::_OnChar', indent=1)
2967 # Get keypress value, adjusted by control options (e.g. convert to upper etc)
2968 key
= event
.GetKeyCode()
2969 orig_pos
= self
._GetInsertionPoint
()
2970 orig_value
= self
._GetValue
()
2971 ## dbg('keycode = ', key)
2972 ## dbg('current pos = ', orig_pos)
2973 ## dbg('current selection = ', self._GetSelection())
2975 if not self
._Keypress
(key
):
2979 # If no format string for this control, or the control is marked as "read-only",
2980 # skip the rest of the special processing, and just "do the standard thing:"
2981 if not self
._mask
or not self
._IsEditable
():
2986 # Process navigation and control keys first, with
2987 # position/selection unadulterated:
2988 if key
in self
._nav
+ self
._control
:
2989 if self
._keyhandlers
.has_key(key
):
2990 keep_processing
= self
._keyhandlers
[key
](event
)
2991 if self
._GetValue
() != orig_value
:
2992 self
.modified
= True
2993 if not keep_processing
:
2996 self
._applyFormatting
()
3000 # Else... adjust the position as necessary for next input key,
3001 # and determine resulting selection:
3002 pos
= self
._adjustPos
( orig_pos
, key
) ## get insertion position, adjusted as needed
3003 sel_start
, sel_to
= self
._GetSelection
() ## check for a range of selected text
3004 ## dbg("pos, sel_start, sel_to:", pos, sel_start, sel_to)
3006 keep_processing
= True
3007 # Capture user past end of format field
3008 if pos
> len(self
.maskdict
):
3009 ## dbg("field length exceeded:",pos)
3010 keep_processing
= False
3012 key
= self
._adjustKey
(pos
, key
) # apply formatting constraints to key:
3014 if self
._keyhandlers
.has_key(key
):
3015 # there's an override for default behavior; use override function instead
3016 ## dbg('using supplied key handler:', self._keyhandlers[key])
3017 keep_processing
= self
._keyhandlers
[key
](event
)
3018 if self
._GetValue
() != orig_value
:
3019 self
.modified
= True
3020 if not keep_processing
:
3023 # else skip default processing, but do final formatting
3024 if key
in wx_control_keycodes
:
3025 ## dbg('key in wx_control_keycodes')
3026 event
.Skip() # non-printable; let base control handle it
3027 keep_processing
= False
3029 field
= self
._FindField
(pos
)
3031 if 'unicode' in wx
.PlatformInfo
:
3033 char
= chr(key
) # (must work if we got this far)
3034 char
= char
.decode(self
._defaultEncoding
)
3036 char
= unichr(event
.GetUnicodeKey())
3037 ## dbg('unicode char:', char)
3039 if type(field
._excludeChars
) != types
.UnicodeType
:
3040 excludes
+= field
._excludeChars
.decode(self
._defaultEncoding
)
3041 if type(self
._ctrl
_constraints
) != types
.UnicodeType
:
3042 excludes
+= self
._ctrl
_constraints
._excludeChars
.decode(self
._defaultEncoding
)
3044 char
= chr(key
) # (must work if we got this far)
3045 excludes
= field
._excludeChars
+ self
._ctrl
_constraints
._excludeChars
3047 ## dbg("key ='%s'" % chr(key))
3049 ## dbg('okSpaces?', field._okSpaces)
3053 if char
in excludes
:
3054 keep_processing
= False
3056 if keep_processing
and self
._isCharAllowed
( char
, pos
, checkRegex
= True ):
3057 ## dbg("key allowed by mask")
3058 # insert key into candidate new value, but don't change control yet:
3059 oldstr
= self
._GetValue
()
3060 newstr
, newpos
, new_select_to
, match_field
, match_index
= self
._insertKey
(
3061 char
, pos
, sel_start
, sel_to
, self
._GetValue
(), allowAutoSelect
= True)
3062 ## dbg("str with '%s' inserted:" % char, '"%s"' % newstr)
3063 if self
._ctrl
_constraints
._validRequired
and not self
.IsValid(newstr
):
3064 ## dbg('not valid; checking to see if adjusted string is:')
3065 keep_processing
= False
3066 if self
._isFloat
and newstr
!= self
._template
:
3067 newstr
= self
._adjustFloat
(newstr
)
3068 ## dbg('adjusted str:', newstr)
3069 if self
.IsValid(newstr
):
3071 keep_processing
= True
3072 wx
.CallAfter(self
._SetInsertionPoint
, self
._decimalpos
)
3073 if not keep_processing
:
3074 ## dbg("key disallowed by validation")
3075 if not wx
.Validator_IsSilent() and orig_pos
== pos
:
3081 # special case: adjust date value as necessary:
3082 if self
._isDate
and newstr
!= self
._template
:
3083 newstr
= self
._adjustDate
(newstr
)
3084 ## dbg('adjusted newstr:', newstr)
3086 if newstr
!= orig_value
:
3087 self
.modified
= True
3089 wx
.CallAfter(self
._SetValue
, newstr
)
3091 # Adjust insertion point on date if just entered 2 digit year, and there are now 4 digits:
3092 if not self
.IsDefault() and self
._isDate
and self
._4digityear
:
3093 year2dig
= self
._dateExtent
- 2
3094 if pos
== year2dig
and unadjusted
[year2dig
] != newstr
[year2dig
]:
3097 ## dbg('queuing insertion point: (%d)' % newpos)
3098 wx
.CallAfter(self
._SetInsertionPoint
, newpos
)
3100 if match_field
is not None:
3101 ## dbg('matched field')
3102 self
._OnAutoSelect
(match_field
, match_index
)
3104 if new_select_to
!= newpos
:
3105 ## dbg('queuing selection: (%d, %d)' % (newpos, new_select_to))
3106 wx
.CallAfter(self
._SetSelection
, newpos
, new_select_to
)
3108 newfield
= self
._FindField
(newpos
)
3109 if newfield
!= field
and newfield
._selectOnFieldEntry
:
3110 ## dbg('queuing insertion point: (%d)' % newfield._extent[0])
3111 wx
.CallAfter(self
._SetInsertionPoint
, newfield
._extent
[0])
3112 ## dbg('queuing selection: (%d, %d)' % (newfield._extent[0], newfield._extent[1]))
3113 wx
.CallAfter(self
._SetSelection
, newfield
._extent
[0], newfield
._extent
[1])
3115 wx
.CallAfter(self
._SetSelection
, newpos
, new_select_to
)
3116 keep_processing
= False
3118 elif keep_processing
:
3119 ## dbg('char not allowed')
3120 keep_processing
= False
3121 if (not wx
.Validator_IsSilent()) and orig_pos
== pos
:
3124 self
._applyFormatting
()
3126 # Move to next insertion point
3127 if keep_processing
and key
not in self
._nav
:
3128 pos
= self
._GetInsertionPoint
()
3129 next_entry
= self
._findNextEntry
( pos
)
3130 if pos
!= next_entry
:
3131 ## dbg("moving from %(pos)d to next valid entry: %(next_entry)d" % locals())
3132 wx
.CallAfter(self
._SetInsertionPoint
, next_entry
)
3134 if self
._isTemplateChar
(pos
):
3135 self
._AdjustField
(pos
)
3139 def _FindFieldExtent(self
, pos
=None, getslice
=False, value
=None):
3140 """ returns editable extent of field corresponding to
3141 position pos, and, optionally, the contents of that field
3142 in the control or the value specified.
3143 Template chars are bound to the preceding field.
3144 For masks beginning with template chars, these chars are ignored
3145 when calculating the current field.
3147 Eg: with template (###) ###-####,
3148 >>> self._FindFieldExtent(pos=0)
3150 >>> self._FindFieldExtent(pos=1)
3152 >>> self._FindFieldExtent(pos=5)
3154 >>> self._FindFieldExtent(pos=6)
3156 >>> self._FindFieldExtent(pos=10)
3160 ## dbg('MaskedEditMixin::_FindFieldExtent(pos=%s, getslice=%s)' % (str(pos), str(getslice)) ,indent=1)
3162 field
= self
._FindField
(pos
)
3165 return None, None, ""
3168 edit_start
, edit_end
= field
._extent
3170 if value
is None: value
= self
._GetValue
()
3171 slice = value
[edit_start
:edit_end
]
3172 ## dbg('edit_start:', edit_start, 'edit_end:', edit_end, 'slice: "%s"' % slice)
3174 return edit_start
, edit_end
, slice
3176 ## dbg('edit_start:', edit_start, 'edit_end:', edit_end)
3178 return edit_start
, edit_end
3181 def _FindField(self
, pos
=None):
3183 Returns the field instance in which pos resides.
3184 Template chars are bound to the preceding field.
3185 For masks beginning with template chars, these chars are ignored
3186 when calculating the current field.
3189 #### dbg('MaskedEditMixin::_FindField(pos=%s)' % str(pos) ,indent=1)
3190 if pos
is None: pos
= self
._GetInsertionPoint
()
3191 elif pos
< 0 or pos
> self
._masklength
:
3192 raise IndexError('position %s out of range of control' % str(pos
))
3194 if len(self
._fields
) == 0:
3200 return self
._fields
[self
._lookupField
[pos
]]
3203 def ClearValue(self
):
3204 """ Blanks the current control value by replacing it with the default value."""
3205 ## dbg("MaskedEditMixin::ClearValue - value reset to default value (template)")
3206 self
._SetValue
( self
._template
)
3207 self
._SetInsertionPoint
(0)
3211 def _baseCtrlEventHandler(self
, event
):
3213 This function is used whenever a key should be handled by the base control.
3219 def _OnUpNumeric(self
, event
):
3221 Makes up-arrow act like shift-tab should; ie. take you to start of
3224 ## dbg('MaskedEditMixin::_OnUpNumeric', indent=1)
3225 event
.m_shiftDown
= 1
3226 ## dbg('event.ShiftDown()?', event.ShiftDown())
3227 self
._OnChangeField
(event
)
3231 def _OnArrow(self
, event
):
3233 Used in response to left/right navigation keys; makes these actions skip
3234 over mask template chars.
3236 ## dbg("MaskedEditMixin::_OnArrow", indent=1)
3237 pos
= self
._GetInsertionPoint
()
3238 keycode
= event
.GetKeyCode()
3239 sel_start
, sel_to
= self
._GetSelection
()
3240 entry_end
= self
._goEnd
(getPosOnly
=True)
3241 if keycode
in (wx
.WXK_RIGHT
, wx
.WXK_DOWN
, wx
.WXK_NUMPAD_RIGHT
, wx
.WXK_NUMPAD_DOWN
):
3242 if( ( not self
._isTemplateChar
(pos
) and pos
+1 > entry_end
)
3243 or ( self
._isTemplateChar
(pos
) and pos
>= entry_end
) ):
3244 ## dbg("can't advance", indent=0)
3246 elif self
._isTemplateChar
(pos
):
3247 self
._AdjustField
(pos
)
3248 elif keycode
in (wx
.WXK_LEFT
, wx
.WXK_UP
, wx
.WXK_NUMPAD_LEFT
, wx
.WXK_NUMPAD_UP
) and sel_start
== sel_to
and pos
> 0 and self
._isTemplateChar
(pos
-1):
3249 ## dbg('adjusting field')
3250 self
._AdjustField
(pos
)
3252 # treat as shifted up/down arrows as tab/reverse tab:
3253 if event
.ShiftDown() and keycode
in (wx
.WXK_UP
, wx
.WXK_DOWN
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_DOWN
):
3254 # remove "shifting" and treat as (forward) tab:
3255 event
.m_shiftDown
= False
3256 keep_processing
= self
._OnChangeField
(event
)
3258 elif self
._FindField
(pos
)._selectOnFieldEntry
:
3259 if( keycode
in (wx
.WXK_UP
, wx
.WXK_LEFT
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_LEFT
)
3261 and self
._isTemplateChar
(sel_start
-1)
3262 and sel_start
!= self
._masklength
3263 and not self
._signOk
and not self
._useParens
):
3265 # call _OnChangeField to handle "ctrl-shifted event"
3266 # (which moves to previous field and selects it.)
3267 event
.m_shiftDown
= True
3268 event
.m_ControlDown
= True
3269 keep_processing
= self
._OnChangeField
(event
)
3270 elif( keycode
in (wx
.WXK_DOWN
, wx
.WXK_RIGHT
, wx
.WXK_NUMPAD_DOWN
, wx
.WXK_NUMPAD_RIGHT
)
3271 and sel_to
!= self
._masklength
3272 and self
._isTemplateChar
(sel_to
)):
3274 # when changing field to the right, ensure don't accidentally go left instead
3275 event
.m_shiftDown
= False
3276 keep_processing
= self
._OnChangeField
(event
)
3278 # treat arrows as normal, allowing selection
3280 ## dbg('using base ctrl event processing')
3283 if( (sel_to
== self
._fields
[0]._extent
[0] and keycode
in (wx
.WXK_LEFT
, wx
.WXK_NUMPAD_LEFT
) )
3284 or (sel_to
== self
._masklength
and keycode
in (wx
.WXK_RIGHT
, wx
.WXK_NUMPAD_RIGHT
) ) ):
3285 if not wx
.Validator_IsSilent():
3288 # treat arrows as normal, allowing selection
3290 ## dbg('using base event processing')
3293 keep_processing
= False
3295 return keep_processing
3298 def _OnCtrl_S(self
, event
):
3299 """ Default Ctrl-S handler; prints value information if demo enabled. """
3300 ## dbg("MaskedEditMixin::_OnCtrl_S")
3302 print 'MaskedEditMixin.GetValue() = "%s"\nMaskedEditMixin.GetPlainValue() = "%s"' % (self
.GetValue(), self
.GetPlainValue())
3303 print "Valid? => " + str(self
.IsValid())
3304 print "Current field, start, end, value =", str( self
._FindFieldExtent
(getslice
=True))
3308 def _OnCtrl_X(self
, event
=None):
3309 """ Handles ctrl-x keypress in control and Cut operation on context menu.
3310 Should return False to skip other processing. """
3311 ## dbg("MaskedEditMixin::_OnCtrl_X", indent=1)
3316 def _OnCtrl_C(self
, event
=None):
3317 """ Handles ctrl-C keypress in control and Copy operation on context menu.
3318 Uses base control handling. Should return False to skip other processing."""
3322 def _OnCtrl_V(self
, event
=None):
3323 """ Handles ctrl-V keypress in control and Paste operation on context menu.
3324 Should return False to skip other processing. """
3325 ## dbg("MaskedEditMixin::_OnCtrl_V", indent=1)
3330 def _OnInsert(self
, event
=None):
3331 """ Handles shift-insert and control-insert operations (paste and copy, respectively)"""
3332 ## dbg("MaskedEditMixin::_OnInsert", indent=1)
3333 if event
and isinstance(event
, wx
.KeyEvent
):
3334 if event
.ShiftDown():
3336 elif event
.ControlDown():
3343 def _OnDelete(self
, event
=None):
3344 """ Handles shift-delete and delete operations (cut and erase, respectively)"""
3345 ## dbg("MaskedEditMixin::_OnDelete", indent=1)
3346 if event
and isinstance(event
, wx
.KeyEvent
):
3347 if event
.ShiftDown():
3350 self
._OnErase
(event
)
3352 self
._OnErase
(event
)
3356 def _OnCtrl_Z(self
, event
=None):
3357 """ Handles ctrl-Z keypress in control and Undo operation on context menu.
3358 Should return False to skip other processing. """
3359 ## dbg("MaskedEditMixin::_OnCtrl_Z", indent=1)
3364 def _OnCtrl_A(self
,event
=None):
3365 """ Handles ctrl-a keypress in control. Should return False to skip other processing. """
3366 end
= self
._goEnd
(getPosOnly
=True)
3367 if not event
or (isinstance(event
, wx
.KeyEvent
) and event
.ShiftDown()):
3368 wx
.CallAfter(self
._SetInsertionPoint
, 0)
3369 wx
.CallAfter(self
._SetSelection
, 0, self
._masklength
)
3371 wx
.CallAfter(self
._SetInsertionPoint
, 0)
3372 wx
.CallAfter(self
._SetSelection
, 0, end
)
3376 def _OnErase(self
, event
=None, just_return_value
=False):
3377 """ Handles backspace and delete keypress in control. Should return False to skip other processing."""
3378 ## dbg("MaskedEditMixin::_OnErase", indent=1)
3379 sel_start
, sel_to
= self
._GetSelection
() ## check for a range of selected text
3381 if event
is None: # called as action routine from Cut() operation.
3384 key
= event
.GetKeyCode()
3386 field
= self
._FindField
(sel_to
)
3387 start
, end
= field
._extent
3388 value
= self
._GetValue
()
3389 oldstart
= sel_start
3391 # If trying to erase beyond "legal" bounds, disallow operation:
3392 if( (sel_to
== 0 and key
== wx
.WXK_BACK
)
3393 or (self
._signOk
and sel_to
== 1 and value
[0] == ' ' and key
== wx
.WXK_BACK
)
3394 or (sel_to
== self
._masklength
and sel_start
== sel_to
and key
in (wx
.WXK_DELETE
, wx
.WXK_NUMPAD_DELETE
) and not field
._insertRight
)
3395 or (self
._signOk
and self
._useParens
3396 and sel_start
== sel_to
3397 and sel_to
== self
._masklength
- 1
3398 and value
[sel_to
] == ' ' and key
in (wx
.WXK_DELETE
, wx
.WXK_NUMPAD_DELETE
) and not field
._insertRight
) ):
3399 if not wx
.Validator_IsSilent():
3405 if( field
._insertRight
# an insert-right field
3406 and value
[start
:end
] != self
._template
[start
:end
] # and field not empty
3407 and sel_start
>= start
# and selection starts in field
3408 and ((sel_to
== sel_start
# and no selection
3409 and sel_to
== end
# and cursor at right edge
3410 and key
in (wx
.WXK_BACK
, wx
.WXK_DELETE
, wx
.WXK_NUMPAD_DELETE
)) # and either delete or backspace key
3412 (key
== wx
.WXK_BACK
# backspacing
3413 and (sel_to
== end
# and selection ends at right edge
3414 or sel_to
< end
and field
._allowInsert
)) ) ): # or allow right insert at any point in field
3416 ## dbg('delete left')
3417 # if backspace but left of cursor is empty, adjust cursor right before deleting
3418 while( key
== wx
.WXK_BACK
3419 and sel_start
== sel_to
3421 and value
[start
:sel_start
] == self
._template
[start
:sel_start
]):
3425 ## dbg('sel_start, start:', sel_start, start)
3427 if sel_start
== sel_to
:
3431 newfield
= value
[start
:keep
] + value
[sel_to
:end
]
3433 # handle sign char moving from outside field into the field:
3434 move_sign_into_field
= False
3435 if not field
._padZero
and self
._signOk
and self
._isNeg
and value
[0] in ('-', '('):
3437 newfield
= signchar
+ newfield
3438 move_sign_into_field
= True
3439 ## dbg('cut newfield: "%s"' % newfield)
3441 # handle what should fill in from the left:
3443 for i
in range(start
, end
- len(newfield
)):
3446 elif( self
._signOk
and self
._isNeg
and i
== 1
3447 and ((self
._useParens
and newfield
.find('(') == -1)
3448 or (not self
._useParens
and newfield
.find('-') == -1)) ):
3451 left
+= self
._template
[i
] # this can produce strange results in combination with default values...
3452 newfield
= left
+ newfield
3453 ## dbg('filled newfield: "%s"' % newfield)
3455 newstr
= value
[:start
] + newfield
+ value
[end
:]
3457 # (handle sign located in "mask position" in front of field prior to delete)
3458 if move_sign_into_field
:
3459 newstr
= ' ' + newstr
[1:]
3462 # handle erasure of (left) sign, moving selection accordingly...
3463 if self
._signOk
and sel_start
== 0:
3464 newstr
= value
= ' ' + value
[1:]
3467 if field
._allowInsert
and sel_start
>= start
:
3468 # selection (if any) falls within current insert-capable field:
3469 select_len
= sel_to
- sel_start
3470 # determine where cursor should end up:
3471 if key
== wx
.WXK_BACK
:
3473 newpos
= sel_start
-1
3479 if sel_to
== sel_start
:
3480 erase_to
= sel_to
+ 1
3484 if self
._isTemplateChar
(newpos
) and select_len
== 0:
3486 if value
[newpos
] in ('(', '-'):
3487 newpos
+= 1 # don't move cusor
3488 newstr
= ' ' + value
[newpos
:]
3489 elif value
[newpos
] == ')':
3490 # erase right sign, but don't move cursor; (matching left sign handled later)
3491 newstr
= value
[:newpos
] + ' '
3493 # no deletion; just move cursor
3496 # no deletion; just move cursor
3499 if erase_to
> end
: erase_to
= end
3500 erase_len
= erase_to
- newpos
3502 left
= value
[start
:newpos
]
3503 ## dbg("retained ='%s'" % value[erase_to:end], 'sel_to:', sel_to, "fill: '%s'" % self._template[end - erase_len:end])
3504 right
= value
[erase_to
:end
] + self
._template
[end
-erase_len
:end
]
3506 if field
._alignRight
:
3507 rstripped
= right
.rstrip()
3508 if rstripped
!= right
:
3509 pos_adjust
= len(right
) - len(rstripped
)
3512 if not field
._insertRight
and value
[-1] == ')' and end
== self
._masklength
- 1:
3513 # need to shift ) into the field:
3514 right
= right
[:-1] + ')'
3515 value
= value
[:-1] + ' '
3517 newfield
= left
+right
3519 newfield
= newfield
.rjust(end
-start
)
3520 newpos
+= pos_adjust
3521 ## dbg("left='%s', right ='%s', newfield='%s'" %(left, right, newfield))
3522 newstr
= value
[:start
] + newfield
+ value
[end
:]
3527 if sel_start
== sel_to
:
3528 ## dbg("current sel_start, sel_to:", sel_start, sel_to)
3529 if key
== wx
.WXK_BACK
:
3530 sel_start
, sel_to
= sel_to
-1, sel_to
-1
3531 ## dbg("new sel_start, sel_to:", sel_start, sel_to)
3533 if field
._padZero
and not value
[start
:sel_to
].replace('0', '').replace(' ','').replace(field
._fillChar
, ''):
3534 # preceding chars (if any) are zeros, blanks or fillchar; new char should be 0:
3537 newchar
= self
._template
[sel_to
] ## get an original template character to "clear" the current char
3538 ## dbg('value = "%s"' % value, 'value[%d] = "%s"' %(sel_start, value[sel_start]))
3540 if self
._isTemplateChar
(sel_to
):
3541 if sel_to
== 0 and self
._signOk
and value
[sel_to
] == '-': # erasing "template" sign char
3542 newstr
= ' ' + value
[1:]
3544 elif self
._signOk
and self
._useParens
and (value
[sel_to
] == ')' or value
[sel_to
] == '('):
3545 # allow "change sign" by removing both parens:
3546 newstr
= value
[:self
._signpos
] + ' ' + value
[self
._signpos
+1:-1] + ' '
3551 if field
._insertRight
and sel_start
== sel_to
:
3552 # force non-insert-right behavior, by selecting char to be replaced:
3554 newstr
, ignore
= self
._insertKey
(newchar
, sel_start
, sel_start
, sel_to
, value
)
3558 newstr
= self
._eraseSelection
(value
, sel_start
, sel_to
)
3560 pos
= sel_start
# put cursor back at beginning of selection
3562 if self
._signOk
and self
._useParens
:
3563 # account for resultant unbalanced parentheses:
3564 left_signpos
= newstr
.find('(')
3565 right_signpos
= newstr
.find(')')
3567 if left_signpos
== -1 and right_signpos
!= -1:
3568 # erased left-sign marker; get rid of right sign marker:
3569 newstr
= newstr
[:right_signpos
] + ' ' + newstr
[right_signpos
+1:]
3571 elif left_signpos
!= -1 and right_signpos
== -1:
3572 # erased right-sign marker; get rid of left-sign marker:
3573 newstr
= newstr
[:left_signpos
] + ' ' + newstr
[left_signpos
+1:]
3575 ## dbg("oldstr:'%s'" % value, 'oldpos:', oldstart)
3576 ## dbg("newstr:'%s'" % newstr, 'pos:', pos)
3578 # if erasure results in an invalid field, disallow it:
3579 ## dbg('field._validRequired?', field._validRequired)
3580 ## dbg('field.IsValid("%s")?' % newstr[start:end], field.IsValid(newstr[start:end]))
3581 if field
._validRequired
and not field
.IsValid(newstr
[start
:end
]):
3582 if not wx
.Validator_IsSilent():
3587 # if erasure results in an invalid value, disallow it:
3588 if self
._ctrl
_constraints
._validRequired
and not self
.IsValid(newstr
):
3589 if not wx
.Validator_IsSilent():
3594 if just_return_value
:
3599 ## dbg('setting value (later) to', newstr)
3600 wx
.CallAfter(self
._SetValue
, newstr
)
3601 ## dbg('setting insertion point (later) to', pos)
3602 wx
.CallAfter(self
._SetInsertionPoint
, pos
)
3605 self
.modified
= True
3609 def _OnEnd(self
,event
):
3610 """ Handles End keypress in control. Should return False to skip other processing. """
3611 ## dbg("MaskedEditMixin::_OnEnd", indent=1)
3612 pos
= self
._adjustPos
(self
._GetInsertionPoint
(), event
.GetKeyCode())
3613 if not event
.ControlDown():
3614 end
= self
._masklength
# go to end of control
3615 if self
._signOk
and self
._useParens
:
3616 end
= end
- 1 # account for reserved char at end
3618 end_of_input
= self
._goEnd
(getPosOnly
=True)
3619 sel_start
, sel_to
= self
._GetSelection
()
3620 if sel_to
< pos
: sel_to
= pos
3621 field
= self
._FindField
(sel_to
)
3622 field_end
= self
._FindField
(end_of_input
)
3624 # pick different end point if either:
3625 # - cursor not in same field
3626 # - or at or past last input already
3627 # - or current selection = end of current field:
3628 #### dbg('field != field_end?', field != field_end)
3629 #### dbg('sel_to >= end_of_input?', sel_to >= end_of_input)
3630 if field
!= field_end
or sel_to
>= end_of_input
:
3631 edit_start
, edit_end
= field
._extent
3632 #### dbg('edit_end:', edit_end)
3633 #### dbg('sel_to:', sel_to)
3634 #### dbg('sel_to == edit_end?', sel_to == edit_end)
3635 #### dbg('field._index < self._field_indices[-1]?', field._index < self._field_indices[-1])
3637 if sel_to
== edit_end
and field
._index
< self
._field
_indices
[-1]:
3638 edit_start
, edit_end
= self
._FindFieldExtent
(self
._findNextEntry
(edit_end
)) # go to end of next field:
3640 ## dbg('end moved to', end)
3642 elif sel_to
== edit_end
and field
._index
== self
._field
_indices
[-1]:
3643 # already at edit end of last field; select to end of control:
3644 end
= self
._masklength
3645 ## dbg('end moved to', end)
3647 end
= edit_end
# select to end of current field
3648 ## dbg('end moved to ', end)
3650 # select to current end of input
3654 #### dbg('pos:', pos, 'end:', end)
3656 if event
.ShiftDown():
3657 if not event
.ControlDown():
3658 ## dbg("shift-end; select to end of control")
3661 ## dbg("shift-ctrl-end; select to end of non-whitespace")
3663 wx
.CallAfter(self
._SetInsertionPoint
, pos
)
3664 wx
.CallAfter(self
._SetSelection
, pos
, end
)
3666 if not event
.ControlDown():
3667 ## dbg('go to end of control:')
3669 wx
.CallAfter(self
._SetInsertionPoint
, end
)
3670 wx
.CallAfter(self
._SetSelection
, end
, end
)
3676 def _OnReturn(self
, event
):
3678 Swallows the return, issues a Navigate event instead, since
3679 masked controls are "single line" by defn.
3681 ## dbg('MaskedEditMixin::OnReturn')
3686 def _OnHome(self
,event
):
3687 """ Handles Home keypress in control. Should return False to skip other processing."""
3688 ## dbg("MaskedEditMixin::_OnHome", indent=1)
3689 pos
= self
._adjustPos
(self
._GetInsertionPoint
(), event
.GetKeyCode())
3690 sel_start
, sel_to
= self
._GetSelection
()
3692 # There are 5 cases here:
3694 # 1) shift: select from start of control to end of current
3696 if event
.ShiftDown() and not event
.ControlDown():
3697 ## dbg("shift-home; select to start of control")
3701 # 2) no shift, no control: move cursor to beginning of control.
3702 elif not event
.ControlDown():
3703 ## dbg("home; move to start of control")
3707 # 3) No shift, control: move cursor back to beginning of field; if
3708 # there already, go to beginning of previous field.
3709 # 4) shift, control, start of selection not at beginning of control:
3710 # move sel_start back to start of field; if already there, go to
3711 # start of previous field.
3712 elif( event
.ControlDown()
3713 and (not event
.ShiftDown()
3714 or (event
.ShiftDown() and sel_start
> 0) ) ):
3715 if len(self
._field
_indices
) > 1:
3716 field
= self
._FindField
(sel_start
)
3717 start
, ignore
= field
._extent
3718 if sel_start
== start
and field
._index
!= self
._field
_indices
[0]: # go to start of previous field:
3719 start
, ignore
= self
._FindFieldExtent
(sel_start
-1)
3720 elif sel_start
== start
:
3721 start
= 0 # go to literal beginning if edit start
3728 if not event
.ShiftDown():
3729 ## dbg("ctrl-home; move to beginning of field")
3732 ## dbg("shift-ctrl-home; select to beginning of field")
3736 # 5) shift, control, start of selection at beginning of control:
3737 # unselect by moving sel_to backward to beginning of current field;
3738 # if already there, move to start of previous field.
3740 if len(self
._field
_indices
) > 1:
3741 # find end of previous field:
3742 field
= self
._FindField
(sel_to
)
3743 if sel_to
> start
and field
._index
!= self
._field
_indices
[0]:
3744 ignore
, end
= self
._FindFieldExtent
(field
._extent
[0]-1)
3750 end_of_field
= False
3751 ## dbg("shift-ctrl-home; unselect to beginning of field")
3753 ## dbg('queuing new sel_start, sel_to:', (start, end))
3754 wx
.CallAfter(self
._SetInsertionPoint
, start
)
3755 wx
.CallAfter(self
._SetSelection
, start
, end
)
3760 def _OnChangeField(self
, event
):
3762 Primarily handles TAB events, but can be used for any key that
3763 designer wants to change fields within a masked edit control.
3765 ## dbg('MaskedEditMixin::_OnChangeField', indent = 1)
3766 # determine end of current field:
3767 pos
= self
._GetInsertionPoint
()
3768 ## dbg('current pos:', pos)
3769 sel_start
, sel_to
= self
._GetSelection
()
3771 if self
._masklength
< 0: # no fields; process tab normally
3772 self
._AdjustField
(pos
)
3773 if event
.GetKeyCode() == wx
.WXK_TAB
:
3774 ## dbg('tab to next ctrl')
3775 # As of 2.5.2, you don't call event.Skip() to do
3776 # this, but instead force explicit navigation, if
3777 # wx.TE_PROCESS_TAB is used (like in the masked edits)
3783 field
= self
._FindField
(sel_to
)
3784 index
= field
._index
3785 field_start
, field_end
= field
._extent
3786 slice = self
._GetValue
()[field_start
:field_end
]
3788 ## dbg('field._stopFieldChangeIfInvalid?', field._stopFieldChangeIfInvalid)
3789 ## dbg('field.IsValid(slice)?', field.IsValid(slice))
3791 if field
._stopFieldChangeIfInvalid
and not field
.IsValid(slice):
3792 ## dbg('field invalid; field change disallowed')
3793 if not wx
.Validator_IsSilent():
3799 if event
.ShiftDown():
3803 # NOTE: doesn't yet work with SHIFT-tab under wx; the control
3804 # never sees this event! (But I've coded for it should it ever work,
3805 # and it *does* work for '.' in IpAddrCtrl.)
3807 if pos
< field_start
:
3808 ## dbg('cursor before 1st field; cannot change to a previous field')
3809 if not wx
.Validator_IsSilent():
3814 if event
.ControlDown():
3815 ## dbg('queuing select to beginning of field:', field_start, pos)
3816 wx
.CallAfter(self
._SetInsertionPoint
, field_start
)
3817 wx
.CallAfter(self
._SetSelection
, field_start
, pos
)
3822 # We're already in the 1st field; process shift-tab normally:
3823 self
._AdjustField
(pos
)
3824 if event
.GetKeyCode() == wx
.WXK_TAB
:
3825 ## dbg('tab to previous ctrl')
3826 # As of 2.5.2, you don't call event.Skip() to do
3827 # this, but instead force explicit navigation, if
3828 # wx.TE_PROCESS_TAB is used (like in the masked edits)
3829 self
.Navigate(False)
3831 ## dbg('position at beginning')
3832 wx
.CallAfter(self
._SetInsertionPoint
, field_start
)
3836 # find beginning of previous field:
3837 begin_prev
= self
._FindField
(field_start
-1)._extent
[0]
3838 self
._AdjustField
(pos
)
3839 ## dbg('repositioning to', begin_prev)
3840 wx
.CallAfter(self
._SetInsertionPoint
, begin_prev
)
3841 if self
._FindField
(begin_prev
)._selectOnFieldEntry
:
3842 edit_start
, edit_end
= self
._FindFieldExtent
(begin_prev
)
3843 ## dbg('queuing selection to (%d, %d)' % (edit_start, edit_end))
3844 wx
.CallAfter(self
._SetInsertionPoint
, edit_start
)
3845 wx
.CallAfter(self
._SetSelection
, edit_start
, edit_end
)
3851 if event
.ControlDown():
3852 ## dbg('queuing select to end of field:', pos, field_end)
3853 wx
.CallAfter(self
._SetInsertionPoint
, pos
)
3854 wx
.CallAfter(self
._SetSelection
, pos
, field_end
)
3858 if pos
< field_start
:
3859 ## dbg('cursor before 1st field; go to start of field')
3860 wx
.CallAfter(self
._SetInsertionPoint
, field_start
)
3861 if field
._selectOnFieldEntry
:
3862 wx
.CallAfter(self
._SetSelection
, field_start
, field_end
)
3864 wx
.CallAfter(self
._SetSelection
, field_start
, field_start
)
3867 ## dbg('end of current field:', field_end)
3868 ## dbg('go to next field')
3869 if field_end
== self
._fields
[self
._field
_indices
[-1]]._extent
[1]:
3870 self
._AdjustField
(pos
)
3871 if event
.GetKeyCode() == wx
.WXK_TAB
:
3872 ## dbg('tab to next ctrl')
3873 # As of 2.5.2, you don't call event.Skip() to do
3874 # this, but instead force explicit navigation, if
3875 # wx.TE_PROCESS_TAB is used (like in the masked edits)
3878 ## dbg('position at end')
3879 wx
.CallAfter(self
._SetInsertionPoint
, field_end
)
3883 # we have to find the start of the next field
3884 next_pos
= self
._findNextEntry
(field_end
)
3885 if next_pos
== field_end
:
3886 ## dbg('already in last field')
3887 self
._AdjustField
(pos
)
3888 if event
.GetKeyCode() == wx
.WXK_TAB
:
3889 ## dbg('tab to next ctrl')
3890 # As of 2.5.2, you don't call event.Skip() to do
3891 # this, but instead force explicit navigation, if
3892 # wx.TE_PROCESS_TAB is used (like in the masked edits)
3898 self
._AdjustField
( pos
)
3900 # move cursor to appropriate point in the next field and select as necessary:
3901 field
= self
._FindField
(next_pos
)
3902 edit_start
, edit_end
= field
._extent
3903 if field
._selectOnFieldEntry
:
3904 ## dbg('move to ', next_pos)
3905 wx
.CallAfter(self
._SetInsertionPoint
, next_pos
)
3906 edit_start
, edit_end
= self
._FindFieldExtent
(next_pos
)
3907 ## dbg('queuing select', edit_start, edit_end)
3908 wx
.CallAfter(self
._SetSelection
, edit_start
, edit_end
)
3910 if field
._insertRight
:
3911 next_pos
= field
._extent
[1]
3912 ## dbg('move to ', next_pos)
3913 wx
.CallAfter(self
._SetInsertionPoint
, next_pos
)
3919 def _OnDecimalPoint(self
, event
):
3920 ## dbg('MaskedEditMixin::_OnDecimalPoint', indent=1)
3921 field
= self
._FindField
(self
._GetInsertionPoint
())
3922 start
, end
= field
._extent
3923 slice = self
._GetValue
()[start
:end
]
3925 if field
._stopFieldChangeIfInvalid
and not field
.IsValid(slice):
3926 if not wx
.Validator_IsSilent():
3930 pos
= self
._adjustPos
(self
._GetInsertionPoint
(), event
.GetKeyCode())
3932 if self
._isFloat
: ## handle float value, move to decimal place
3933 ## dbg('key == Decimal tab; decimal pos:', self._decimalpos)
3934 value
= self
._GetValue
()
3935 if pos
< self
._decimalpos
:
3936 clipped_text
= value
[0:pos
] + self
._decimalChar
+ value
[self
._decimalpos
+1:]
3937 ## dbg('value: "%s"' % self._GetValue(), "clipped_text:'%s'" % clipped_text)
3938 newstr
= self
._adjustFloat
(clipped_text
)
3940 newstr
= self
._adjustFloat
(value
)
3941 wx
.CallAfter(self
._SetValue
, newstr
)
3942 fraction
= self
._fields
[1]
3943 start
, end
= fraction
._extent
3944 wx
.CallAfter(self
._SetInsertionPoint
, start
)
3945 if fraction
._selectOnFieldEntry
:
3946 ## dbg('queuing selection after decimal point to:', (start, end))
3947 wx
.CallAfter(self
._SetSelection
, start
, end
)
3949 wx
.CallAfter(self
._SetSelection
, start
, start
)
3950 keep_processing
= False
3952 if self
._isInt
: ## handle integer value, truncate from current position
3953 ## dbg('key == Integer decimal event')
3954 value
= self
._GetValue
()
3955 clipped_text
= value
[0:pos
]
3956 ## dbg('value: "%s"' % self._GetValue(), "clipped_text:'%s'" % clipped_text)
3957 newstr
= self
._adjustInt
(clipped_text
)
3958 ## dbg('newstr: "%s"' % newstr)
3959 wx
.CallAfter(self
._SetValue
, newstr
)
3960 newpos
= len(newstr
.rstrip())
3961 if newstr
.find(')') != -1:
3962 newpos
-= 1 # (don't move past right paren)
3963 wx
.CallAfter(self
._SetInsertionPoint
, newpos
)
3964 wx
.CallAfter(self
._SetSelection
, newpos
, newpos
)
3965 keep_processing
= False
3969 def _OnChangeSign(self
, event
):
3970 ## dbg('MaskedEditMixin::_OnChangeSign', indent=1)
3971 key
= event
.GetKeyCode()
3972 pos
= self
._adjustPos
(self
._GetInsertionPoint
(), key
)
3973 value
= self
._eraseSelection
()
3974 integer
= self
._fields
[0]
3975 start
, end
= integer
._extent
3976 sel_start
, sel_to
= self
._GetSelection
()
3978 #### dbg('adjusted pos:', pos)
3979 if chr(key
) in ('-','+','(', ')') or (chr(key
) == " " and pos
== self
._signpos
):
3980 cursign
= self
._isNeg
3981 ## dbg('cursign:', cursign)
3982 if chr(key
) in ('-','(', ')'):
3983 if sel_start
<= self
._signpos
:
3986 self
._isNeg
= (not self
._isNeg
) ## flip value
3989 ## dbg('isNeg?', self._isNeg)
3991 text
, self
._signpos
, self
._right
_signpos
= self
._getSignedValue
(candidate
=value
)
3992 ## dbg('text:"%s"' % text, 'signpos:', self._signpos, 'right_signpos:', self._right_signpos)
3996 if self
._isNeg
and self
._signpos
is not None and self
._signpos
!= -1:
3997 if self
._useParens
and self
._right
_signpos
is not None:
3998 text
= text
[:self
._signpos
] + '(' + text
[self
._signpos
+1:self
._right
_signpos
] + ')' + text
[self
._right
_signpos
+1:]
4000 text
= text
[:self
._signpos
] + '-' + text
[self
._signpos
+1:]
4002 #### dbg('self._isNeg?', self._isNeg, 'self.IsValid(%s)' % text, self.IsValid(text))
4004 text
= text
[:self
._signpos
] + ' ' + text
[self
._signpos
+1:self
._right
_signpos
] + ' ' + text
[self
._right
_signpos
+1:]
4006 text
= text
[:self
._signpos
] + ' ' + text
[self
._signpos
+1:]
4007 ## dbg('clearing self._isNeg')
4010 wx
.CallAfter(self
._SetValue
, text
)
4011 wx
.CallAfter(self
._applyFormatting
)
4012 ## dbg('pos:', pos, 'signpos:', self._signpos)
4013 if pos
== self
._signpos
or integer
.IsEmpty(text
[start
:end
]):
4014 wx
.CallAfter(self
._SetInsertionPoint
, self
._signpos
+1)
4016 wx
.CallAfter(self
._SetInsertionPoint
, pos
)
4018 keep_processing
= False
4020 keep_processing
= True
4022 return keep_processing
4025 def _OnGroupChar(self
, event
):
4027 This handler is only registered if the mask is a numeric mask.
4028 It allows the insertion of ',' or '.' if appropriate.
4030 ## dbg('MaskedEditMixin::_OnGroupChar', indent=1)
4031 keep_processing
= True
4032 pos
= self
._adjustPos
(self
._GetInsertionPoint
(), event
.GetKeyCode())
4033 sel_start
, sel_to
= self
._GetSelection
()
4034 groupchar
= self
._fields
[0]._groupChar
4035 if not self
._isCharAllowed
(groupchar
, pos
, checkRegex
=True):
4036 keep_processing
= False
4037 if not wx
.Validator_IsSilent():
4041 newstr
, newpos
= self
._insertKey
(groupchar
, pos
, sel_start
, sel_to
, self
._GetValue
() )
4042 ## dbg("str with '%s' inserted:" % groupchar, '"%s"' % newstr)
4043 if self
._ctrl
_constraints
._validRequired
and not self
.IsValid(newstr
):
4044 keep_processing
= False
4045 if not wx
.Validator_IsSilent():
4049 wx
.CallAfter(self
._SetValue
, newstr
)
4050 wx
.CallAfter(self
._SetInsertionPoint
, newpos
)
4051 keep_processing
= False
4053 return keep_processing
4056 def _findNextEntry(self
,pos
, adjustInsert
=True):
4057 """ Find the insertion point for the next valid entry character position."""
4058 ## dbg('MaskedEditMixin::_findNextEntry', indent=1)
4059 if self
._isTemplateChar
(pos
) or pos
in self
._explicit
_field
_boundaries
: # if changing fields, pay attn to flag
4060 adjustInsert
= adjustInsert
4061 else: # else within a field; flag not relevant
4062 adjustInsert
= False
4064 while self
._isTemplateChar
(pos
) and pos
< self
._masklength
:
4067 # if changing fields, and we've been told to adjust insert point,
4068 # look at new field; if empty and right-insert field,
4069 # adjust to right edge:
4070 if adjustInsert
and pos
< self
._masklength
:
4071 field
= self
._FindField
(pos
)
4072 start
, end
= field
._extent
4073 slice = self
._GetValue
()[start
:end
]
4074 if field
._insertRight
and field
.IsEmpty(slice):
4076 ## dbg('final pos:', pos, indent=0)
4080 def _findNextTemplateChar(self
, pos
):
4081 """ Find the position of the next non-editable character in the mask."""
4082 while not self
._isTemplateChar
(pos
) and pos
< self
._masklength
:
4087 def _OnAutoCompleteField(self
, event
):
4088 ## dbg('MaskedEditMixin::_OnAutoCompleteField', indent =1)
4089 pos
= self
._GetInsertionPoint
()
4090 field
= self
._FindField
(pos
)
4091 edit_start
, edit_end
, slice = self
._FindFieldExtent
(pos
, getslice
=True)
4094 keycode
= event
.GetKeyCode()
4096 if field
._fillChar
!= ' ':
4097 text
= slice.replace(field
._fillChar
, '')
4101 keep_processing
= True # (assume True to start)
4102 ## dbg('field._hasList?', field._hasList)
4104 ## dbg('choices:', field._choices)
4105 ## dbg('compareChoices:', field._compareChoices)
4106 choices
, choice_required
= field
._compareChoices
, field
._choiceRequired
4107 if keycode
in (wx
.WXK_PRIOR
, wx
.WXK_UP
, wx
.WXK_NUMPAD_PRIOR
, wx
.WXK_NUMPAD_UP
):
4111 match_index
, partial_match
= self
._autoComplete
(direction
, choices
, text
, compareNoCase
=field
._compareNoCase
, current_index
= field
._autoCompleteIndex
)
4112 if( match_index
is None
4113 and (keycode
in self
._autoCompleteKeycodes
+ [wx
.WXK_PRIOR
, wx
.WXK_NEXT
, wx
.WXK_NUMPAD_PRIOR
, wx
.WXK_NUMPAD_NEXT
]
4114 or (keycode
in [wx
.WXK_UP
, wx
.WXK_DOWN
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_DOWN
] and event
.ShiftDown() ) ) ):
4115 # Select the 1st thing from the list:
4118 if( match_index
is not None
4119 and ( keycode
in self
._autoCompleteKeycodes
+ [wx
.WXK_PRIOR
, wx
.WXK_NEXT
, wx
.WXK_NUMPAD_PRIOR
, wx
.WXK_NUMPAD_NEXT
]
4120 or (keycode
in [wx
.WXK_UP
, wx
.WXK_DOWN
, wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_DOWN
] and event
.ShiftDown())
4121 or (keycode
in [wx
.WXK_DOWN
, wx
.WXK_NUMPAD_DOWN
] and partial_match
) ) ):
4123 # We're allowed to auto-complete:
4124 ## dbg('match found')
4125 value
= self
._GetValue
()
4126 newvalue
= value
[:edit_start
] + field
._choices
[match_index
] + value
[edit_end
:]
4127 ## dbg('setting value to "%s"' % newvalue)
4128 self
._SetValue
(newvalue
)
4129 self
._SetInsertionPoint
(min(edit_end
, len(newvalue
.rstrip())))
4130 self
._OnAutoSelect
(field
, match_index
)
4131 self
._CheckValid
() # recolor as appopriate
4134 if keycode
in (wx
.WXK_UP
, wx
.WXK_DOWN
, wx
.WXK_LEFT
, wx
.WXK_RIGHT
,
4135 wx
.WXK_NUMPAD_UP
, wx
.WXK_NUMPAD_DOWN
, wx
.WXK_NUMPAD_LEFT
, wx
.WXK_NUMPAD_RIGHT
):
4136 # treat as left right arrow if unshifted, tab/shift tab if shifted.
4137 if event
.ShiftDown():
4138 if keycode
in (wx
.WXK_DOWN
, wx
.WXK_RIGHT
, wx
.WXK_NUMPAD_DOWN
, wx
.WXK_NUMPAD_RIGHT
):
4139 # remove "shifting" and treat as (forward) tab:
4140 event
.m_shiftDown
= False
4141 keep_processing
= self
._OnChangeField
(event
)
4143 keep_processing
= self
._OnArrow
(event
)
4144 # else some other key; keep processing the key
4146 ## dbg('keep processing?', keep_processing, indent=0)
4147 return keep_processing
4150 def _OnAutoSelect(self
, field
, match_index
= None):
4152 Function called if autoselect feature is enabled and entire control
4155 ## dbg('MaskedEditMixin::OnAutoSelect', field._index)
4156 if match_index
is not None:
4157 field
._autoCompleteIndex
= match_index
4160 def _autoComplete(self
, direction
, choices
, value
, compareNoCase
, current_index
):
4162 This function gets called in response to Auto-complete events.
4163 It attempts to find a match to the specified value against the
4164 list of choices; if exact match, the index of then next
4165 appropriate value in the list, based on the given direction.
4166 If not an exact match, it will return the index of the 1st value from
4167 the choice list for which the partial value can be extended to match.
4168 If no match found, it will return None.
4169 The function returns a 2-tuple, with the 2nd element being a boolean
4170 that indicates if partial match was necessary.
4172 ## dbg('autoComplete(direction=', direction, 'choices=',choices, 'value=',value,'compareNoCase?', compareNoCase, 'current_index:', current_index, indent=1)
4174 ## dbg('nothing to match against', indent=0)
4175 return (None, False)
4177 partial_match
= False
4180 value
= value
.lower()
4182 last_index
= len(choices
) - 1
4183 if value
in choices
:
4184 ## dbg('"%s" in', choices)
4185 if current_index
is not None and choices
[current_index
] == value
:
4186 index
= current_index
4188 index
= choices
.index(value
)
4190 ## dbg('matched "%s" (%d)' % (choices[index], index))
4192 ## dbg('going to previous')
4193 if index
== 0: index
= len(choices
) - 1
4196 if index
== len(choices
) - 1: index
= 0
4198 ## dbg('change value to "%s" (%d)' % (choices[index], index))
4201 partial_match
= True
4202 value
= value
.strip()
4203 ## dbg('no match; try to auto-complete:')
4205 ## dbg('searching for "%s"' % value)
4206 if current_index
is None:
4207 indices
= range(len(choices
))
4212 indices
= range(current_index
+1, len(choices
)) + range(current_index
+1)
4213 ## dbg('range(current_index+1 (%d), len(choices) (%d)) + range(%d):' % (current_index+1, len(choices), current_index+1), indices)
4215 indices
= range(current_index
-1, -1, -1) + range(len(choices
)-1, current_index
-1, -1)
4216 ## dbg('range(current_index-1 (%d), -1) + range(len(choices)-1 (%d)), current_index-1 (%d):' % (current_index-1, len(choices)-1, current_index-1), indices)
4217 #### dbg('indices:', indices)
4218 for index
in indices
:
4219 choice
= choices
[index
]
4220 if choice
.find(value
, 0) == 0:
4221 ## dbg('match found:', choice)
4225 ## dbg('choice: "%s" - no match' % choice)
4227 if match
is not None:
4228 ## dbg('matched', match)
4231 ## dbg('no match found')
4234 return (match
, partial_match
)
4237 def _AdjustField(self
, pos
):
4239 This function gets called by default whenever the cursor leaves a field.
4240 The pos argument given is the char position before leaving that field.
4241 By default, floating point, integer and date values are adjusted to be
4242 legal in this function. Derived classes may override this function
4243 to modify the value of the control in a different way when changing fields.
4245 NOTE: these change the value immediately, and restore the cursor to
4246 the passed location, so that any subsequent code can then move it
4247 based on the operation being performed.
4249 newvalue
= value
= self
._GetValue
()
4250 field
= self
._FindField
(pos
)
4251 start
, end
, slice = self
._FindFieldExtent
(getslice
=True)
4252 newfield
= field
._AdjustField
(slice)
4253 newvalue
= value
[:start
] + newfield
+ value
[end
:]
4255 if self
._isFloat
and newvalue
!= self
._template
:
4256 newvalue
= self
._adjustFloat
(newvalue
)
4258 if self
._ctrl
_constraints
._isInt
and value
!= self
._template
:
4259 newvalue
= self
._adjustInt
(value
)
4261 if self
._isDate
and value
!= self
._template
:
4262 newvalue
= self
._adjustDate
(value
, fixcentury
=True)
4263 if self
._4digityear
:
4264 year2dig
= self
._dateExtent
- 2
4265 if pos
== year2dig
and value
[year2dig
] != newvalue
[year2dig
]:
4268 if newvalue
!= value
:
4269 ## dbg('old value: "%s"\nnew value: "%s"' % (value, newvalue))
4270 self
._SetValue
(newvalue
)
4271 self
._SetInsertionPoint
(pos
)
4274 def _adjustKey(self
, pos
, key
):
4275 """ Apply control formatting to the key (e.g. convert to upper etc). """
4276 field
= self
._FindField
(pos
)
4277 if field
._forceupper
and key
in range(97,123):
4278 key
= ord( chr(key
).upper())
4280 if field
._forcelower
and key
in range(97,123):
4281 key
= ord( chr(key
).lower())
4286 def _adjustPos(self
, pos
, key
):
4288 Checks the current insertion point position and adjusts it if
4289 necessary to skip over non-editable characters.
4291 ## dbg('_adjustPos', pos, key, indent=1)
4292 sel_start
, sel_to
= self
._GetSelection
()
4293 # If a numeric or decimal mask, and negatives allowed, reserve the
4294 # first space for sign, and last one if using parens.
4296 and ((pos
== self
._signpos
and key
in (ord('-'), ord('+'), ord(' ')) )
4297 or (self
._useParens
and pos
== self
._masklength
-1))):
4298 ## dbg('adjusted pos:', pos, indent=0)
4301 if key
not in self
._nav
:
4302 field
= self
._FindField
(pos
)
4304 ## dbg('field._insertRight?', field._insertRight)
4305 ## if self._signOk: dbg('self._signpos:', self._signpos)
4306 if field
._insertRight
: # if allow right-insert
4307 start
, end
= field
._extent
4308 slice = self
._GetValue
()[start
:end
].strip()
4309 field_len
= end
- start
4310 if pos
== end
: # if cursor at right edge of field
4311 # if not filled or supposed to stay in field, keep current position
4312 #### dbg('pos==end')
4313 #### dbg('len (slice):', len(slice))
4314 #### dbg('field_len?', field_len)
4315 #### dbg('pos==end; len (slice) < field_len?', len(slice) < field_len)
4316 #### dbg('not field._moveOnFieldFull?', not field._moveOnFieldFull)
4317 if( len(slice) == field_len
and field
._moveOnFieldFull
4318 and (not field
._stopFieldChangeIfInvalid
or
4319 field
._stopFieldChangeIfInvalid
and field
.IsValid(slice))):
4320 # move cursor to next field:
4321 pos
= self
._findNextEntry
(pos
)
4322 self
._SetInsertionPoint
(pos
)
4324 self
._SetSelection
(pos
, sel_to
) # restore selection
4326 self
._SetSelection
(pos
, pos
) # remove selection
4327 else: # leave cursor alone
4330 # if at start of control, move to right edge
4331 if (sel_to
== sel_start
4332 and (self
._isTemplateChar
(pos
) or (pos
== start
and len(slice)+ 1 < field_len
))
4334 pos
= end
# move to right edge
4335 ## elif sel_start <= start and sel_to == end:
4336 ## # select to right edge of field - 1 (to replace char)
4338 ## self._SetInsertionPoint(pos)
4339 ## # restore selection
4340 ## self._SetSelection(sel_start, pos)
4342 # if selected to beginning and signed, and not changing sign explicitly:
4343 elif self
._signOk
and sel_start
== 0 and key
not in (ord('-'), ord('+'), ord(' ')):
4344 # adjust to past reserved sign position:
4345 pos
= self
._fields
[0]._extent
[0]
4346 ## dbg('adjusting field to ', pos)
4347 self
._SetInsertionPoint
(pos
)
4348 # but keep original selection, to allow replacement of any sign:
4349 self
._SetSelection
(0, sel_to
)
4351 pass # leave position/selection alone
4353 # else make sure the user is not trying to type over a template character
4354 # If they are, move them to the next valid entry position
4355 elif self
._isTemplateChar
(pos
):
4356 if( (not field
._moveOnFieldFull
4357 and (not self
._signOk
4358 or (self
._signOk
and field
._index
== 0 and pos
> 0) ) )
4360 or (field
._stopFieldChangeIfInvalid
4361 and not field
.IsValid(self
._GetValue
()[start
:end
]) ) ):
4363 # don't move to next field without explicit cursor movement
4366 # find next valid position
4367 pos
= self
._findNextEntry
(pos
)
4368 self
._SetInsertionPoint
(pos
)
4369 if pos
< sel_to
: # restore selection
4370 self
._SetSelection
(pos
, sel_to
)
4372 self
._SetSelection
(pos
, pos
)
4373 ## dbg('adjusted pos:', pos, indent=0)
4377 def _adjustFloat(self
, candidate
=None):
4379 'Fixes' an floating point control. Collapses spaces, right-justifies, etc.
4381 ## dbg('MaskedEditMixin::_adjustFloat, candidate = "%s"' % candidate, indent=1)
4382 lenInt
,lenFraction
= [len(s
) for s
in self
._mask
.split('.')] ## Get integer, fraction lengths
4384 if candidate
is None: value
= self
._GetValue
()
4385 else: value
= candidate
4386 ## dbg('value = "%(value)s"' % locals(), 'len(value):', len(value))
4387 intStr
, fracStr
= value
.split(self
._decimalChar
)
4389 intStr
= self
._fields
[0]._AdjustField
(intStr
)
4390 ## dbg('adjusted intStr: "%s"' % intStr)
4391 lenInt
= len(intStr
)
4392 fracStr
= fracStr
+ ('0'*(lenFraction
-len(fracStr
))) # add trailing spaces to decimal
4394 ## dbg('intStr "%(intStr)s"' % locals())
4395 ## dbg('lenInt:', lenInt)
4397 intStr
= string
.rjust( intStr
[-lenInt
:], lenInt
)
4398 ## dbg('right-justifed intStr = "%(intStr)s"' % locals())
4399 newvalue
= intStr
+ self
._decimalChar
+ fracStr
4402 if len(newvalue
) < self
._masklength
:
4403 newvalue
= ' ' + newvalue
4404 signedvalue
= self
._getSignedValue
(newvalue
)[0]
4405 if signedvalue
is not None: newvalue
= signedvalue
4407 # Finally, align string with decimal position, left-padding with
4409 newdecpos
= newvalue
.find(self
._decimalChar
)
4410 if newdecpos
< self
._decimalpos
:
4411 padlen
= self
._decimalpos
- newdecpos
4412 newvalue
= string
.join([' ' * padlen
] + [newvalue
] ,'')
4414 if self
._signOk
and self
._useParens
:
4415 if newvalue
.find('(') != -1:
4416 newvalue
= newvalue
[:-1] + ')'
4418 newvalue
= newvalue
[:-1] + ' '
4420 ## dbg('newvalue = "%s"' % newvalue)
4421 if candidate
is None:
4422 wx
.CallAfter(self
._SetValue
, newvalue
)
4427 def _adjustInt(self
, candidate
=None):
4428 """ 'Fixes' an integer control. Collapses spaces, right or left-justifies."""
4429 ## dbg("MaskedEditMixin::_adjustInt", candidate)
4430 lenInt
= self
._masklength
4431 if candidate
is None: value
= self
._GetValue
()
4432 else: value
= candidate
4434 intStr
= self
._fields
[0]._AdjustField
(value
)
4435 intStr
= intStr
.strip() # drop extra spaces
4436 ## dbg('adjusted field: "%s"' % intStr)
4438 if self
._isNeg
and intStr
.find('-') == -1 and intStr
.find('(') == -1:
4440 intStr
= '(' + intStr
+ ')'
4442 intStr
= '-' + intStr
4443 elif self
._isNeg
and intStr
.find('-') != -1 and self
._useParens
:
4444 intStr
= intStr
.replace('-', '(')
4446 if( self
._signOk
and ((self
._useParens
and intStr
.find('(') == -1)
4447 or (not self
._useParens
and intStr
.find('-') == -1))):
4448 intStr
= ' ' + intStr
4450 intStr
+= ' ' # space for right paren position
4452 elif self
._signOk
and self
._useParens
and intStr
.find('(') != -1 and intStr
.find(')') == -1:
4453 # ensure closing right paren:
4456 if self
._fields
[0]._alignRight
: ## Only if right-alignment is enabled
4457 intStr
= intStr
.rjust( lenInt
)
4459 intStr
= intStr
.ljust( lenInt
)
4461 if candidate
is None:
4462 wx
.CallAfter(self
._SetValue
, intStr
)
4466 def _adjustDate(self
, candidate
=None, fixcentury
=False, force4digit_year
=False):
4468 'Fixes' a date control, expanding the year if it can.
4469 Applies various self-formatting options.
4471 ## dbg("MaskedEditMixin::_adjustDate", indent=1)
4472 if candidate
is None: text
= self
._GetValue
()
4473 else: text
= candidate
4474 ## dbg('text=', text)
4475 if self
._datestyle
== "YMD":
4480 ## dbg('getYear: "%s"' % _getYear(text, self._datestyle))
4481 year
= string
.replace( _getYear( text
, self
._datestyle
),self
._fields
[year_field
]._fillChar
,"") # drop extra fillChars
4482 month
= _getMonth( text
, self
._datestyle
)
4483 day
= _getDay( text
, self
._datestyle
)
4484 ## dbg('self._datestyle:', self._datestyle, 'year:', year, 'Month', month, 'day:', day)
4487 yearstart
= self
._dateExtent
- 4
4491 or (self
._GetInsertionPoint
() > yearstart
+1 and text
[yearstart
+2] == ' ')
4492 or (self
._GetInsertionPoint
() > yearstart
+2 and text
[yearstart
+3] == ' ') ) ):
4493 ## user entered less than four digits and changing fields or past point where we could
4494 ## enter another digit:
4498 ## dbg('bad year=', year)
4499 year
= text
[yearstart
:self
._dateExtent
]
4501 if len(year
) < 4 and yearVal
:
4503 # Fix year adjustment to be less "20th century" :-) and to adjust heuristic as the
4505 now
= wx
.DateTime_Now()
4506 century
= (now
.GetYear() /100) * 100 # "this century"
4507 twodig_year
= now
.GetYear() - century
# "this year" (2 digits)
4508 # if separation between today's 2-digit year and typed value > 50,
4509 # assume last century,
4510 # else assume this century.
4512 # Eg: if 2003 and yearVal == 30, => 2030
4513 # if 2055 and yearVal == 80, => 2080
4514 # if 2010 and yearVal == 96, => 1996
4516 if abs(yearVal
- twodig_year
) > 50:
4517 yearVal
= (century
- 100) + yearVal
4519 yearVal
= century
+ yearVal
4520 year
= str( yearVal
)
4521 else: # pad with 0's to make a 4-digit year
4522 year
= "%04d" % yearVal
4523 if self
._4digityear
or force4digit_year
:
4524 text
= _makeDate(year
, month
, day
, self
._datestyle
, text
) + text
[self
._dateExtent
:]
4525 ## dbg('newdate: "%s"' % text, indent=0)
4529 def _goEnd(self
, getPosOnly
=False):
4530 """ Moves the insertion point to the end of user-entry """
4531 ## dbg("MaskedEditMixin::_goEnd; getPosOnly:", getPosOnly, indent=1)
4532 text
= self
._GetValue
()
4533 #### dbg('text: "%s"' % text)
4535 if len(text
.rstrip()):
4536 for i
in range( min( self
._masklength
-1, len(text
.rstrip())), -1, -1):
4537 #### dbg('i:', i, 'self._isMaskChar(%d)' % i, self._isMaskChar(i))
4538 if self
._isMaskChar
(i
):
4540 #### dbg("text[%d]: '%s'" % (i, char))
4546 pos
= self
._goHome
(getPosOnly
=True)
4548 pos
= min(i
,self
._masklength
)
4550 field
= self
._FindField
(pos
)
4551 start
, end
= field
._extent
4552 if field
._insertRight
and pos
< end
:
4554 ## dbg('next pos:', pos)
4559 self
._SetInsertionPoint
(pos
)
4562 def _goHome(self
, getPosOnly
=False):
4563 """ Moves the insertion point to the beginning of user-entry """
4564 ## dbg("MaskedEditMixin::_goHome; getPosOnly:", getPosOnly, indent=1)
4565 text
= self
._GetValue
()
4566 for i
in range(self
._masklength
):
4567 if self
._isMaskChar
(i
):
4574 self
._SetInsertionPoint
(max(i
,0))
4578 def _getAllowedChars(self
, pos
):
4579 """ Returns a string of all allowed user input characters for the provided
4580 mask character plus control options
4582 maskChar
= self
.maskdict
[pos
]
4583 okchars
= self
.maskchardict
[maskChar
] ## entry, get mask approved characters
4585 # convert okchars to unicode if required; will force subsequent appendings to
4586 # result in unicode strings
4587 if 'unicode' in wx
.PlatformInfo
and type(okchars
) != types
.UnicodeType
:
4588 okchars
= okchars
.decode(self
._defaultEncoding
)
4590 field
= self
._FindField
(pos
)
4591 if okchars
and field
._okSpaces
: ## Allow spaces?
4593 if okchars
and field
._includeChars
: ## any additional included characters?
4594 okchars
+= field
._includeChars
4595 #### dbg('okchars[%d]:' % pos, okchars)
4599 def _isMaskChar(self
, pos
):
4600 """ Returns True if the char at position pos is a special mask character (e.g. NCXaA#)
4602 if pos
< self
._masklength
:
4603 return self
._ismasked
[pos
]
4608 def _isTemplateChar(self
,Pos
):
4609 """ Returns True if the char at position pos is a template character (e.g. -not- NCXaA#)
4611 if Pos
< self
._masklength
:
4612 return not self
._isMaskChar
(Pos
)
4617 def _isCharAllowed(self
, char
, pos
, checkRegex
=False, allowAutoSelect
=True, ignoreInsertRight
=False):
4618 """ Returns True if character is allowed at the specific position, otherwise False."""
4619 ## dbg('_isCharAllowed', char, pos, checkRegex, indent=1)
4620 field
= self
._FindField
(pos
)
4621 right_insert
= False
4623 if self
.controlInitialized
:
4624 sel_start
, sel_to
= self
._GetSelection
()
4626 sel_start
, sel_to
= pos
, pos
4628 if (field
._insertRight
or self
._ctrl
_constraints
._insertRight
) and not ignoreInsertRight
:
4629 start
, end
= field
._extent
4630 field_len
= end
- start
4631 if self
.controlInitialized
:
4632 value
= self
._GetValue
()
4633 fstr
= value
[start
:end
].strip()
4635 while fstr
and fstr
[0] == '0':
4637 input_len
= len(fstr
)
4638 if self
._signOk
and '-' in fstr
or '(' in fstr
:
4639 input_len
-= 1 # sign can move out of field, so don't consider it in length
4641 value
= self
._template
4642 input_len
= 0 # can't get the current "value", so use 0
4645 # if entire field is selected or position is at end and field is not full,
4646 # or if allowed to right-insert at any point in field and field is not full and cursor is not at a fillChar
4647 # or the field is a singleton integer field and is currently 0 and we're at the end:
4648 if( (sel_start
, sel_to
) == field
._extent
4649 or (pos
== end
and ((input_len
< field_len
)
4651 and input_len
== field_len
4653 and value
[end
-1] == '0'
4657 ## dbg('pos = end - 1 = ', pos, 'right_insert? 1')
4659 elif( field
._allowInsert
and sel_start
== sel_to
4660 and (sel_to
== end
or (sel_to
< self
._masklength
and value
[sel_start
] != field
._fillChar
))
4661 and input_len
< field_len
):
4662 pos
= sel_to
- 1 # where character will go
4663 ## dbg('pos = sel_to - 1 = ', pos, 'right_insert? 1')
4665 # else leave pos alone...
4667 ## dbg('pos stays ', pos, 'right_insert? 0')
4670 if self
._isTemplateChar
( pos
): ## if a template character, return empty
4671 ## dbg('%d is a template character; returning False' % pos, indent=0)
4674 if self
._isMaskChar
( pos
):
4675 okChars
= self
._getAllowedChars
(pos
)
4677 if self
._fields
[0]._groupdigits
and (self
._isInt
or (self
._isFloat
and pos
< self
._decimalpos
)):
4678 okChars
+= self
._fields
[0]._groupChar
4681 if self
._isInt
or (self
._isFloat
and pos
< self
._decimalpos
):
4685 elif self
._useParens
and (self
._isInt
or (self
._isFloat
and pos
> self
._decimalpos
)):
4688 #### dbg('%s in %s?' % (char, okChars), char in okChars)
4689 approved
= (self
.maskdict
[pos
] == '*' or char
in okChars
)
4691 if approved
and checkRegex
:
4692 ## dbg("checking appropriate regex's")
4693 value
= self
._eraseSelection
(self
._GetValue
())
4695 # move the position to the right side of the insertion:
4700 newvalue
, ignore
, ignore
, ignore
, ignore
= self
._insertKey
(char
, at
, sel_start
, sel_to
, value
, allowAutoSelect
=True)
4702 newvalue
, ignore
= self
._insertKey
(char
, at
, sel_start
, sel_to
, value
)
4703 ## dbg('newvalue: "%s"' % newvalue)
4705 fields
= [self
._FindField
(pos
)] + [self
._ctrl
_constraints
]
4706 for field
in fields
: # includes fields[-1] == "ctrl_constraints"
4707 if field
._regexMask
and field
._filter
:
4708 ## dbg('checking vs. regex')
4709 start
, end
= field
._extent
4710 slice = newvalue
[start
:end
]
4711 approved
= (re
.match( field
._filter
, slice) is not None)
4712 ## dbg('approved?', approved)
4713 if not approved
: break
4717 ## dbg('%d is a !???! character; returning False', indent=0)
4721 def _applyFormatting(self
):
4722 """ Apply formatting depending on the control's state.
4723 Need to find a way to call this whenever the value changes, in case the control's
4724 value has been changed or set programatically.
4727 ## dbg('MaskedEditMixin::_applyFormatting', indent=1)
4729 # Handle negative numbers
4731 text
, signpos
, right_signpos
= self
._getSignedValue
()
4732 ## dbg('text: "%s", signpos:' % text, signpos)
4733 if text
and signpos
!= self
._signpos
:
4734 self
._signpos
= signpos
4735 if not text
or text
[signpos
] not in ('-','('):
4737 ## dbg('no valid sign found; new sign:', self._isNeg)
4738 elif text
and self
._valid
and not self
._isNeg
and text
[signpos
] in ('-', '('):
4739 ## dbg('setting _isNeg to True')
4741 ## dbg('self._isNeg:', self._isNeg)
4743 if self
._signOk
and self
._isNeg
:
4744 fc
= self
._signedForegroundColour
4746 fc
= self
._foregroundColour
4748 if hasattr(fc
, '_name'):
4752 ## dbg('setting foreground to', c)
4753 self
.SetForegroundColour(fc
)
4758 bc
= self
._emptyBackgroundColour
4760 bc
= self
._validBackgroundColour
4763 bc
= self
._invalidBackgroundColour
4764 if hasattr(bc
, '_name'):
4768 ## dbg('setting background to', c)
4769 self
.SetBackgroundColour(bc
)
4771 ## dbg(indent=0, suspend=0)
4774 def _getAbsValue(self
, candidate
=None):
4775 """ Return an unsigned value (i.e. strip the '-' prefix if any), and sign position(s).
4777 ## dbg('MaskedEditMixin::_getAbsValue; candidate="%s"' % candidate, indent=1)
4778 if candidate
is None: text
= self
._GetValue
()
4779 else: text
= candidate
4780 right_signpos
= text
.find(')')
4783 if self
._ctrl
_constraints
._alignRight
and self
._fields
[0]._fillChar
== ' ':
4784 signpos
= text
.find('-')
4786 ## dbg('no - found; searching for (')
4787 signpos
= text
.find('(')
4789 ## dbg('- found at', signpos)
4793 ## dbg('signpos still -1')
4794 ## dbg('len(%s) (%d) < len(%s) (%d)?' % (text, len(text), self._mask, self._masklength), len(text) < self._masklength)
4795 if len(text
) < self
._masklength
:
4797 if len(text
) < self
._masklength
:
4799 if len(text
) > self
._masklength
and text
[-1] in (')', ' '):
4802 ## dbg('len(%s) (%d), len(%s) (%d)' % (text, len(text), self._mask, self._masklength))
4803 ## dbg('len(%s) - (len(%s) + 1):' % (text, text.lstrip()) , len(text) - (len(text.lstrip()) + 1))
4804 signpos
= len(text
) - (len(text
.lstrip()) + 1)
4806 if self
._useParens
and not text
.strip():
4807 signpos
-= 1 # empty value; use penultimate space
4808 ## dbg('signpos:', signpos)
4810 text
= text
[:signpos
] + ' ' + text
[signpos
+1:]
4815 text
= self
._template
[0] + text
[1:]
4819 if right_signpos
!= -1:
4821 text
= text
[:right_signpos
] + ' ' + text
[right_signpos
+1:]
4822 elif len(text
) > self
._masklength
:
4823 text
= text
[:right_signpos
] + text
[right_signpos
+1:]
4827 elif self
._useParens
and self
._signOk
:
4828 # figure out where it ought to go:
4829 right_signpos
= self
._masklength
- 1 # initial guess
4830 if not self
._ctrl
_constraints
._alignRight
:
4831 ## dbg('not right-aligned')
4832 if len(text
.strip()) == 0:
4833 right_signpos
= signpos
+ 1
4834 elif len(text
.strip()) < self
._masklength
:
4835 right_signpos
= len(text
.rstrip())
4836 ## dbg('right_signpos:', right_signpos)
4838 groupchar
= self
._fields
[0]._groupChar
4840 value
= long(text
.replace(groupchar
,'').replace('(','-').replace(')','').replace(' ', ''))
4842 ## dbg('invalid number', indent=0)
4843 return None, signpos
, right_signpos
4847 groupchar
= self
._fields
[0]._groupChar
4848 value
= float(text
.replace(groupchar
,'').replace(self
._decimalChar
, '.').replace('(', '-').replace(')','').replace(' ', ''))
4849 ## dbg('value:', value)
4853 if value
< 0 and value
is not None:
4854 signpos
= text
.find('-')
4856 signpos
= text
.find('(')
4858 text
= text
[:signpos
] + self
._template
[signpos
] + text
[signpos
+1:]
4860 # look forwards up to the decimal point for the 1st non-digit
4861 ## dbg('decimal pos:', self._decimalpos)
4862 ## dbg('text: "%s"' % text)
4864 signpos
= self
._decimalpos
- (len(text
[:self
._decimalpos
].lstrip()) + 1)
4865 # prevent checking for empty string - Tomo - Wed 14 Jan 2004 03:19:09 PM CET
4866 if len(text
) >= signpos
+1 and text
[signpos
+1] in ('-','('):
4870 ## dbg('signpos:', signpos)
4874 right_signpos
= self
._masklength
- 1
4875 text
= text
[:right_signpos
] + ' '
4876 if text
[signpos
] == '(':
4877 text
= text
[:signpos
] + ' ' + text
[signpos
+1:]
4879 right_signpos
= text
.find(')')
4880 if right_signpos
!= -1:
4885 ## dbg('invalid number')
4888 ## dbg('abstext = "%s"' % text, 'signpos:', signpos, 'right_signpos:', right_signpos)
4890 return text
, signpos
, right_signpos
4893 def _getSignedValue(self
, candidate
=None):
4894 """ Return a signed value by adding a "-" prefix if the value
4895 is set to negative, or a space if positive.
4897 ## dbg('MaskedEditMixin::_getSignedValue; candidate="%s"' % candidate, indent=1)
4898 if candidate
is None: text
= self
._GetValue
()
4899 else: text
= candidate
4902 abstext
, signpos
, right_signpos
= self
._getAbsValue
(text
)
4906 return abstext
, signpos
, right_signpos
4908 if self
._isNeg
or text
[signpos
] in ('-', '('):
4915 if abstext
[signpos
] not in string
.digits
:
4916 text
= abstext
[:signpos
] + sign
+ abstext
[signpos
+1:]
4918 # this can happen if value passed is too big; sign assumed to be
4919 # in position 0, but if already filled with a digit, prepend sign...
4920 text
= sign
+ abstext
4921 if self
._useParens
and text
.find('(') != -1:
4922 text
= text
[:right_signpos
] + ')' + text
[right_signpos
+1:]
4925 ## dbg('signedtext = "%s"' % text, 'signpos:', signpos, 'right_signpos', right_signpos)
4927 return text
, signpos
, right_signpos
4930 def GetPlainValue(self
, candidate
=None):
4931 """ Returns control's value stripped of the template text.
4932 plainvalue = MaskedEditMixin.GetPlainValue()
4934 ## dbg('MaskedEditMixin::GetPlainValue; candidate="%s"' % candidate, indent=1)
4936 if candidate
is None: text
= self
._GetValue
()
4937 else: text
= candidate
4940 ## dbg('returned ""', indent=0)
4944 for idx
in range( min(len(self
._template
), len(text
)) ):
4945 if self
._mask
[idx
] in maskchars
:
4948 if self
._isFloat
or self
._isInt
:
4949 ## dbg('plain so far: "%s"' % plain)
4950 plain
= plain
.replace('(', '-').replace(')', ' ')
4951 ## dbg('plain after sign regularization: "%s"' % plain)
4953 if self
._signOk
and self
._isNeg
and plain
.count('-') == 0:
4954 # must be in reserved position; add to "plain value"
4955 plain
= '-' + plain
.strip()
4957 if self
._fields
[0]._alignRight
:
4958 lpad
= plain
.count(',')
4959 plain
= ' ' * lpad
+ plain
.replace(',','')
4961 plain
= plain
.replace(',','')
4962 ## dbg('plain after pad and group:"%s"' % plain)
4964 ## dbg('returned "%s"' % plain.rstrip(), indent=0)
4965 return plain
.rstrip()
4968 def IsEmpty(self
, value
=None):
4970 Returns True if control is equal to an empty value.
4971 (Empty means all editable positions in the template == fillChar.)
4973 if value
is None: value
= self
._GetValue
()
4974 if value
== self
._template
and not self
._defaultValue
:
4975 #### dbg("IsEmpty? 1 (value == self._template and not self._defaultValue)")
4976 return True # (all mask chars == fillChar by defn)
4977 elif value
== self
._template
:
4979 for pos
in range(len(self
._template
)):
4980 #### dbg('isMaskChar(%(pos)d)?' % locals(), self._isMaskChar(pos))
4981 #### dbg('value[%(pos)d] != self._fillChar?' %locals(), value[pos] != self._fillChar[pos])
4982 if self
._isMaskChar
(pos
) and value
[pos
] not in (' ', self
._fillChar
[pos
]):
4984 #### dbg("IsEmpty? %(empty)d (do all mask chars == fillChar?)" % locals())
4987 #### dbg("IsEmpty? 0 (value doesn't match template)")
4991 def IsDefault(self
, value
=None):
4993 Returns True if the value specified (or the value of the control if not specified)
4994 is equal to the default value.
4996 if value
is None: value
= self
._GetValue
()
4997 return value
== self
._template
5000 def IsValid(self
, value
=None):
5001 """ Indicates whether the value specified (or the current value of the control
5002 if not specified) is considered valid."""
5003 #### dbg('MaskedEditMixin::IsValid("%s")' % value, indent=1)
5004 if value
is None: value
= self
._GetValue
()
5005 ret
= self
._CheckValid
(value
)
5010 def _eraseSelection(self
, value
=None, sel_start
=None, sel_to
=None):
5011 """ Used to blank the selection when inserting a new character. """
5012 ## dbg("MaskedEditMixin::_eraseSelection", indent=1)
5013 if value
is None: value
= self
._GetValue
()
5014 if sel_start
is None or sel_to
is None:
5015 sel_start
, sel_to
= self
._GetSelection
() ## check for a range of selected text
5016 ## dbg('value: "%s"' % value)
5017 ## dbg("current sel_start, sel_to:", sel_start, sel_to)
5019 newvalue
= list(value
)
5020 for i
in range(sel_start
, sel_to
):
5021 if self
._signOk
and newvalue
[i
] in ('-', '(', ')'):
5022 ## dbg('found sign (%s) at' % newvalue[i], i)
5024 # balance parentheses:
5025 if newvalue
[i
] == '(':
5026 right_signpos
= value
.find(')')
5027 if right_signpos
!= -1:
5028 newvalue
[right_signpos
] = ' '
5030 elif newvalue
[i
] == ')':
5031 left_signpos
= value
.find('(')
5032 if left_signpos
!= -1:
5033 newvalue
[left_signpos
] = ' '
5037 elif self
._isMaskChar
(i
):
5038 field
= self
._FindField
(i
)
5042 newvalue
[i
] = self
._template
[i
]
5044 value
= string
.join(newvalue
,"")
5045 ## dbg('new value: "%s"' % value)
5050 def _insertKey(self
, char
, pos
, sel_start
, sel_to
, value
, allowAutoSelect
=False):
5051 """ Handles replacement of the character at the current insertion point."""
5052 ## dbg('MaskedEditMixin::_insertKey', "\'" + char + "\'", pos, sel_start, sel_to, '"%s"' % value, indent=1)
5054 text
= self
._eraseSelection
(value
)
5055 field
= self
._FindField
(pos
)
5056 start
, end
= field
._extent
5060 # if >= 2 chars selected in a right-insert field, do appropriate erase on field,
5061 # then set selection to end, and do usual right insert.
5062 if sel_start
!= sel_to
and sel_to
>= sel_start
+2:
5063 field
= self
._FindField
(sel_start
)
5064 if( field
._insertRight
# if right-insert
5065 and field
._allowInsert
# and allow insert at any point in field
5066 and field
== self
._FindField
(sel_to
) ): # and selection all in same field
5067 text
= self
._OnErase
(just_return_value
=True) # remove selection before insert
5068 ## dbg('text after (left)erase: "%s"' % text)
5069 pos
= sel_start
= sel_to
5071 if pos
!= sel_start
and sel_start
== sel_to
:
5072 # adjustpos must have moved the position; make selection match:
5073 sel_start
= sel_to
= pos
5075 ## dbg('field._insertRight?', field._insertRight)
5076 ## dbg('field._allowInsert?', field._allowInsert)
5077 ## dbg('sel_start, end', sel_start, end)
5079 ## dbg('text[sel_start] != field._fillChar?', text[sel_start] != field._fillChar)
5082 if( field
._insertRight
# field allows right insert
5083 and ((sel_start
, sel_to
) == field
._extent
# and whole field selected
5084 or (sel_start
== sel_to
# or nothing selected
5085 and (sel_start
== end
# and cursor at right edge
5086 or (field
._allowInsert
# or field allows right-insert
5087 and sel_start
< end
# next to other char in field:
5088 and text
[sel_start
] != field
._fillChar
) ) ) ) ):
5089 ## dbg('insertRight')
5090 fstr
= text
[start
:end
]
5091 erasable_chars
= [field
._fillChar
, ' ']
5093 # if zero padding field, or a single digit, and currently a value of 0, allow erasure of 0:
5094 if field
._padZero
or (field
._isInt
and (end
- start
== 1) and fstr
[0] == '0'):
5095 erasable_chars
.append('0')
5098 #### dbg("fstr[0]:'%s'" % fstr[0])
5099 #### dbg('field_index:', field._index)
5100 #### dbg("fstr[0] in erasable_chars?", fstr[0] in erasable_chars)
5101 #### dbg("self._signOk and field._index == 0 and fstr[0] in ('-','(')?", self._signOk and field._index == 0 and fstr[0] in ('-','('))
5102 if fstr
[0] in erasable_chars
or (self
._signOk
and field
._index
== 0 and fstr
[0] in ('-','(')):
5104 #### dbg('value: "%s"' % text)
5105 #### dbg('fstr: "%s"' % fstr)
5106 #### dbg("erased: '%s'" % erased)
5107 field_sel_start
= sel_start
- start
5108 field_sel_to
= sel_to
- start
5109 ## dbg('left fstr: "%s"' % fstr[1:field_sel_start])
5110 ## dbg('right fstr: "%s"' % fstr[field_sel_to:end])
5111 fstr
= fstr
[1:field_sel_start
] + char
+ fstr
[field_sel_to
:end
]
5112 if field
._alignRight
and sel_start
!= sel_to
:
5113 field_len
= end
- start
5114 ## pos += (field_len - len(fstr)) # move cursor right by deleted amount
5116 ## dbg('setting pos to:', pos)
5118 fstr
= '0' * (field_len
- len(fstr
)) + fstr
5120 fstr
= fstr
.rjust(field_len
) # adjust the field accordingly
5121 ## dbg('field str: "%s"' % fstr)
5123 newtext
= text
[:start
] + fstr
+ text
[end
:]
5124 if erased
in ('-', '(') and self
._signOk
:
5125 newtext
= erased
+ newtext
[1:]
5126 ## dbg('newtext: "%s"' % newtext)
5128 if self
._signOk
and field
._index
== 0:
5129 start
-= 1 # account for sign position
5131 #### dbg('field._moveOnFieldFull?', field._moveOnFieldFull)
5132 #### dbg('len(fstr.lstrip()) == end-start?', len(fstr.lstrip()) == end-start)
5133 if( field
._moveOnFieldFull
and pos
== end
5134 and len(fstr
.lstrip()) == end
-start
# if field now full
5135 and (not field
._stopFieldChangeIfInvalid
# and we either don't care about valid
5136 or (field
._stopFieldChangeIfInvalid
# or we do and the current field value is valid
5137 and field
.IsValid(fstr
)))):
5139 newpos
= self
._findNextEntry
(end
) # go to next field
5141 newpos
= pos
# else keep cursor at current position
5144 ## dbg('not newtext')
5146 ## dbg('newpos:', newpos)
5148 if self
._signOk
and self
._useParens
:
5149 old_right_signpos
= text
.find(')')
5151 if field
._allowInsert
and not field
._insertRight
and sel_to
<= end
and sel_start
>= start
:
5152 ## dbg('inserting within a left-insert-capable field')
5153 field_len
= end
- start
5154 before
= text
[start
:sel_start
]
5155 after
= text
[sel_to
:end
].strip()
5156 #### dbg("current field:'%s'" % text[start:end])
5157 #### dbg("before:'%s'" % before, "after:'%s'" % after)
5158 new_len
= len(before
) + len(after
) + 1 # (for inserted char)
5159 #### dbg('new_len:', new_len)
5161 if new_len
< field_len
:
5162 retained
= after
+ self
._template
[end
-(field_len
-new_len
):end
]
5163 elif new_len
> end
-start
:
5164 retained
= after
[1:]
5168 left
= text
[0:start
] + before
5169 #### dbg("left:'%s'" % left, "retained:'%s'" % retained)
5170 right
= retained
+ text
[end
:]
5173 right
= text
[pos
+1:]
5175 if 'unicode' in wx
.PlatformInfo
and type(char
) != types
.UnicodeType
:
5176 # convert the keyboard constant to a unicode value, to
5177 # ensure it can be concatenated into the control value:
5178 char
= char
.decode(self
._defaultEncoding
)
5180 newtext
= left
+ char
+ right
5181 #### dbg('left: "%s"' % left)
5182 #### dbg('right: "%s"' % right)
5183 #### dbg('newtext: "%s"' % newtext)
5185 if self
._signOk
and self
._useParens
:
5186 # Balance parentheses:
5187 left_signpos
= newtext
.find('(')
5189 if left_signpos
== -1: # erased '('; remove ')'
5190 right_signpos
= newtext
.find(')')
5191 if right_signpos
!= -1:
5192 newtext
= newtext
[:right_signpos
] + ' ' + newtext
[right_signpos
+1:]
5194 elif old_right_signpos
!= -1:
5195 right_signpos
= newtext
.find(')')
5197 if right_signpos
== -1: # just replaced right-paren
5198 if newtext
[pos
] == ' ': # we just erased '); erase '('
5199 newtext
= newtext
[:left_signpos
] + ' ' + newtext
[left_signpos
+1:]
5200 else: # replaced with digit; move ') over
5201 if self
._ctrl
_constraints
._alignRight
or self
._isFloat
:
5202 newtext
= newtext
[:-1] + ')'
5204 rstripped_text
= newtext
.rstrip()
5205 right_signpos
= len(rstripped_text
)
5206 ## dbg('old_right_signpos:', old_right_signpos, 'right signpos now:', right_signpos)
5207 newtext
= newtext
[:right_signpos
] + ')' + newtext
[right_signpos
+1:]
5209 if( field
._insertRight
# if insert-right field (but we didn't start at right edge)
5210 and field
._moveOnFieldFull
# and should move cursor when full
5211 and len(newtext
[start
:end
].strip()) == end
-start
# and field now full
5212 and (not field
._stopFieldChangeIfInvalid
# and we either don't care about valid
5213 or (field
._stopFieldChangeIfInvalid
# or we do and the current field value is valid
5214 and field
.IsValid(newtext
[start
:end
].strip())))):
5216 newpos
= self
._findNextEntry
(end
) # go to next field
5217 ## dbg('newpos = nextentry =', newpos)
5219 ## dbg('pos:', pos, 'newpos:', pos+1)
5224 new_select_to
= newpos
# (default return values)
5228 if field
._autoSelect
:
5229 match_index
, partial_match
= self
._autoComplete
(1, # (always forward)
5230 field
._compareChoices
,
5232 compareNoCase
=field
._compareNoCase
,
5233 current_index
= field
._autoCompleteIndex
-1)
5234 if match_index
is not None and partial_match
:
5235 matched_str
= newtext
[start
:end
]
5236 newtext
= newtext
[:start
] + field
._choices
[match_index
] + newtext
[end
:]
5239 if field
._insertRight
:
5240 # adjust position to just after partial match in field
5241 newpos
= end
- (len(field
._choices
[match_index
].strip()) - len(matched_str
.strip()))
5243 elif self
._ctrl
_constraints
._autoSelect
:
5244 match_index
, partial_match
= self
._autoComplete
(
5245 1, # (always forward)
5246 self
._ctrl
_constraints
._compareChoices
,
5248 self
._ctrl
_constraints
._compareNoCase
,
5249 current_index
= self
._ctrl
_constraints
._autoCompleteIndex
- 1)
5250 if match_index
is not None and partial_match
:
5251 matched_str
= newtext
5252 newtext
= self
._ctrl
_constraints
._choices
[match_index
]
5253 edit_end
= self
._ctrl
_constraints
._extent
[1]
5254 new_select_to
= min(edit_end
, len(newtext
.rstrip()))
5255 match_field
= self
._ctrl
_constraints
5256 if self
._ctrl
_constraints
._insertRight
:
5257 # adjust position to just after partial match in control:
5258 newpos
= self
._masklength
- (len(self
._ctrl
_constraints
._choices
[match_index
].strip()) - len(matched_str
.strip()))
5260 ## dbg('newtext: "%s"' % newtext, 'newpos:', newpos, 'new_select_to:', new_select_to)
5262 return newtext
, newpos
, new_select_to
, match_field
, match_index
5264 ## dbg('newtext: "%s"' % newtext, 'newpos:', newpos)
5266 return newtext
, newpos
5269 def _OnFocus(self
,event
):
5271 This event handler is currently necessary to work around new default
5272 behavior as of wxPython2.3.3;
5273 The TAB key auto selects the entire contents of the wx.TextCtrl *after*
5274 the EVT_SET_FOCUS event occurs; therefore we can't query/adjust the selection
5275 *here*, because it hasn't happened yet. So to prevent this behavior, and
5276 preserve the correct selection when the focus event is not due to tab,
5277 we need to pull the following trick:
5279 ## dbg('MaskedEditMixin::_OnFocus')
5280 if self
.IsBeingDeleted() or self
.GetParent().IsBeingDeleted():
5282 wx
.CallAfter(self
._fixSelection
)
5287 def _CheckValid(self
, candidate
=None):
5289 This is the default validation checking routine; It verifies that the
5290 current value of the control is a "valid value," and has the side
5291 effect of coloring the control appropriately.
5294 ## dbg('MaskedEditMixin::_CheckValid: candidate="%s"' % candidate, indent=1)
5295 oldValid
= self
._valid
5296 if candidate
is None: value
= self
._GetValue
()
5297 else: value
= candidate
5298 ## dbg('value: "%s"' % value)
5300 valid
= True # assume True
5302 if not self
.IsDefault(value
) and self
._isDate
: ## Date type validation
5303 valid
= self
._validateDate
(value
)
5304 ## dbg("valid date?", valid)
5306 elif not self
.IsDefault(value
) and self
._isTime
:
5307 valid
= self
._validateTime
(value
)
5308 ## dbg("valid time?", valid)
5310 elif not self
.IsDefault(value
) and (self
._isInt
or self
._isFloat
): ## Numeric type
5311 valid
= self
._validateNumeric
(value
)
5312 ## dbg("valid Number?", valid)
5314 if valid
: # and not self.IsDefault(value): ## generic validation accounts for IsDefault()
5315 ## valid so far; ensure also allowed by any list or regex provided:
5316 valid
= self
._validateGeneric
(value
)
5317 ## dbg("valid value?", valid)
5319 ## dbg('valid?', valid)
5323 self
._applyFormatting
()
5324 if self
._valid
!= oldValid
:
5325 ## dbg('validity changed: oldValid =',oldValid,'newvalid =', self._valid)
5326 ## dbg('oldvalue: "%s"' % oldvalue, 'newvalue: "%s"' % self._GetValue())
5328 ## dbg(indent=0, suspend=0)
5332 def _validateGeneric(self
, candidate
=None):
5333 """ Validate the current value using the provided list or Regex filter (if any).
5335 if candidate
is None:
5336 text
= self
._GetValue
()
5340 valid
= True # assume True
5341 for i
in [-1] + self
._field
_indices
: # process global constraints first:
5342 field
= self
._fields
[i
]
5343 start
, end
= field
._extent
5344 slice = text
[start
:end
]
5345 valid
= field
.IsValid(slice)
5352 def _validateNumeric(self
, candidate
=None):
5353 """ Validate that the value is within the specified range (if specified.)"""
5354 if candidate
is None: value
= self
._GetValue
()
5355 else: value
= candidate
5357 groupchar
= self
._fields
[0]._groupChar
5359 number
= float(value
.replace(groupchar
, '').replace(self
._decimalChar
, '.').replace('(', '-').replace(')', ''))
5361 number
= long( value
.replace(groupchar
, '').replace('(', '-').replace(')', ''))
5363 if self
._fields
[0]._alignRight
:
5364 require_digit_at
= self
._fields
[0]._extent
[1]-1
5366 require_digit_at
= self
._fields
[0]._extent
[0]
5367 ## dbg('require_digit_at:', require_digit_at)
5368 ## dbg("value[rda]: '%s'" % value[require_digit_at])
5369 if value
[require_digit_at
] not in list(string
.digits
):
5373 ## dbg('number:', number)
5374 if self
._ctrl
_constraints
._hasRange
:
5375 valid
= self
._ctrl
_constraints
._rangeLow
<= number
<= self
._ctrl
_constraints
._rangeHigh
5378 groupcharpos
= value
.rfind(groupchar
)
5379 if groupcharpos
!= -1: # group char present
5380 ## dbg('groupchar found at', groupcharpos)
5381 if self
._isFloat
and groupcharpos
> self
._decimalpos
:
5382 # 1st one found on right-hand side is past decimal point
5383 ## dbg('groupchar in fraction; illegal')
5386 integer
= value
[:self
._decimalpos
].strip()
5388 integer
= value
.strip()
5389 ## dbg("integer:'%s'" % integer)
5390 if integer
[0] in ('-', '('):
5391 integer
= integer
[1:]
5392 if integer
[-1] == ')':
5393 integer
= integer
[:-1]
5395 parts
= integer
.split(groupchar
)
5396 ## dbg('parts:', parts)
5397 for i
in range(len(parts
)):
5398 if i
== 0 and abs(int(parts
[0])) > 999:
5399 ## dbg('group 0 too long; illegal')
5402 elif i
> 0 and (len(parts
[i
]) != 3 or ' ' in parts
[i
]):
5403 ## dbg('group %i (%s) not right size; illegal' % (i, parts[i]))
5407 ## dbg('value not a valid number')
5412 def _validateDate(self
, candidate
=None):
5413 """ Validate the current date value using the provided Regex filter.
5414 Generally used for character types.BufferType
5416 ## dbg('MaskedEditMixin::_validateDate', indent=1)
5417 if candidate
is None: value
= self
._GetValue
()
5418 else: value
= candidate
5419 ## dbg('value = "%s"' % value)
5420 text
= self
._adjustDate
(value
, force4digit_year
=True) ## Fix the date up before validating it
5421 ## dbg('text =', text)
5422 valid
= True # assume True until proven otherwise
5425 # replace fillChar in each field with space:
5426 datestr
= text
[0:self
._dateExtent
]
5428 field
= self
._fields
[i
]
5429 start
, end
= field
._extent
5430 fstr
= datestr
[start
:end
]
5431 fstr
.replace(field
._fillChar
, ' ')
5432 datestr
= datestr
[:start
] + fstr
+ datestr
[end
:]
5434 year
, month
, day
= _getDateParts( datestr
, self
._datestyle
)
5436 ## dbg('self._dateExtent:', self._dateExtent)
5437 if self
._dateExtent
== 11:
5438 month
= charmonths_dict
[month
.lower()]
5442 ## dbg('year, month, day:', year, month, day)
5445 ## dbg('cannot convert string to integer parts')
5448 ## dbg('cannot convert string to integer month')
5452 # use wxDateTime to unambiguously try to parse the date:
5453 # ### Note: because wxDateTime is *brain-dead* and expects months 0-11,
5454 # rather than 1-12, so handle accordingly:
5460 ## dbg("trying to create date from values day=%d, month=%d, year=%d" % (day,month,year))
5461 dateHandler
= wx
.DateTimeFromDMY(day
,month
,year
)
5465 ## dbg('cannot convert string to valid date')
5471 # wxDateTime doesn't take kindly to leading/trailing spaces when parsing,
5472 # so we eliminate them here:
5473 timeStr
= text
[self
._dateExtent
+1:].strip() ## time portion of the string
5475 ## dbg('timeStr: "%s"' % timeStr)
5477 checkTime
= dateHandler
.ParseTime(timeStr
)
5478 valid
= checkTime
== len(timeStr
)
5482 ## dbg('cannot convert string to valid time')
5484 ## if valid: dbg('valid date')
5489 def _validateTime(self
, candidate
=None):
5490 """ Validate the current time value using the provided Regex filter.
5491 Generally used for character types.BufferType
5493 ## dbg('MaskedEditMixin::_validateTime', indent=1)
5494 # wxDateTime doesn't take kindly to leading/trailing spaces when parsing,
5495 # so we eliminate them here:
5496 if candidate
is None: value
= self
._GetValue
().strip()
5497 else: value
= candidate
.strip()
5498 ## dbg('value = "%s"' % value)
5499 valid
= True # assume True until proven otherwise
5501 dateHandler
= wx
.DateTime_Today()
5503 checkTime
= dateHandler
.ParseTime(value
)
5504 ## dbg('checkTime:', checkTime, 'len(value)', len(value))
5505 valid
= checkTime
== len(value
)
5510 ## dbg('cannot convert string to valid time')
5512 ## if valid: dbg('valid time')
5517 def _OnKillFocus(self
,event
):
5518 """ Handler for EVT_KILL_FOCUS event.
5520 ## dbg('MaskedEditMixin::_OnKillFocus', 'isDate=',self._isDate, indent=1)
5521 if self
.IsBeingDeleted() or self
.GetParent().IsBeingDeleted():
5523 if self
._mask
and self
._IsEditable
():
5524 self
._AdjustField
(self
._GetInsertionPoint
())
5525 self
._CheckValid
() ## Call valid handler
5527 self
._LostFocus
() ## Provided for subclass use
5532 def _fixSelection(self
):
5534 This gets called after the TAB traversal selection is made, if the
5535 focus event was due to this, but before the EVT_LEFT_* events if
5536 the focus shift was due to a mouse event.
5538 The trouble is that, a priori, there's no explicit notification of
5539 why the focus event we received. However, the whole reason we need to
5540 do this is because the default behavior on TAB traveral in a wx.TextCtrl is
5541 now to select the entire contents of the window, something we don't want.
5542 So we can *now* test the selection range, and if it's "the whole text"
5543 we can assume the cause, change the insertion point to the start of
5544 the control, and deselect.
5546 ## dbg('MaskedEditMixin::_fixSelection', indent=1)
5547 # can get here if called with wx.CallAfter after underlying
5548 # control has been destroyed on close, but after focus
5550 if not self
or not self
._mask
or not self
._IsEditable
():
5554 sel_start
, sel_to
= self
._GetSelection
()
5555 ## dbg('sel_start, sel_to:', sel_start, sel_to, 'self.IsEmpty()?', self.IsEmpty())
5557 if( sel_start
== 0 and sel_to
>= len( self
._mask
) #(can be greater in numeric controls because of reserved space)
5558 and (not self
._ctrl
_constraints
._autoSelect
or self
.IsEmpty() or self
.IsDefault() ) ):
5559 # This isn't normally allowed, and so assume we got here by the new
5560 # "tab traversal" behavior, so we need to reset the selection
5561 # and insertion point:
5562 ## dbg('entire text selected; resetting selection to start of control')
5564 field
= self
._FindField
(self
._GetInsertionPoint
())
5565 edit_start
, edit_end
= field
._extent
5566 if field
._selectOnFieldEntry
:
5567 if self
._isFloat
or self
._isInt
and field
== self
._fields
[0]:
5569 self
._SetInsertionPoint
(edit_start
)
5570 self
._SetSelection
(edit_start
, edit_end
)
5572 elif field
._insertRight
:
5573 self
._SetInsertionPoint
(edit_end
)
5574 self
._SetSelection
(edit_end
, edit_end
)
5576 elif (self
._isFloat
or self
._isInt
):
5578 text
, signpos
, right_signpos
= self
._getAbsValue
()
5579 if text
is None or text
== self
._template
:
5580 integer
= self
._fields
[0]
5581 edit_start
, edit_end
= integer
._extent
5583 if integer
._selectOnFieldEntry
:
5584 ## dbg('select on field entry:')
5585 self
._SetInsertionPoint
(0)
5586 self
._SetSelection
(0, edit_end
)
5588 elif integer
._insertRight
:
5589 ## dbg('moving insertion point to end')
5590 self
._SetInsertionPoint
(edit_end
)
5591 self
._SetSelection
(edit_end
, edit_end
)
5593 ## dbg('numeric ctrl is empty; start at beginning after sign')
5594 self
._SetInsertionPoint
(signpos
+1) ## Move past minus sign space if signed
5595 self
._SetSelection
(signpos
+1, signpos
+1)
5597 elif sel_start
> self
._goEnd
(getPosOnly
=True):
5598 ## dbg('cursor beyond the end of the user input; go to end of it')
5601 ## dbg('sel_start, sel_to:', sel_start, sel_to, 'self._masklength:', self._masklength)
5606 def _Keypress(self
,key
):
5607 """ Method provided to override OnChar routine. Return False to force
5608 a skip of the 'normal' OnChar process. Called before class OnChar.
5613 def _LostFocus(self
):
5614 """ Method provided for subclasses. _LostFocus() is called after
5615 the class processes its EVT_KILL_FOCUS event code.
5620 def _OnDoubleClick(self
, event
):
5621 """ selects field under cursor on dclick."""
5622 pos
= self
._GetInsertionPoint
()
5623 field
= self
._FindField
(pos
)
5624 start
, end
= field
._extent
5625 self
._SetInsertionPoint
(start
)
5626 self
._SetSelection
(start
, end
)
5630 """ Method provided for subclasses. Called by internal EVT_TEXT
5631 handler. Return False to override the class handler, True otherwise.
5638 Used to override the default Cut() method in base controls, instead
5639 copying the selection to the clipboard and then blanking the selection,
5640 leaving only the mask in the selected area behind.
5641 Note: _Cut (read "undercut" ;-) must be called from a Cut() override in the
5642 derived control because the mixin functions can't override a method of
5645 ## dbg("MaskedEditMixin::_Cut", indent=1)
5646 value
= self
._GetValue
()
5647 ## dbg('current value: "%s"' % value)
5648 sel_start
, sel_to
= self
._GetSelection
() ## check for a range of selected text
5649 ## dbg('selected text: "%s"' % value[sel_start:sel_to].strip())
5650 do
= wx
.TextDataObject()
5651 do
.SetText(value
[sel_start
:sel_to
].strip())
5652 wx
.TheClipboard
.Open()
5653 wx
.TheClipboard
.SetData(do
)
5654 wx
.TheClipboard
.Close()
5656 if sel_to
- sel_start
!= 0:
5661 # WS Note: overriding Copy is no longer necessary given that you
5662 # can no longer select beyond the last non-empty char in the control.
5664 ## def _Copy( self ):
5666 ## Override the wx.TextCtrl's .Copy function, with our own
5667 ## that does validation. Need to strip trailing spaces.
5669 ## sel_start, sel_to = self._GetSelection()
5670 ## select_len = sel_to - sel_start
5671 ## textval = wx.TextCtrl._GetValue(self)
5673 ## do = wx.TextDataObject()
5674 ## do.SetText(textval[sel_start:sel_to].strip())
5675 ## wx.TheClipboard.Open()
5676 ## wx.TheClipboard.SetData(do)
5677 ## wx.TheClipboard.Close()
5680 def _getClipboardContents( self
):
5681 """ Subroutine for getting the current contents of the clipboard.
5683 do
= wx
.TextDataObject()
5684 wx
.TheClipboard
.Open()
5685 success
= wx
.TheClipboard
.GetData(do
)
5686 wx
.TheClipboard
.Close()
5691 # Remove leading and trailing spaces before evaluating contents
5692 return do
.GetText().strip()
5695 def _validatePaste(self
, paste_text
, sel_start
, sel_to
, raise_on_invalid
=False):
5697 Used by paste routine and field choice validation to see
5698 if a given slice of paste text is legal for the area in question:
5699 returns validity, replacement text, and extent of paste in
5703 ## dbg('MaskedEditMixin::_validatePaste("%(paste_text)s", %(sel_start)d, %(sel_to)d), raise_on_invalid? %(raise_on_invalid)d' % locals(), indent=1)
5704 select_length
= sel_to
- sel_start
5705 maxlength
= select_length
5706 ## dbg('sel_to - sel_start:', maxlength)
5708 maxlength
= self
._masklength
- sel_start
5712 ## dbg('maxlength:', maxlength)
5713 if 'unicode' in wx
.PlatformInfo
and type(paste_text
) != types
.UnicodeType
:
5714 paste_text
= paste_text
.decode(self
._defaultEncoding
)
5716 length_considered
= len(paste_text
)
5717 if length_considered
> maxlength
:
5718 ## dbg('paste text will not fit into the %s:' % item, indent=0)
5719 if raise_on_invalid
:
5720 ## dbg(indent=0, suspend=0)
5721 if item
== 'control':
5722 ve
= ValueError('"%s" will not fit into the control "%s"' % (paste_text
, self
.name
))
5723 ve
.value
= paste_text
5726 ve
= ValueError('"%s" will not fit into the selection' % paste_text
)
5727 ve
.value
= paste_text
5730 ## dbg(indent=0, suspend=0)
5731 return False, None, None
5733 text
= self
._template
5734 ## dbg('length_considered:', length_considered)
5737 replacement_text
= ""
5738 replace_to
= sel_start
5740 while valid_paste
and i
< length_considered
and replace_to
< self
._masklength
:
5741 if paste_text
[i
:] == self
._template
[replace_to
:length_considered
]:
5742 # remainder of paste matches template; skip char-by-char analysis
5743 ## dbg('remainder paste_text[%d:] (%s) matches template[%d:%d]' % (i, paste_text[i:], replace_to, length_considered))
5744 replacement_text
+= paste_text
[i
:]
5745 replace_to
= i
= length_considered
5748 char
= paste_text
[i
]
5749 field
= self
._FindField
(replace_to
)
5750 if not field
._compareNoCase
:
5751 if field
._forceupper
: char
= char
.upper()
5752 elif field
._forcelower
: char
= char
.lower()
5754 ## dbg('char:', "'"+char+"'", 'i =', i, 'replace_to =', replace_to)
5755 ## dbg('self._isTemplateChar(%d)?' % replace_to, self._isTemplateChar(replace_to))
5756 if not self
._isTemplateChar
(replace_to
) and self
._isCharAllowed
( char
, replace_to
, allowAutoSelect
=False, ignoreInsertRight
=True):
5757 replacement_text
+= char
5758 ## dbg("not template(%(replace_to)d) and charAllowed('%(char)s',%(replace_to)d)" % locals())
5759 ## dbg("replacement_text:", '"'+replacement_text+'"')
5762 elif( char
== self
._template
[replace_to
]
5763 or (self
._signOk
and
5764 ( (i
== 0 and (char
== '-' or (self
._useParens
and char
== '(')))
5765 or (i
== self
._masklength
- 1 and self
._useParens
and char
== ')') ) ) ):
5766 replacement_text
+= char
5767 ## dbg("'%(char)s' == template(%(replace_to)d)" % locals())
5768 ## dbg("replacement_text:", '"'+replacement_text+'"')
5772 next_entry
= self
._findNextEntry
(replace_to
, adjustInsert
=False)
5773 if next_entry
== replace_to
:
5776 replacement_text
+= self
._template
[replace_to
:next_entry
]
5777 ## dbg("skipping template; next_entry =", next_entry)
5778 ## dbg("replacement_text:", '"'+replacement_text+'"')
5779 replace_to
= next_entry
# so next_entry will be considered on next loop
5781 if not valid_paste
and raise_on_invalid
:
5782 ## dbg('raising exception', indent=0, suspend=0)
5783 ve
= ValueError('"%s" cannot be inserted into the control "%s"' % (paste_text
, self
.name
))
5784 ve
.value
= paste_text
5788 elif i
< len(paste_text
):
5790 if raise_on_invalid
:
5791 ## dbg('raising exception', indent=0, suspend=0)
5792 ve
= ValueError('"%s" will not fit into the control "%s"' % (paste_text
, self
.name
))
5793 ve
.value
= paste_text
5796 ## dbg('valid_paste?', valid_paste)
5798 ## dbg('replacement_text: "%s"' % replacement_text, 'replace to:', replace_to)
5800 ## dbg(indent=0, suspend=0)
5801 return valid_paste
, replacement_text
, replace_to
5804 def _Paste( self
, value
=None, raise_on_invalid
=False, just_return_value
=False ):
5806 Used to override the base control's .Paste() function,
5807 with our own that does validation.
5808 Note: _Paste must be called from a Paste() override in the
5809 derived control because the mixin functions can't override a
5810 method of a sibling class.
5812 ## dbg('MaskedEditMixin::_Paste (value = "%s")' % value, indent=1)
5814 paste_text
= self
._getClipboardContents
()
5818 if paste_text
is not None:
5820 if 'unicode' in wx
.PlatformInfo
and type(paste_text
) != types
.UnicodeType
:
5821 paste_text
= paste_text
.decode(self
._defaultEncoding
)
5823 ## dbg('paste text: "%s"' % paste_text)
5824 # (conversion will raise ValueError if paste isn't legal)
5825 sel_start
, sel_to
= self
._GetSelection
()
5826 ## dbg('selection:', (sel_start, sel_to))
5828 # special case: handle allowInsert fields properly
5829 field
= self
._FindField
(sel_start
)
5830 edit_start
, edit_end
= field
._extent
5832 if field
._allowInsert
and sel_to
<= edit_end
and (sel_start
+ len(paste_text
) < edit_end
or field
._insertRight
):
5833 if field
._insertRight
:
5834 # want to paste to the left; see if it will fit:
5835 left_text
= self
._GetValue
()[edit_start
:sel_start
].lstrip()
5836 ## dbg('len(left_text):', len(left_text))
5837 ## dbg('len(paste_text):', len(paste_text))
5838 ## dbg('sel_start - (len(left_text) + len(paste_text)) >= edit_start?', sel_start - (len(left_text) + len(paste_text)) >= edit_start)
5839 if sel_start
- (len(left_text
) - (sel_to
- sel_start
) + len(paste_text
)) >= edit_start
:
5840 # will fit! create effective paste text, and move cursor back to do so:
5841 paste_text
= left_text
+ paste_text
5842 sel_start
-= len(left_text
)
5843 paste_text
= paste_text
.rjust(sel_to
- sel_start
)
5844 ## dbg('modified paste_text to be: "%s"' % paste_text)
5845 ## dbg('modified selection to:', (sel_start, sel_to))
5847 ## dbg("won't fit left;", 'paste text remains: "%s"' % paste_text)
5850 paste_text
= paste_text
+ self
._GetValue
()[sel_to
:edit_end
].rstrip()
5851 ## dbg("allow insert, but not insert right;", 'paste text set to: "%s"' % paste_text)
5854 new_pos
= sel_start
+ len(paste_text
) # store for subsequent positioning
5855 ## dbg('paste within insertable field; adjusted paste_text: "%s"' % paste_text, 'end:', edit_end)
5856 ## dbg('expanded selection to:', (sel_start, sel_to))
5858 # Another special case: paste won't fit, but it's a right-insert field where entire
5859 # non-empty value is selected, and there's room if the selection is expanded leftward:
5860 if( len(paste_text
) > sel_to
- sel_start
5861 and field
._insertRight
5862 and sel_start
> edit_start
5863 and sel_to
>= edit_end
5864 and not self
._GetValue
()[edit_start
:sel_start
].strip() ):
5865 # text won't fit within selection, but left of selection is empty;
5866 # check to see if we can expand selection to accommodate the value:
5867 empty_space
= sel_start
- edit_start
5868 amount_needed
= len(paste_text
) - (sel_to
- sel_start
)
5869 if amount_needed
<= empty_space
:
5870 sel_start
-= amount_needed
5871 ## dbg('expanded selection to:', (sel_start, sel_to))
5874 # another special case: deal with signed values properly:
5876 signedvalue
, signpos
, right_signpos
= self
._getSignedValue
()
5877 paste_signpos
= paste_text
.find('-')
5878 if paste_signpos
== -1:
5879 paste_signpos
= paste_text
.find('(')
5881 # if paste text will result in signed value:
5882 #### dbg('paste_signpos != -1?', paste_signpos != -1)
5883 #### dbg('sel_start:', sel_start, 'signpos:', signpos)
5884 #### dbg('field._insertRight?', field._insertRight)
5885 #### dbg('sel_start - len(paste_text) >= signpos?', sel_start - len(paste_text) <= signpos)
5886 if paste_signpos
!= -1 and (sel_start
<= signpos
5887 or (field
._insertRight
and sel_start
- len(paste_text
) <= signpos
)):
5891 # remove "sign" from paste text, so we can auto-adjust for sign type after paste:
5892 paste_text
= paste_text
.replace('-', ' ').replace('(',' ').replace(')','')
5893 ## dbg('unsigned paste text: "%s"' % paste_text)
5897 # another special case: deal with insert-right fields when selection is empty and
5898 # cursor is at end of field:
5899 #### dbg('field._insertRight?', field._insertRight)
5900 #### dbg('sel_start == edit_end?', sel_start == edit_end)
5901 #### dbg('sel_start', sel_start, 'sel_to', sel_to)
5902 if field
._insertRight
and sel_start
== edit_end
and sel_start
== sel_to
:
5903 sel_start
-= len(paste_text
)
5906 ## dbg('adjusted selection:', (sel_start, sel_to))
5908 raise_on_invalid
= raise_on_invalid
or field
._raiseOnInvalidPaste
5910 valid_paste
, replacement_text
, replace_to
= self
._validatePaste
(paste_text
, sel_start
, sel_to
, raise_on_invalid
)
5912 ## dbg('exception thrown', indent=0)
5916 ## dbg('paste text not legal for the selection or portion of the control following the cursor;')
5917 if not wx
.Validator_IsSilent():
5922 text
= self
._eraseSelection
()
5924 new_text
= text
[:sel_start
] + replacement_text
+ text
[replace_to
:]
5926 new_text
= string
.ljust(new_text
,self
._masklength
)
5928 new_text
, signpos
, right_signpos
= self
._getSignedValue
(candidate
=new_text
)
5931 new_text
= new_text
[:signpos
] + '(' + new_text
[signpos
+1:right_signpos
] + ')' + new_text
[right_signpos
+1:]
5933 new_text
= new_text
[:signpos
] + '-' + new_text
[signpos
+1:]
5937 ## dbg("new_text:", '"'+new_text+'"')
5939 if not just_return_value
:
5940 if new_text
!= self
._GetValue
():
5941 self
.modified
= True
5945 wx
.CallAfter(self
._SetValue
, new_text
)
5947 new_pos
= sel_start
+ len(replacement_text
)
5948 wx
.CallAfter(self
._SetInsertionPoint
, new_pos
)
5951 return new_text
, replace_to
5952 elif just_return_value
:
5954 return self
._GetValue
(), sel_to
5957 def _Undo(self
, value
=None, prev
=None, just_return_results
=False):
5958 """ Provides an Undo() method in base controls. """
5959 ## dbg("MaskedEditMixin::_Undo", indent=1)
5961 value
= self
._GetValue
()
5963 prev
= self
._prevValue
5964 ## dbg('current value: "%s"' % value)
5965 ## dbg('previous value: "%s"' % prev)
5967 ## dbg('no previous value', indent=0)
5971 # Determine what to select: (relies on fixed-length strings)
5972 # (This is a lot harder than it would first appear, because
5973 # of mask chars that stay fixed, and so break up the "diff"...)
5975 # Determine where they start to differ:
5977 length
= len(value
) # (both are same length in masked control)
5979 while( value
[:i
] == prev
[:i
] ):
5984 # handle signed values carefully, so undo from signed to unsigned or vice-versa
5987 text
, signpos
, right_signpos
= self
._getSignedValue
(candidate
=prev
)
5989 if prev
[signpos
] == '(' and prev
[right_signpos
] == ')':
5993 # eliminate source of "far-end" undo difference if using balanced parens:
5994 value
= value
.replace(')', ' ')
5995 prev
= prev
.replace(')', ' ')
5996 elif prev
[signpos
] == '-':
6001 # Determine where they stop differing in "undo" result:
6002 sm
= difflib
.SequenceMatcher(None, a
=value
, b
=prev
)
6003 i
, j
, k
= sm
.find_longest_match(sel_start
, length
, sel_start
, length
)
6004 ## dbg('i,j,k = ', (i,j,k), 'value[i:i+k] = "%s"' % value[i:i+k], 'prev[j:j+k] = "%s"' % prev[j:j+k] )
6006 if k
== 0: # no match found; select to end
6009 code_5tuples
= sm
.get_opcodes()
6010 for op
, i1
, i2
, j1
, j2
in code_5tuples
:
6011 ## dbg("%7s value[%d:%d] (%s) prev[%d:%d] (%s)" % (op, i1, i2, value[i1:i2], j1, j2, prev[j1:j2]))
6015 # look backward through operations needed to produce "previous" value;
6016 # first change wins:
6017 for next_op
in range(len(code_5tuples
)-1, -1, -1):
6018 op
, i1
, i2
, j1
, j2
= code_5tuples
[next_op
]
6019 ## dbg('value[i1:i2]: "%s"' % value[i1:i2], 'template[i1:i2] "%s"' % self._template[i1:i2])
6020 field
= self
._FindField
(i2
)
6021 if op
== 'insert' and prev
[j1
:j2
] != self
._template
[j1
:j2
]:
6022 ## dbg('insert found: selection =>', (j1, j2))
6027 elif op
== 'delete' and value
[i1
:i2
] != self
._template
[i1
:i2
]:
6028 edit_start
, edit_end
= field
._extent
6029 if field
._insertRight
and (field
._allowInsert
or i2
== edit_end
):
6035 ## dbg('delete found: selection =>', (sel_start, sel_to))
6038 elif op
== 'replace':
6039 if not prev
[i1
:i2
].strip() and field
._insertRight
:
6040 sel_start
= sel_to
= j2
6044 ## dbg('replace found: selection =>', (sel_start, sel_to))
6050 # now go forwards, looking for earlier changes:
6051 ## dbg('searching forward...')
6052 for next_op
in range(len(code_5tuples
)):
6053 op
, i1
, i2
, j1
, j2
= code_5tuples
[next_op
]
6054 field
= self
._FindField
(i1
)
6057 elif op
== 'replace':
6058 if field
._insertRight
:
6059 # if replace with spaces in an insert-right control, ignore "forward" replace
6060 if not prev
[i1
:i2
].strip():
6063 ## dbg('setting sel_start to', j1)
6066 ## dbg('setting sel_start to', i1)
6069 ## dbg('setting sel_start to', i1)
6071 ## dbg('saw replace; breaking')
6073 elif op
== 'insert' and not value
[i1
:i2
]:
6074 ## dbg('forward %s found' % op)
6075 if prev
[j1
:j2
].strip():
6076 ## dbg('item to insert non-empty; setting sel_start to', j1)
6079 elif not field
._insertRight
:
6080 ## dbg('setting sel_start to inserted space:', j1)
6083 elif op
== 'delete':
6084 ## dbg('delete; field._insertRight?', field._insertRight, 'value[%d:%d].lstrip: "%s"' % (i1,i2,value[i1:i2].lstrip()))
6085 if field
._insertRight
:
6086 if value
[i1
:i2
].lstrip():
6087 ## dbg('setting sel_start to ', j1)
6089 ## dbg('breaking loop')
6094 ## dbg('saw delete; breaking')
6097 ## dbg('unknown code!')
6098 # we've got what we need
6103 ## dbg('no insert,delete or replace found (!)')
6104 # do "left-insert"-centric processing of difference based on l.c.s.:
6105 if i
== j
and j
!= sel_start
: # match starts after start of selection
6106 sel_to
= sel_start
+ (j
-sel_start
) # select to start of match
6108 sel_to
= j
# (change ends at j)
6111 # There are several situations where the calculated difference is
6112 # not what we want to select. If changing sign, or just adding
6113 # group characters, we really don't want to highlight the characters
6114 # changed, but instead leave the cursor where it is.
6115 # Also, there a situations in which the difference can be ambiguous;
6118 # current value: 11234
6119 # previous value: 1111234
6121 # Where did the cursor actually lie and which 1s were selected on the delete
6124 # Also, difflib can "get it wrong;" Consider:
6126 # current value: " 128.66"
6127 # previous value: " 121.86"
6129 # difflib produces the following opcodes, which are sub-optimal:
6130 # equal value[0:9] ( 12) prev[0:9] ( 12)
6131 # insert value[9:9] () prev[9:11] (1.)
6132 # equal value[9:10] (8) prev[11:12] (8)
6133 # delete value[10:11] (.) prev[12:12] ()
6134 # equal value[11:12] (6) prev[12:13] (6)
6135 # delete value[12:13] (6) prev[13:13] ()
6137 # This should have been:
6138 # equal value[0:9] ( 12) prev[0:9] ( 12)
6139 # replace value[9:11] (8.6) prev[9:11] (1.8)
6140 # equal value[12:13] (6) prev[12:13] (6)
6142 # But it didn't figure this out!
6144 # To get all this right, we use the previous selection recorded to help us...
6146 if (sel_start
, sel_to
) != self
._prevSelection
:
6147 ## dbg('calculated selection', (sel_start, sel_to), "doesn't match previous", self._prevSelection)
6149 prev_sel_start
, prev_sel_to
= self
._prevSelection
6150 field
= self
._FindField
(sel_start
)
6152 and sel_start
< self
._masklength
6153 and (prev
[sel_start
] in ('-', '(', ')')
6154 or value
[sel_start
] in ('-', '(', ')')) ):
6155 # change of sign; leave cursor alone...
6156 ## dbg("prev[sel_start] in ('-', '(', ')')?", prev[sel_start] in ('-', '(', ')'))
6157 ## dbg("value[sel_start] in ('-', '(', ')')?", value[sel_start] in ('-', '(', ')'))
6158 ## dbg('setting selection to previous one')
6159 sel_start
, sel_to
= self
._prevSelection
6161 elif field
._groupdigits
and (value
[sel_start
:sel_to
] == field
._groupChar
6162 or prev
[sel_start
:sel_to
] == field
._groupChar
):
6163 # do not highlight grouping changes
6164 ## dbg('value[sel_start:sel_to] == field._groupChar?', value[sel_start:sel_to] == field._groupChar)
6165 ## dbg('prev[sel_start:sel_to] == field._groupChar?', prev[sel_start:sel_to] == field._groupChar)
6166 ## dbg('setting selection to previous one')
6167 sel_start
, sel_to
= self
._prevSelection
6170 calc_select_len
= sel_to
- sel_start
6171 prev_select_len
= prev_sel_to
- prev_sel_start
6173 ## dbg('sel_start == prev_sel_start', sel_start == prev_sel_start)
6174 ## dbg('sel_to > prev_sel_to', sel_to > prev_sel_to)
6176 if prev_select_len
>= calc_select_len
:
6177 # old selection was bigger; trust it:
6178 ## dbg('prev_select_len >= calc_select_len?', prev_select_len >= calc_select_len)
6179 if not field
._insertRight
:
6180 ## dbg('setting selection to previous one')
6181 sel_start
, sel_to
= self
._prevSelection
6183 sel_to
= self
._prevSelection
[1]
6184 ## dbg('setting selection to', (sel_start, sel_to))
6186 elif( sel_to
> prev_sel_to
# calculated select past last selection
6187 and prev_sel_to
< len(self
._template
) # and prev_sel_to not at end of control
6188 and sel_to
== len(self
._template
) ): # and calculated selection goes to end of control
6190 i
, j
, k
= sm
.find_longest_match(prev_sel_to
, length
, prev_sel_to
, length
)
6191 ## dbg('i,j,k = ', (i,j,k), 'value[i:i+k] = "%s"' % value[i:i+k], 'prev[j:j+k] = "%s"' % prev[j:j+k] )
6193 # difflib must not have optimized opcodes properly;
6197 # look for possible ambiguous diff:
6199 # if last change resulted in no selection, test from resulting cursor position:
6200 if prev_sel_start
== prev_sel_to
:
6201 calc_select_len
= sel_to
- sel_start
6202 field
= self
._FindField
(prev_sel_start
)
6204 # determine which way to search from last cursor position for ambiguous change:
6205 if field
._insertRight
:
6206 test_sel_start
= prev_sel_start
6207 test_sel_to
= prev_sel_start
+ calc_select_len
6209 test_sel_start
= prev_sel_start
- calc_select_len
6210 test_sel_to
= prev_sel_start
6212 test_sel_start
, test_sel_to
= prev_sel_start
, prev_sel_to
6214 ## dbg('test selection:', (test_sel_start, test_sel_to))
6215 ## dbg('calc change: "%s"' % prev[sel_start:sel_to])
6216 ## dbg('test change: "%s"' % prev[test_sel_start:test_sel_to])
6218 # if calculated selection spans characters, and same characters
6219 # "before" the previous insertion point are present there as well,
6220 # select the ones related to the last known selection instead.
6221 if( sel_start
!= sel_to
6222 and test_sel_to
< len(self
._template
)
6223 and prev
[test_sel_start
:test_sel_to
] == prev
[sel_start
:sel_to
] ):
6225 sel_start
, sel_to
= test_sel_start
, test_sel_to
6227 # finally, make sure that the old and new values are
6228 # different where we say they're different:
6229 while( sel_to
- 1 > 0
6230 and sel_to
> sel_start
6231 and value
[sel_to
-1:] == prev
[sel_to
-1:]):
6233 while( sel_start
+ 1 < self
._masklength
6234 and sel_start
< sel_to
6235 and value
[:sel_start
+1] == prev
[:sel_start
+1]):
6238 ## dbg('sel_start, sel_to:', sel_start, sel_to)
6239 ## dbg('previous value: "%s"' % prev)
6241 if just_return_results
:
6242 return prev
, (sel_start
, sel_to
)
6244 self
._SetValue
(prev
)
6245 self
._SetInsertionPoint
(sel_start
)
6246 self
._SetSelection
(sel_start
, sel_to
)
6249 ## dbg('no difference between previous value')
6251 if just_return_results
:
6252 return prev
, self
._GetSelection
()
6255 def _OnClear(self
, event
):
6256 """ Provides an action for context menu delete operation """
6260 def _OnContextMenu(self
, event
):
6261 ## dbg('MaskedEditMixin::OnContextMenu()', indent=1)
6263 menu
.Append(wx
.ID_UNDO
, "Undo", "")
6264 menu
.AppendSeparator()
6265 menu
.Append(wx
.ID_CUT
, "Cut", "")
6266 menu
.Append(wx
.ID_COPY
, "Copy", "")
6267 menu
.Append(wx
.ID_PASTE
, "Paste", "")
6268 menu
.Append(wx
.ID_CLEAR
, "Delete", "")
6269 menu
.AppendSeparator()
6270 menu
.Append(wx
.ID_SELECTALL
, "Select All", "")
6272 wx
.EVT_MENU(menu
, wx
.ID_UNDO
, self
._OnCtrl
_Z
)
6273 wx
.EVT_MENU(menu
, wx
.ID_CUT
, self
._OnCtrl
_X
)
6274 wx
.EVT_MENU(menu
, wx
.ID_COPY
, self
._OnCtrl
_C
)
6275 wx
.EVT_MENU(menu
, wx
.ID_PASTE
, self
._OnCtrl
_V
)
6276 wx
.EVT_MENU(menu
, wx
.ID_CLEAR
, self
._OnClear
)
6277 wx
.EVT_MENU(menu
, wx
.ID_SELECTALL
, self
._OnCtrl
_A
)
6279 # ## WSS: The base control apparently handles
6280 # enable/disable of wx.ID_CUT, wx.ID_COPY, wx.ID_PASTE
6281 # and wx.ID_CLEAR menu items even if the menu is one
6282 # we created. However, it doesn't do undo properly,
6283 # so we're keeping track of previous values ourselves.
6284 # Therefore, we have to override the default update for
6285 # that item on the menu:
6286 wx
.EVT_UPDATE_UI(self
, wx
.ID_UNDO
, self
._UndoUpdateUI
)
6287 self
._contextMenu
= menu
6289 self
.PopupMenu(menu
, event
.GetPosition())
6291 self
._contextMenu
= None
6294 def _UndoUpdateUI(self
, event
):
6295 if self
._prevValue
is None or self
._prevValue
== self
._curValue
:
6296 self
._contextMenu
.Enable(wx
.ID_UNDO
, False)
6298 self
._contextMenu
.Enable(wx
.ID_UNDO
, True)
6301 def _OnCtrlParametersChanged(self
):
6303 Overridable function to allow derived classes to take action as a
6304 result of parameter changes prior to possibly changing the value
6309 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
6310 class MaskedEditAccessorsMixin
:
6312 To avoid a ton of boiler-plate, and to automate the getter/setter generation
6313 for each valid control parameter so we never forget to add the functions when
6314 adding parameters, this class programmatically adds the masked edit mixin
6315 parameters to itself.
6316 (This makes it easier for Designers like Boa to deal with masked controls.)
6318 To further complicate matters, this is done with an extra level of inheritance,
6319 so that "general" classes like masked.TextCtrl can have all possible attributes,
6320 while derived classes, like masked.TimeCtrl and masked.NumCtrl can prevent
6321 exposure of those optional attributes of their base class that do not make
6322 sense for their derivation.
6324 Therefore, we define:
6325 BaseMaskedTextCtrl(TextCtrl, MaskedEditMixin)
6327 masked.TextCtrl(BaseMaskedTextCtrl, MaskedEditAccessorsMixin).
6329 This allows us to then derive:
6330 masked.NumCtrl( BaseMaskedTextCtrl )
6332 and not have to expose all the same accessor functions for the
6333 derived control when they don't all make sense for it.
6337 # Define the default set of attributes exposed by the most generic masked controls:
6338 exposed_basectrl_params
= MaskedEditMixin
.valid_ctrl_params
.keys() + Field
.valid_params
.keys()
6339 exposed_basectrl_params
.remove('index')
6340 exposed_basectrl_params
.remove('extent')
6341 exposed_basectrl_params
.remove('foregroundColour') # (base class already has this)
6343 for param
in exposed_basectrl_params
:
6344 propname
= param
[0].upper() + param
[1:]
6345 exec('def Set%s(self, value): self.SetCtrlParameters(%s=value)' % (propname
, param
))
6346 exec('def Get%s(self): return self.GetCtrlParameter("%s")''' % (propname, param))
6348 if param.find('Colour
') != -1:
6349 # add non-british spellings, for backward-compatibility
6350 propname.replace('Colour
', 'Color
')
6352 exec('def Set
%s(self
, value
): self
.SetCtrlParameters(%s=value
)' % (propname, param))
6353 exec('def Get
%s(self
): return self
.GetCtrlParameter("%s")''' % (propname, param))
6358 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
6359 ## these are helper subroutines:
6361 def _movetofloat( origvalue, fmtstring, neg, addseparators=False, sepchar = ',',fillchar=' '):
6362 """ addseparators = add separator character every three numerals if True
6364 fmt0 = fmtstring.split('.')
6367 val = origvalue.split('.')[0].strip()
6368 ret = fillchar * (len(fmt1)-len(val)) + val + "." + "0" * len(fmt2)
6371 return (ret,len(fmt1))
6374 def _isDateType( fmtstring ):
6375 """ Checks the mask and returns True if it fits an allowed
6376 date or datetime format.
6378 dateMasks = ("^##/##/####",
6390 reString = "|".join(dateMasks)
6391 filter = re.compile( reString)
6392 if re.match(filter,fmtstring): return True
6395 def _isTimeType( fmtstring ):
6396 """ Checks the mask and returns True if it fits an allowed
6399 reTimeMask = "^##:##(:##)?( (AM|PM))?"
6400 filter = re.compile( reTimeMask )
6401 if re.match(filter,fmtstring): return True
6405 def _isFloatingPoint( fmtstring):
6406 filter = re.compile("[ ]?[#]+\.[#]+\n")
6407 if re.match(filter,fmtstring+"\n"): return True
6411 def _isInteger( fmtstring ):
6412 filter = re.compile("[#]+\n")
6413 if re.match(filter,fmtstring+"\n"): return True
6417 def _getDateParts( dateStr, dateFmt ):
6418 if len(dateStr) > 11: clip = dateStr[0:11]
6419 else: clip = dateStr
6420 if clip[-2] not in string.digits:
6421 clip = clip[:-1] # (got part of time; drop it)
6423 dateSep = (('/' in clip) * '/') + (('-' in clip) * '-') + (('.' in clip) * '.')
6424 slices = clip.split(dateSep)
6425 if dateFmt == "MDY":
6426 y,m,d = (slices[2],slices[0],slices[1]) ## year, month, date parts
6427 elif dateFmt == "DMY":
6428 y,m,d = (slices[2],slices[1],slices[0]) ## year, month, date parts
6429 elif dateFmt == "YMD":
6430 y,m,d = (slices[0],slices[1],slices[2]) ## year, month, date parts
6432 y,m,d = None, None, None
6439 def _getDateSepChar(dateStr):
6440 clip = dateStr[0:10]
6441 dateSep = (('/' in clip) * '/') + (('-' in clip) * '-') + (('.' in clip) * '.')
6445 def _makeDate( year, month, day, dateFmt, dateStr):
6446 sep = _getDateSepChar( dateStr)
6447 if dateFmt == "MDY":
6448 return "%s%s%s%s%s" % (month,sep,day,sep,year) ## year, month, date parts
6449 elif dateFmt == "DMY":
6450 return "%s%s%s%s%s" % (day,sep,month,sep,year) ## year, month, date parts
6451 elif dateFmt == "YMD":
6452 return "%s%s%s%s%s" % (year,sep,month,sep,day) ## year, month, date parts
6457 def _getYear(dateStr,dateFmt):
6458 parts = _getDateParts( dateStr, dateFmt)
6461 def _getMonth(dateStr,dateFmt):
6462 parts = _getDateParts( dateStr, dateFmt)
6465 def _getDay(dateStr,dateFmt):
6466 parts = _getDateParts( dateStr, dateFmt)
6469 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
6470 class __test(wx.PySimpleApp):
6472 from wx.lib.rcsizer import RowColSizer
6473 self.frame = wx.Frame( None, -1, "MaskedEditMixin 0.0.7 Demo Page #1", size = (700,600))
6474 self.panel = wx.Panel( self.frame, -1)
6475 self.sizer = RowColSizer()
6480 id, id1 = wx.NewId(), wx.NewId()
6481 self.command1 = wx.Button( self.panel, id, "&Close" )
6482 self.command2 = wx.Button( self.panel, id1, "&AutoFormats" )
6483 self.sizer.Add(self.command1, row=0, col=0, flag=wx.ALL, border = 5)
6484 self.sizer.Add(self.command2, row=0, col=1, colspan=2, flag=wx.ALL, border = 5)
6485 self.panel.Bind(wx.EVT_BUTTON, self.onClick, self.command1 )
6486 ## self.panel.SetDefaultItem(self.command1 )
6487 self.panel.Bind(wx.EVT_BUTTON, self.onClickPage, self.command2)
6489 self.check1 = wx.CheckBox( self.panel, -1, "Disallow Empty" )
6490 self.check2 = wx.CheckBox( self.panel, -1, "Highlight Empty" )
6491 self.sizer.Add( self.check1, row=0,col=3, flag=wx.ALL,border=5 )
6492 self.sizer.Add( self.check2, row=0,col=4, flag=wx.ALL,border=5 )
6493 self.panel.Bind(wx.EVT_CHECKBOX, self._onCheck1, self.check1 )
6494 self.panel.Bind(wx.EVT_CHECKBOX, self._onCheck2, self.check2 )
6497 label = """Press ctrl-s in any field to output the value and plain value. Press ctrl-x to clear and re-set any field.
6498 Note that all controls have been auto-sized by including F in the format code.
6499 Try entering nonsensical or partial values in validated fields to see what happens (use ctrl-s to test the valid status)."""
6500 label2 = "\nNote that the State and Last Name fields are list-limited (Name:Smith,Jones,Williams)."
6502 self.label1 = wx.StaticText( self.panel, -1, label)
6503 self.label2 = wx.StaticText( self.panel, -1, "Description")
6504 self.label3 = wx.StaticText( self.panel, -1, "Mask Value")
6505 self.label4 = wx.StaticText( self.panel, -1, "Format")
6506 self.label5 = wx.StaticText( self.panel, -1, "Reg Expr Val. (opt)")
6507 self.label6 = wx.StaticText( self.panel, -1, "MaskedEdit Ctrl")
6508 self.label7 = wx.StaticText( self.panel, -1, label2)
6509 self.label7.SetForegroundColour("Blue")
6510 self.label1.SetForegroundColour("Blue")
6511 self.label2.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6512 self.label3.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6513 self.label4.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6514 self.label5.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6515 self.label6.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6517 self.sizer.Add( self.label1, row=1,col=0,colspan=7, flag=wx.ALL,border=5)
6518 self.sizer.Add( self.label7, row=2,col=0,colspan=7, flag=wx.ALL,border=5)
6519 self.sizer.Add( self.label2, row=3,col=0, flag=wx.ALL,border=5)
6520 self.sizer.Add( self.label3, row=3,col=1, flag=wx.ALL,border=5)
6521 self.sizer.Add( self.label4, row=3,col=2, flag=wx.ALL,border=5)
6522 self.sizer.Add( self.label5, row=3,col=3, flag=wx.ALL,border=5)
6523 self.sizer.Add( self.label6, row=3,col=4, flag=wx.ALL,border=5)
6525 # The following list is of the controls for the demo. Feel free to play around with
6528 #description mask excl format regexp range,list,initial
6529 ("Phone No", "(###) ###-#### x:###", "", 'F!^-R', "^\(\d\d\d\) \d\d\d-\d\d\d\d", (),[],''),
6530 ("Last Name Only", "C{14}", "", 'F {list}', '^[A-Z][a-zA-Z]+', (),('Smith','Jones','Williams'),''),
6531 ("Full Name", "C{14}", "", 'F_', '^[A-Z][a-zA-Z]+ [A-Z][a-zA-Z]+', (),[],''),
6532 ("Social Sec#", "###-##-####", "", 'F', "\d{3}-\d{2}-\d{4}", (),[],''),
6533 ("U.S. Zip+4", "#{5}-#{4}", "", 'F', "\d{5}-(\s{4}|\d{4})",(),[],''),
6534 ("U.S. State (2 char)\n(with default)","AA", "", 'F!', "[A-Z]{2}", (),states, 'AZ'),
6535 ("Customer No", "\CAA-###", "", 'F!', "C[A-Z]{2}-\d{3}", (),[],''),
6536 ("Date (MDY) + Time\n(with default)", "##/##/#### ##:## AM", 'BCDEFGHIJKLMNOQRSTUVWXYZ','DFR!',"", (),[], r'03/05/2003 12:00 AM'),
6537 ("Invoice Total", "#{9}.##", "", 'F-R,', "", (),[], ''),
6538 ("Integer (signed)\n(with default)", "#{6}", "", 'F-R', "", (),[], '0 '),
6539 ("Integer (unsigned)\n(with default), 1-399", "######", "", 'F', "", (1,399),[], '1 '),
6540 ("Month selector", "XXX", "", 'F', "", (),
6541 ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],""),
6542 ("fraction selector","#/##", "", 'F', "^\d\/\d\d?", (),
6543 ['2/3', '3/4', '1/2', '1/4', '1/8', '1/16', '1/32', '1/64'], "")
6546 for control in controls:
6547 self.sizer.Add( wx.StaticText( self.panel, -1, control[0]),row=rowcount, col=0,border=5,flag=wx.ALL)
6548 self.sizer.Add( wx.StaticText( self.panel, -1, control[1]),row=rowcount, col=1,border=5, flag=wx.ALL)
6549 self.sizer.Add( wx.StaticText( self.panel, -1, control[3]),row=rowcount, col=2,border=5, flag=wx.ALL)
6550 self.sizer.Add( wx.StaticText( self.panel, -1, control[4][:20]),row=rowcount, col=3,border=5, flag=wx.ALL)
6552 if control in controls[:]:#-2]:
6553 newControl = MaskedTextCtrl( self.panel, -1, "",
6555 excludeChars = control[2],
6556 formatcodes = control[3],
6558 validRegex = control[4],
6559 validRange = control[5],
6560 choices = control[6],
6561 defaultValue = control[7],
6563 if control[6]: newControl.SetCtrlParameters(choiceRequired = True)
6565 newControl = MaskedComboBox( self.panel, -1, "",
6566 choices = control[7],
6567 choiceRequired = True,
6569 formatcodes = control[3],
6570 excludeChars = control[2],
6572 validRegex = control[4],
6573 validRange = control[5],
6575 self.editList.append( newControl )
6577 self.sizer.Add( newControl, row=rowcount,col=4,flag=wx.ALL,border=5)
6580 self.sizer.AddGrowableCol(4)
6582 self.panel.SetSizer(self.sizer)
6583 self.panel.SetAutoLayout(1)
6590 def onClick(self, event):
6593 def onClickPage(self, event):
6594 self.page2 = __test2(self.frame,-1,"")
6595 self.page2.Show(True)
6597 def _onCheck1(self,event):
6598 """ Set required value on/off """
6599 value = event.IsChecked()
6601 for control in self.editList:
6602 control.SetCtrlParameters(emptyInvalid=True)
6605 for control in self.editList:
6606 control.SetCtrlParameters(emptyInvalid=False)
6608 self.panel.Refresh()
6610 def _onCheck2(self,event):
6611 """ Highlight empty values"""
6612 value = event.IsChecked()
6614 for control in self.editList:
6615 control.SetCtrlParameters( emptyBackgroundColour = 'Aquamarine')
6618 for control in self.editList:
6619 control.SetCtrlParameters( emptyBackgroundColour = 'White')
6621 self.panel.Refresh()
6624 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
6626 class __test2(wx.Frame):
6627 def __init__(self, parent, id, caption):
6628 wx.Frame.__init__( self, parent, id, "MaskedEdit control 0.0.7 Demo Page #2 -- AutoFormats", size = (550,600))
6629 from wx.lib.rcsizer import RowColSizer
6630 self.panel = wx.Panel( self, -1)
6631 self.sizer = RowColSizer()
6637 All these controls have been created by passing a single parameter, the AutoFormat code.
6638 The class contains an internal dictionary of types and formats (autoformats).
6639 To see a great example of validations in action, try entering a bad email address, then tab out."""
6641 self.label1 = wx.StaticText( self.panel, -1, label)
6642 self.label2 = wx.StaticText( self.panel, -1, "Description")
6643 self.label3 = wx.StaticText( self.panel, -1, "AutoFormat Code")
6644 self.label4 = wx.StaticText( self.panel, -1, "MaskedEdit Control")
6645 self.label1.SetForegroundColour("Blue")
6646 self.label2.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6647 self.label3.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6648 self.label4.SetFont(wx.Font(9,wx.SWISS,wx.NORMAL,wx.BOLD))
6650 self.sizer.Add( self.label1, row=1,col=0,colspan=3, flag=wx.ALL,border=5)
6651 self.sizer.Add( self.label2, row=3,col=0, flag=wx.ALL,border=5)
6652 self.sizer.Add( self.label3, row=3,col=1, flag=wx.ALL,border=5)
6653 self.sizer.Add( self.label4, row=3,col=2, flag=wx.ALL,border=5)
6655 id, id1 = wx.NewId(), wx.NewId()
6656 self.command1 = wx.Button( self.panel, id, "&Close")
6657 self.command2 = wx.Button( self.panel, id1, "&Print Formats")
6658 self.panel.Bind(wx.EVT_BUTTON, self.onClick, self.command1)
6659 self.panel.SetDefaultItem(self.command1)
6660 self.panel.Bind(wx.EVT_BUTTON, self.onClickPrint, self.command2)
6662 # The following list is of the controls for the demo. Feel free to play around with
6665 ("Phone No","USPHONEFULLEXT"),
6666 ("US Date + Time","USDATETIMEMMDDYYYY/HHMM"),
6667 ("US Date MMDDYYYY","USDATEMMDDYYYY/"),
6668 ("Time (with seconds)","TIMEHHMMSS"),
6669 ("Military Time\n(without seconds)","24HRTIMEHHMM"),
6670 ("Social Sec#","USSOCIALSEC"),
6671 ("Credit Card","CREDITCARD"),
6672 ("Expiration MM/YY","EXPDATEMMYY"),
6673 ("Percentage","PERCENT"),
6674 ("Person's Age","AGE"),
6675 ("US Zip Code","USZIP"),
6676 ("US Zip+4","USZIPPLUS4"),
6677 ("Email Address","EMAIL"),
6678 ("IP Address", "(derived control IpAddrCtrl)")
6681 for control in controls:
6682 self.sizer.Add( wx.StaticText( self.panel, -1, control[0]),row=rowcount, col=0,border=5,flag=wx.ALL)
6683 self.sizer.Add( wx.StaticText( self.panel, -1, control[1]),row=rowcount, col=1,border=5, flag=wx.ALL)
6684 if control in controls[:-1]:
6685 self.sizer.Add( MaskedTextCtrl( self.panel, -1, "",
6686 autoformat = control[1],
6688 row=rowcount,col=2,flag=wx.ALL,border=5)
6690 self.sizer.Add( IpAddrCtrl( self.panel, -1, "", demo=True ),
6691 row=rowcount,col=2,flag=wx.ALL,border=5)
6694 self.sizer.Add(self.command1, row=0, col=0, flag=wx.ALL, border = 5)
6695 self.sizer.Add(self.command2, row=0, col=1, flag=wx.ALL, border = 5)
6696 self.sizer.AddGrowableCol(3)
6698 self.panel.SetSizer(self.sizer)
6699 self.panel.SetAutoLayout(1)
6701 def onClick(self, event):
6704 def onClickPrint(self, event):
6705 for format in masktags.keys():
6706 sep = "+------------------------+"
6707 print "%s\n%s \n Mask: %s \n RE Validation string: %s\n" % (sep,format, masktags[format]['mask'], masktags[format]['validRegex'])
6709 ## ---------- ---------- ---------- ---------- ---------- ---------- ----------
6711 if __name__ == "__main__":
6717 ## ===================================
6719 ## 1. WS: For some reason I don't understand, the control is generating two (2)
6720 ## EVT_TEXT events for every one (1) .SetValue() of the underlying control.
6721 ## I've been unsuccessful in determining why or in my efforts to make just one
6722 ## occur. So, I've added a hack to save the last seen value from the
6723 ## control in the EVT_TEXT handler, and if *different*, call event.Skip()
6724 ## to propagate it down the event chain, and let the application see it.
6726 ## 2. WS: MaskedComboBox is deficient in several areas, all having to do with the
6727 ## behavior of the underlying control that I can't fix. The problems are:
6728 ## a) The background coloring doesn't work in the text field of the control;
6729 ## instead, there's a only border around it that assumes the correct color.
6730 ## b) The control will not pass WXK_TAB to the event handler, no matter what
6731 ## I do, and there's no style wxCB_PROCESS_TAB like wxTE_PROCESS_TAB to
6732 ## indicate that we want these events. As a result, MaskedComboBox
6733 ## doesn't do the nice field-tabbing that MaskedTextCtrl does.
6734 ## c) Auto-complete had to be reimplemented for the control because programmatic
6735 ## setting of the value of the text field does not set up the auto complete
6736 ## the way that the control processing keystrokes does. (But I think I've
6737 ## implemented a fairly decent approximation.) Because of this the control
6738 ## also won't auto-complete on dropdown, and there's no event I can catch
6739 ## to work around this problem.
6740 ## d) There is no method provided for getting the selection; the hack I've
6741 ## implemented has its flaws, not the least of which is that due to the
6742 ## strategy that I'm using, the paste buffer is always replaced by the
6743 ## contents of the control's selection when in focus, on each keystroke;
6744 ## this makes it impossible to paste anything into a MaskedComboBox
6745 ## at the moment... :-(
6746 ## e) The other deficient behavior, likely induced by the workaround for (d),
6747 ## is that you can can't shift-left to select more than one character
6751 ## 3. WS: Controls on wxPanels don't seem to pass Shift-WXK_TAB to their
6752 ## EVT_KEY_DOWN or EVT_CHAR event handlers. Until this is fixed in
6753 ## wxWindows, shift-tab won't take you backwards through the fields of
6754 ## a MaskedTextCtrl like it should. Until then Shifted arrow keys will
6755 ## work like shift-tab and tab ought to.
6759 ## =============================##
6760 ## 1. Add Popup list for auto-completable fields that simulates combobox on individual
6761 ## fields. Example: City validates against list of cities, or zip vs zip code list.
6762 ## 2. Allow optional monetary symbols (eg. $, pounds, etc.) at front of a "decimal"
6764 ## 3. Fix shift-left selection for MaskedComboBox.
6765 ## 5. Transform notion of "decimal control" to be less "entire control"-centric,
6766 ## so that monetary symbols can be included and still have the appropriate
6767 ## semantics. (Big job, as currently written, but would make control even
6768 ## more useful for business applications.)
6772 ## ====================
6774 ## 1. Added parameter option stopFieldChangeIfInvalid, which can be used to relax the
6775 ## validation rules for a control, but make best efforts to stop navigation out of
6776 ## that field should its current value be invalid. Note: this does not prevent the
6777 ## value from remaining invalid if focus for the control is lost, via mousing etc.
6780 ## 1. Added proper support for NUMPAD keypad keycodes for navigation and control.
6783 ## 1. Added value member to ValueError exceptions, so that people can catch them
6784 ## and then display their own errors, and added attribute raiseOnInvalidPaste,
6785 ## so one doesn't have to subclass the controls simply to force generation of
6786 ## a ValueError on a bad paste operation.
6787 ## 2. Fixed handling of unicode charsets by converting to explicit control char
6788 ## set testing for passing those keystrokes to the base control, and then
6789 ## changing the semantics of the * maskchar to indicate any visible char.
6790 ## 3. Added '|' mask specification character, which allows splitting of contiguous
6791 ## mask characters into separate fields, allowing finer control of behavior
6796 ## 1. Added handling for WXK_DELETE and WXK_INSERT, such that shift-delete
6797 ## cuts, shift-insert pastes, and ctrl-insert copies.
6800 ## 1. Now ignores kill focus events when being destroyed.
6801 ## 2. Added missing call to set insertion point on changing fields.
6802 ## 3. Modified SetKeyHandler() to accept None as means of removing one.
6803 ## 4. Fixed keyhandler processing for group and decimal character changes.
6804 ## 5. Fixed a problem that prevented input into the integer digit of a
6805 ## integerwidth=1 numctrl, if the current value was 0.
6806 ## 6. Fixed logic involving processing of "_signOk" flag, to remove default
6807 ## sign key handlers if false, so that SetAllowNegative(False) in the
6808 ## NumCtrl works properly.
6809 ## 7. Fixed selection logic for numeric controls so that if selectOnFieldEntry
6810 ## is true, and the integer portion of an integer format control is selected
6811 ## and the sign position is selected, the sign keys will always result in a
6812 ## negative value, rather than toggling the previous sign.
6816 ## 1. Fixed bug involving incorrect variable name, causing combobox autocomplete to fail.
6817 ## 2. Added proper support for unicode version of wxPython
6818 ## 3. Added * as mask char meaning "all ansi chars" (ordinals 32-255).
6819 ## 4. Converted doc strings to use reST format, for ePyDoc documentation.
6820 ## 5. Renamed helper functions, classes, etc. not intended to be visible in public
6821 ## interface to code.
6824 ## 1. Fixed intra-right-insert-field erase, such that it doesn't leave a hole, but instead
6825 ## shifts the text to the left accordingly.
6826 ## 2. Fixed _SetValue() to place cursor after last character inserted, rather than end of
6828 ## 3. Fixed some incorrect undo behavior for right-insert fields, and allowed derived classes
6829 ## (eg. numctrl) to pass modified values for undo processing (to handle/ignore grouping
6831 ## 4. Fixed autoselect behavior to work similarly to (2) above, so that combobox
6832 ## selection will only select the non-empty text, as per request.
6833 ## 5. Fixed tabbing to work with 2.5.2 semantics.
6834 ## 6. Fixed size calculation to handle changing fonts
6837 ## 1. Reorganized masked controls into separate package, renamed things accordingly
6838 ## 2. Split actual controls out of this file into their own files.
6840 ## (Reported) bugs fixed:
6841 ## 1. Crash ensues if you attempt to change the mask of a read-only
6842 ## MaskedComboBox after initial construction.
6843 ## 2. Changed strategy of defining Get/Set property functions so that
6844 ## these are now generated dynamically at runtime, rather than as
6845 ## part of the class definition. (This makes it possible to have
6846 ## more general base classes that have many more options for configuration
6847 ## without requiring that derivations support the same options.)
6848 ## 3. Fixed IsModified for _Paste() and _OnErase().
6851 ## 1. Fixed "attribute function inheritance," since base control is more
6852 ## generic than subsequent derivations, not all property functions of a
6853 ## generic control should be exposed in those derivations. New strategy
6854 ## uses base control classes (eg. BaseMaskedTextCtrl) that should be
6855 ## used to derive new class types, and mixed with their own mixins to
6856 ## only expose those attributes from the generic masked controls that
6857 ## make sense for the derivation. (This makes Boa happier.)
6858 ## 2. Renamed (with b-c) MILTIME autoformats to 24HRTIME, so as to be less
6862 ## (Reported) bugs fixed:
6863 ## 1. Right-click menu allowed "cut" operation that destroyed mask
6864 ## (was implemented by base control)
6865 ## 2. MaskedComboBox didn't allow .Append() of mixed-case values; all
6866 ## got converted to lower case.
6867 ## 3. MaskedComboBox selection didn't deal with spaces in values
6868 ## properly when autocompleting, and didn't have a concept of "next"
6869 ## match for handling choice list duplicates.
6870 ## 4. Size of MaskedComboBox was always default.
6871 ## 5. Email address regexp allowed some "non-standard" things, and wasn't
6873 ## 6. Couldn't easily reset MaskedComboBox contents programmatically.
6874 ## 7. Couldn't set emptyInvalid during construction.
6875 ## 8. Under some versions of wxPython, readonly comboboxes can apparently
6876 ## return a GetInsertionPoint() result (655535), causing masked control
6878 ## 9. Specifying an empty mask caused the controls to traceback.
6879 ## 10. Can't specify float ranges for validRange.
6880 ## 11. '.' from within a the static portion of a restricted IP address
6881 ## destroyed the mask from that point rightward; tab when cursor is
6882 ## before 1st field takes cursor past that field.
6885 ## 12. Added Ctrl-Z/Undo handling, (and implemented context-menu properly.)
6886 ## 13. Added auto-select option on char input for masked controls with
6888 ## 14. Added '>' formatcode, allowing insert within a given or each field
6889 ## as appropriate, rather than requiring "overwrite". This makes single
6890 ## field controls that just have validation rules (eg. EMAIL) much more
6891 ## friendly. The same flag controls left shift when deleting vs just
6892 ## blanking the value, and for right-insert fields, allows right-insert
6893 ## at any non-blank (non-sign) position in the field.
6894 ## 15. Added option to use to indicate negative values for numeric controls.
6895 ## 16. Improved OnFocus handling of numeric controls.
6896 ## 17. Enhanced Home/End processing to allow operation on a field level,
6898 ## 18. Added individual Get/Set functions for control parameters, for
6899 ## simplified integration with Boa Constructor.
6900 ## 19. Standardized "Colour" parameter names to match wxPython, with
6901 ## non-british spellings still supported for backward-compatibility.
6902 ## 20. Added '&' mask specification character for punctuation only (no letters
6904 ## 21. Added (in a separate file) wx.MaskedCtrl() factory function to provide
6905 ## unified interface to the masked edit subclasses.
6909 ## 1. Made it possible to configure grouping, decimal and shift-decimal characters,
6910 ## to make controls more usable internationally.
6911 ## 2. Added code to smart "adjust" value strings presented to .SetValue()
6912 ## for right-aligned numeric format controls if they are shorter than
6913 ## than the control width, prepending the missing portion, prepending control
6914 ## template left substring for the missing characters, so that setting
6915 ## numeric values is easier.
6916 ## 3. Renamed SetMaskParameters SetCtrlParameters() (with old name preserved
6917 ## for b-c), as this makes more sense.
6920 ## 1. Fixed .SetValue() to replace the current value, rather than the current
6921 ## selection. Also changed it to generate ValueError if presented with
6922 ## either a value which doesn't follow the format or won't fit. Also made
6923 ## set value adjust numeric and date controls as if user entered the value.
6924 ## Expanded doc explaining how SetValue() works.
6925 ## 2. Fixed EUDATE* autoformats, fixed IsDateType mask list, and added ability to
6926 ## use 3-char months for dates, and EUDATETIME, and EUDATEMILTIME autoformats.
6927 ## 3. Made all date autoformats automatically pick implied "datestyle".
6928 ## 4. Added IsModified override, since base wx.TextCtrl never reports modified if
6929 ## .SetValue used to change the value, which is what the masked edit controls
6931 ## 5. Fixed bug in date position adjustment on 2 to 4 digit date conversion when
6932 ## using tab to "leave field" and auto-adjust.
6933 ## 6. Fixed bug in _isCharAllowed() for negative number insertion on pastes,
6934 ## and bug in ._Paste() that didn't account for signs in signed masks either.
6935 ## 7. Fixed issues with _adjustPos for right-insert fields causing improper
6936 ## selection/replacement of values
6937 ## 8. Fixed _OnHome handler to properly handle extending current selection to
6938 ## beginning of control.
6939 ## 9. Exposed all (valid) autoformats to demo, binding descriptions to
6941 ## 10. Fixed a couple of bugs in email regexp.
6942 ## 11. Made maskchardict an instance var, to make mask chars to be more
6943 ## amenable to international use.
6944 ## 12. Clarified meaning of '-' formatcode in doc.
6945 ## 13. Fixed a couple of coding bugs being flagged by Python2.1.
6946 ## 14. Fixed several issues with sign positioning, erasure and validity
6947 ## checking for "numeric" masked controls.
6948 ## 15. Added validation to IpAddrCtrl.SetValue().
6951 ## 1. Changed calling interface to use boolean "useFixedWidthFont" (True by default)
6952 ## vs. literal font facename, and use wxTELETYPE as the font family
6954 ## 2. Switched to use of dbg module vs. locally defined version.
6955 ## 3. Revamped entire control structure to use Field classes to hold constraint
6956 ## and formatting data, to make code more hierarchical, allow for more
6957 ## sophisticated masked edit construction.
6958 ## 4. Better strategy for managing options, and better validation on keywords.
6959 ## 5. Added 'V' format code, which requires that in order for a character
6960 ## to be accepted, it must result in a string that passes the validRegex.
6961 ## 6. Added 'S' format code which means "select entire field when navigating
6963 ## 7. Added 'r' format code to allow "right-insert" fields. (implies 'R'--right-alignment)
6964 ## 8. Added '<' format code to allow fields to require explicit cursor movement
6966 ## 9. Added validFunc option to other validation mechanisms, that allows derived
6967 ## classes to add dynamic validation constraints to the control.
6968 ## 10. Fixed bug in validatePaste code causing possible IndexErrors, and also
6969 ## fixed failure to obey case conversion codes when pasting.
6970 ## 11. Implemented '0' (zero-pad) formatting code, as it wasn't being done anywhere...
6971 ## 12. Removed condition from OnDecimalPoint, so that it always truncates right on '.'
6972 ## 13. Enhanced IpAddrCtrl to use right-insert fields, selection on field traversal,
6973 ## individual field validation to prevent field values > 255, and require explicit
6974 ## tab/. to change fields.
6975 ## 14. Added handler for left double-click to select field under cursor.
6976 ## 15. Fixed handling for "Read-only" styles.
6977 ## 16. Separated signedForegroundColor from 'R' style, and added foregroundColor
6978 ## attribute, for more consistent and controllable coloring.
6979 ## 17. Added retainFieldValidation parameter, allowing top-level constraints
6980 ## such as "validRequired" to be set independently of field-level equivalent.
6981 ## (needed in TimeCtrl for bounds constraints.)
6982 ## 18. Refactored code a bit, cleaned up and commented code more heavily, fixed
6983 ## some of the logic for setting/resetting parameters, eg. fillChar, defaultValue,
6985 ## 19. Fixed maskchar setting for upper/lowercase, to work in all locales.
6989 ## 1. Decimal point behavior restored for decimal and integer type controls:
6990 ## decimal point now trucates the portion > 0.
6991 ## 2. Return key now works like the tab character and moves to the next field,
6992 ## provided no default button is set for the form panel on which the control
6994 ## 3. Support added in _FindField() for subclasses controls (like timecontrol)
6995 ## to determine where the current insertion point is within the mask (i.e.
6996 ## which sub-'field'). See method documentation for more info and examples.
6997 ## 4. Added Field class and support for all constraints to be field-specific
6998 ## in addition to being globally settable for the control.
6999 ## Choices for each field are validated for length and pastability into
7000 ## the field in question, raising ValueError if not appropriate for the control.
7001 ## Also added selective additional validation based on individual field constraints.
7002 ## By default, SHIFT-WXK_DOWN, SHIFT-WXK_UP, WXK_PRIOR and WXK_NEXT all
7003 ## auto-complete fields with choice lists, supplying the 1st entry in
7004 ## the choice list if the field is empty, and cycling through the list in
7005 ## the appropriate direction if already a match. WXK_DOWN will also auto-
7006 ## complete if the field is partially completed and a match can be made.
7007 ## SHIFT-WXK_UP/DOWN will also take you to the next field after any
7008 ## auto-completion performed.
7009 ## 5. Added autoCompleteKeycodes=[] parameters for allowing further
7010 ## customization of the control. Any keycode supplied as a member
7011 ## of the _autoCompleteKeycodes list will be treated like WXK_NEXT. If
7012 ## requireFieldChoice is set, then a valid value from each non-empty
7013 ## choice list will be required for the value of the control to validate.
7014 ## 6. Fixed "auto-sizing" to be relative to the font actually used, rather
7015 ## than making assumptions about character width.
7016 ## 7. Fixed GetMaskParameter(), which was non-functional in previous version.
7017 ## 8. Fixed exceptions raised to provide info on which control had the error.
7018 ## 9. Fixed bug in choice management of MaskedComboBox.
7019 ## 10. Fixed bug in IpAddrCtrl causing traceback if field value was of
7020 ## the form '# #'. Modified control code for IpAddrCtrl so that '.'
7021 ## in the middle of a field clips the rest of that field, similar to
7022 ## decimal and integer controls.
7026 ## 1. "-" is a toggle for sign; "+" now changes - signed numerics to positive.
7027 ## 2. ',' in formatcodes now causes numeric values to be comma-delimited (e.g.333,333).
7028 ## 3. New support for selecting text within the control.(thanks Will Sadkin!)
7029 ## Shift-End and Shift-Home now select text as you would expect
7030 ## Control-Shift-End selects to the end of the mask string, even if value not entered.
7031 ## Control-A selects all *entered* text, Shift-Control-A selects everything in the control.
7032 ## 4. event.Skip() added to onKillFocus to correct remnants when running in Linux (contributed-
7033 ## for some reason I couldn't find the original email but thanks!!!)
7034 ## 5. All major key-handling code moved to their own methods for easier subclassing: OnHome,
7035 ## OnErase, OnEnd, OnCtrl_X, OnCtrl_A, etc.
7036 ## 6. Email and autoformat validations corrected using regex provided by Will Sadkin (thanks!).
7037 ## (The rest of the changes in this version were done by Will Sadkin with permission from Jeff...)
7038 ## 7. New mechanism for replacing default behavior for any given key, using
7039 ## ._SetKeycodeHandler(keycode, func) and ._SetKeyHandler(char, func) now available
7040 ## for easier subclassing of the control.
7041 ## 8. Reworked the delete logic, cut, paste and select/replace logic, as well as some bugs
7042 ## with insertion point/selection modification. Changed Ctrl-X to use standard "cut"
7043 ## semantics, erasing the selection, rather than erasing the entire control.
7044 ## 9. Added option for an "default value" (ie. the template) for use when a single fillChar
7045 ## is not desired in every position. Added IsDefault() function to mean "does the value
7046 ## equal the template?" and modified .IsEmpty() to mean "do all of the editable
7047 ## positions in the template == the fillChar?"
7048 ## 10. Extracted mask logic into mixin, so we can have both MaskedTextCtrl and MaskedComboBox,
7050 ## 11. MaskedComboBox now adds the capability to validate from list of valid values.
7051 ## Example: City validates against list of cities, or zip vs zip code list.
7052 ## 12. Fixed oversight in EVT_TEXT handler that prevented the events from being
7053 ## passed to the next handler in the event chain, causing updates to the
7054 ## control to be invisible to the parent code.
7055 ## 13. Added IPADDR autoformat code, and subclass IpAddrCtrl for controlling tabbing within
7056 ## the control, that auto-reformats as you move between cells.
7057 ## 14. Mask characters [A,a,X,#] can now appear in the format string as literals, by using '\'.
7058 ## 15. It is now possible to specify repeating masks, e.g. #{3}-#{3}-#{14}
7059 ## 16. Fixed major bugs in date validation, due to the fact that
7060 ## wxDateTime.ParseDate is too liberal, and will accept any form that
7061 ## makes any kind of sense, regardless of the datestyle you specified
7062 ## for the control. Unfortunately, the strategy used to fix it only
7063 ## works for versions of wxPython post 2.3.3.1, as a C++ assert box
7064 ## seems to show up on an invalid date otherwise, instead of a catchable
7066 ## 17. Enhanced date adjustment to automatically adjust heuristic based on
7067 ## current year, making last century/this century determination on
7068 ## 2-digit year based on distance between today's year and value;
7069 ## if > 50 year separation, assume last century (and don't assume last
7070 ## century is 20th.)
7071 ## 18. Added autoformats and support for including HHMMSS as well as HHMM for
7072 ## date times, and added similar time, and militaray time autoformats.
7073 ## 19. Enhanced tabbing logic so that tab takes you to the next field if the
7074 ## control is a multi-field control.
7075 ## 20. Added stub method called whenever the control "changes fields", that
7076 ## can be overridden by subclasses (eg. IpAddrCtrl.)
7077 ## 21. Changed a lot of code to be more functionally-oriented so side-effects
7078 ## aren't as problematic when maintaining code and/or adding features.
7079 ## Eg: IsValid() now does not have side-effects; it merely reflects the
7080 ## validity of the value of the control; to determine validity AND recolor
7081 ## the control, _CheckValid() should be used with a value argument of None.
7082 ## Similarly, made most reformatting function take an optional candidate value
7083 ## rather than just using the current value of the control, and only
7084 ## have them change the value of the control if a candidate is not specified.
7085 ## In this way, you can do validation *before* changing the control.
7086 ## 22. Changed validRequired to mean "disallow chars that result in invalid
7087 ## value." (Old meaning now represented by emptyInvalid.) (This was
7088 ## possible once I'd made the changes in (19) above.)
7089 ## 23. Added .SetMaskParameters and .GetMaskParameter methods, so they
7090 ## can be set/modified/retrieved after construction. Removed individual
7091 ## parameter setting functions, in favor of this mechanism, so that
7092 ## all adjustment of the control based on changing parameter values can
7093 ## be handled in one place with unified mechanism.
7094 ## 24. Did a *lot* of testing and fixing re: numeric values. Added ability
7095 ## to type "grouping char" (ie. ',') and validate as appropriate.
7096 ## 25. Fixed ZIPPLUS4 to allow either 5 or 4, but if > 5 must be 9.
7097 ## 26. Fixed assumption about "decimal or integer" masks so that they're only
7098 ## made iff there's no validRegex associated with the field. (This
7099 ## is so things like zipcodes which look like integers can have more
7100 ## restrictive validation (ie. must be 5 digits.)
7101 ## 27. Added a ton more doc strings to explain use and derivation requirements
7102 ## and did regularization of the naming conventions.
7103 ## 28. Fixed a range bug in _adjustKey preventing z from being handled properly.
7104 ## 29. Changed behavior of '.' (and shift-.) in numeric controls to move to
7105 ## reformat the value and move the next field as appropriate. (shift-'.',
7106 ## ie. '>' moves to the previous field.
7109 ## 1. Fixed regex bug that caused autoformat AGE to invalidate any age ending
7111 ## 2. New format character 'D' to trigger date type. If the user enters 2 digits in the
7112 ## year position, the control will expand the value to four digits, using numerals below
7113 ## 50 as 21st century (20+nn) and less than 50 as 20th century (19+nn).
7114 ## Also, new optional parameter datestyle = set to one of {MDY|DMY|YDM}
7115 ## 3. revalid parameter renamed validRegex to conform to standard for all validation
7116 ## parameters (see 2 new ones below).
7117 ## 4. New optional init parameter = validRange. Used only for int/dec (numeric) types.
7118 ## Allows the developer to specify a valid low/high range of values.
7119 ## 5. New optional init parameter = validList. Used for character types. Allows developer
7120 ## to send a list of values to the control to be used for specific validation.
7121 ## See the Last Name Only example - it is list restricted to Smith/Jones/Williams.
7122 ## 6. Date type fields now use wxDateTime's parser to validate the date and time.
7123 ## This works MUCH better than my kludgy regex!! Thanks to Robin Dunn for pointing
7124 ## me toward this solution!
7125 ## 7. Date fields now automatically expand 2-digit years when it can. For example,
7126 ## if the user types "03/10/67", then "67" will auto-expand to "1967". If a two-year
7127 ## date is entered it will be expanded in any case when the user tabs out of the
7129 ## 8. New class functions: SetValidBackgroundColor, SetInvalidBackgroundColor, SetEmptyBackgroundColor,
7130 ## SetSignedForeColor allow accessto override default class coloring behavior.
7131 ## 9. Documentation updated and improved.
7132 ## 10. Demo - page 2 is now a wxFrame class instead of a wxPyApp class. Works better.
7133 ## Two new options (checkboxes) - test highlight empty and disallow empty.
7134 ## 11. Home and End now work more intuitively, moving to the first and last user-entry
7135 ## value, respectively.
7136 ## 12. New class function: SetRequired(bool). Sets the control's entry required flag
7137 ## (i.e. disallow empty values if True).
7140 ## 1. get_plainValue method renamed to GetPlainValue following the wxWindows
7141 ## StudlyCaps(tm) standard (thanks Paul Moore). ;)
7142 ## 2. New format code 'F' causes the control to auto-fit (auto-size) itself
7143 ## based on the length of the mask template.
7144 ## 3. Class now supports "autoformat" codes. These can be passed to the class
7145 ## on instantiation using the parameter autoformat="code". If the code is in
7146 ## the dictionary, it will self set the mask, formatting, and validation string.
7147 ## I have included a number of samples, but I am hoping that someone out there
7148 ## can help me to define a whole bunch more.
7149 ## 4. I have added a second page to the demo (as well as a second demo class, test2)
7150 ## to showcase how autoformats work. The way they self-format and self-size is,
7151 ## I must say, pretty cool.
7152 ## 5. Comments added and some internal cosmetic revisions re: matching the code
7153 ## standards for class submission.
7154 ## 6. Regex validation is now done in real time - field turns yellow immediately
7155 ## and stays yellow until the entered value is valid
7156 ## 7. Cursor now skips over template characters in a more intuitive way (before the
7158 ## 8. Change, Keypress and LostFocus methods added for convenience of subclasses.
7159 ## Developer may use these methods which will be called after EVT_TEXT, EVT_CHAR,
7160 ## and EVT_KILL_FOCUS, respectively.
7161 ## 9. Decimal and numeric handlers have been rewritten and now work more intuitively.
7164 ## 1. New .IsEmpty() method returns True if the control's value is equal to the
7165 ## blank template string
7166 ## 2. Control now supports a new init parameter: revalid. Pass a regular expression
7167 ## that the value will have to match when the control loses focus. If invalid,
7168 ## the control's BackgroundColor will turn yellow, and an internal flag is set (see next).
7169 ## 3. Demo now shows revalid functionality. Try entering a partial value, such as a
7170 ## partial social security number.
7171 ## 4. New .IsValid() value returns True if the control is empty, or if the value matches
7172 ## the revalid expression. If not, .IsValid() returns False.
7173 ## 5. Decimal values now collapse to decimal with '.00' on losefocus if the user never
7174 ## presses the decimal point.
7175 ## 6. Cursor now goes to the beginning of the field if the user clicks in an
7176 ## "empty" field intead of leaving the insertion point in the middle of the
7178 ## 7. New "N" mask type includes upper and lower chars plus digits. a-zA-Z0-9.
7179 ## 8. New formatcodes init parameter replaces other init params and adds functions.
7180 ## String passed to control on init controls:
7184 ## R Show negative #s in red
7186 ## - Signed numerals
7187 ## 0 Numeric fields get leading zeros
7188 ## 9. Ctrl-X in any field clears the current value.
7189 ## 10. Code refactored and made more modular (esp in OnChar method). Should be more
7190 ## easy to read and understand.
7191 ## 11. Demo enhanced.
7192 ## 12. Now has _doc_.
7195 ## 1. GetPlainValue() now returns the value without the template characters;
7196 ## so, for example, a social security number (123-33-1212) would return as
7197 ## 123331212; also removes white spaces from numeric/decimal values, so
7198 ## "- 955.32" is returned "-955.32". Press ctrl-S to see the plain value.
7199 ## 2. Press '.' in an integer style masked control and truncate any trailing digits.
7200 ## 3. Code moderately refactored. Internal names improved for clarity. Additional
7201 ## internal documentation.
7202 ## 4. Home and End keys now supported to move cursor to beginning or end of field.
7203 ## 5. Un-signed integers and decimals now supported.
7204 ## 6. Cosmetic improvements to the demo.
7205 ## 7. Class renamed to MaskedTextCtrl.
7206 ## 8. Can now specify include characters that will override the basic
7207 ## controls: for example, includeChars = "@." for email addresses
7208 ## 9. Added mask character 'C' -> allow any upper or lowercase character
7209 ## 10. .SetSignColor(str:color) sets the foreground color for negative values
7210 ## in signed controls (defaults to red)
7211 ## 11. Overview documentation written.
7214 ## 1. Tab now works properly when pressed in last position
7215 ## 2. Decimal types now work (e.g. #####.##)
7216 ## 3. Signed decimal or numeric values supported (i.e. negative numbers)
7217 ## 4. Negative decimal or numeric values now can show in red.
7218 ## 5. Can now specify an "exclude list" with the excludeChars parameter.
7219 ## See date/time formatted example - you can only enter A or P in the
7220 ## character mask space (i.e. AM/PM).
7221 ## 6. Backspace now works properly, including clearing data from a selected
7222 ## region but leaving template characters intact. Also delete key.
7223 ## 7. Left/right arrows now work properly.
7224 ## 8. Removed EventManager call from test so demo should work with wxPython 2.3.3
projects / wxWidgets.git / blob