New API reference documentation is available for testing at http://thewinecellarbook.com/daboDocTestAlt/. Please report any problems or suggestions on the dabo-users mailing list.

Class dDateTextBox

This is a specialized textbox class designed to work with date values.
It provides handy shortcut keystrokes so that users can quickly navigate
to the date value they need. The keystrokes are the same as those used
by Quicken, the popular personal finance program.

Properties

[Dynamic]Alignment Application [Dynamic]BackColor
BaseClass BasePrefKey [Dynamic]BorderColor
[Dynamic]BorderLineStyle [Dynamic]BorderStyle [Dynamic]BorderWidth
Bottom [Dynamic]Caption Children
Class ControllingSizer ControllingSizerItem
DataField DataSource DisableOnEmptyDataSource
DroppedFileHandler DroppedTextHandler [Dynamic]Enabled
ExtendedCalendar [Dynamic]Font [Dynamic]FontBold
FontDescription [Dynamic]FontFace FontInfo
[Dynamic]FontItalic [Dynamic]FontSize [Dynamic]FontUnderline
ForceCase [Dynamic]ForeColor Form
[Dynamic]Height HelpContextText Hover
[Dynamic]InsertionPosition IsSecret [Dynamic]Left
LogEvents MaximumHeight MaximumSize
MaximumWidth MinimumHeight MinimumSize
MinimumWidth [Dynamic]MousePointer Name
NameBase NoneDisplay NumericBlankToZero
Parent [Dynamic]PasswordEntry PersistSecretData
[Dynamic]Position PreferenceManager [Dynamic]ReadOnly
RegID Right SaveRestoreValue
[Dynamic]SelectOnEntry SelectedText [Dynamic]SelectionEnd
[Dynamic]SelectionLength [Dynamic]SelectionStart [Dynamic]Size
Sizer Source [Dynamic]StatusText
[Dynamic]StrictDateEntry StrictNumericEntry TabStop
[Dynamic]Tag TextLength [Dynamic]ToolTipText
[Dynamic]Top [Dynamic]Transparency TransparencyDelay
[Dynamic]Value [Dynamic]Visible VisibleOnScreen
[Dynamic]Width WindowHandle

Events

BackgroundErased Create Destroy
FontPropertiesChanged GotFocus Hit
Idle InteractiveChange KeyChar
KeyDown KeyEvent KeyUp
LostFocus MenuClose MenuOpen
MouseEnter MouseEvent MouseLeave
MouseLeftClick MouseLeftDoubleClick MouseLeftDown
MouseLeftUp MouseMiddleClick MouseMiddleDoubleClick
MouseMiddleDown MouseMiddleUp MouseMove
MouseRightClick MouseRightDoubleClick MouseRightDown
MouseRightUp MouseWheel Move
Paint Resize TreeBeginDrag
TreeEndDrag Update ValueChanged

Methods

absoluteCoordinates addObject adjustDate
afterInit afterInitAll afterSetProperties
autoBindEvents beforeInit beforeSetProperties
bindEvent bindEvents bindKey
bringToFront charsAfterCursor charsBeforeCursor
clear clone containerCoordinates
convertStringValueToDataType copy cut
dayInterval drawArc drawBitmap
drawCircle drawEllipse drawEllipticArc
drawGradient drawLine drawPolyLines
drawPolygon drawRectangle drawRoundedRectangle
drawText endHover fitToSizer
flushValue fontZoomIn fontZoomNormal
fontZoomOut formCoordinates getAbsoluteName
getBlankValue getCaptureBitmap getDateTuple
getDisplayLocker getMousePosition getPositionInSizer
getProperties getShortDataType getSizerProp
getSizerProps getStringValue hide
hourInterval initEvents initProperties
isContainedBy iterateCall lockDisplay
minuteInterval monthInterval moveTabOrderAfter
moveTabOrderBefore objectCoordinates onHover
paste posIsWithin processDroppedFiles
processDroppedText raiseEvent reCreate
recreate redraw refresh
relativeCoordinates release removeDrawnObject
restoreValue saveValue secondInterval
select selectAll selectNone
sendToBack setAll setDate
setFocus setPositionInSizer setProperties
setPropertiesFromAtts setSizerProp setSizerProps
setToLastMonthDay show showCalendar
showContainingPage showContextMenu unbindEvent
unbindKey unlockDisplay unlockDisplayAll
update write




Properties

Alignment
Specifies the alignment of the text. (str)
Left (default)
Center
Right

(inherited from Control)
Application
Read-only object reference to the Dabo Application object.  (dApp).

(inherited from dObject)
BackColor
Specifies the background color of the object. (str, 3-tuple, or wx.Colour)

(inherited from dPemMixin)
BaseClass
The base Dabo class of the object. Read-only.  (class)

(inherited from dObject)
BasePrefKey
Base key used when saving/restoring preferences  (str)

(inherited from dObject)
BorderColor
Specifies the color of the border drawn around the control, if any.

Default='black'  (str, 3-tuple, or wx.Colour)

(inherited from dPemMixin)
BorderLineStyle
Style of line for the border drawn around the control.

Possible choices are:
	"Solid"  (default)
	"Dash"
	"Dot"
	"DotDash"
	"DashDot"

(inherited from dPemMixin)
BorderStyle
Specifies the type of border for this window. (str).

Possible choices are:
	"None"
	"Simple"
	"Sunken"
	"Raised"
			

(inherited from dPemMixin)
BorderWidth
Width of the border drawn around the control, if any. (int)

Default=0 (no border)
			

(inherited from dPemMixin)
Bottom
The position of the bottom side of the object. This is a
convenience property, and is equivalent to setting the Top property
to this value minus the Height of the control.  (int)

(inherited from dPemMixinBase)
Caption
The caption of the object. (str)

(inherited from dPemMixin)
Children
Returns a list of object references to the children of
this object. Only applies to containers. Children will be None for
non-containers.  (list or None)

(inherited from Window)
Class
The class the object is based on. Read-only.  (class)

(inherited from dObject)
ControllingSizer
Reference to the sizer that controls this control's layout.  (dSizer)

(inherited from dPemMixin)
ControllingSizerItem
Reference to the sizer item that control's this control's layout.

This is useful for getting information about how the item is being
sized, and for changing those settings.  (SizerItem)
			

(inherited from dPemMixin)
DataField
Specifies the data field of the dataset to use as the source
of data. (str)

(inherited from dDataControlMixinBase)
DataSource
Specifies the dataset to use as the source of data.  (str)

(inherited from dDataControlMixinBase)
DisableOnEmptyDataSource
When True and the DataSource is an empty dataset (it must be a dBizobj instance),
control is disabled for interactive editing. Default=False.  (bool)

(inherited from dDataControlMixinBase)
DroppedFileHandler
Reference to the object that will handle files dropped on this control.
When files are dropped, a list of them will be passed to this object's
'processDroppedFiles()' method. Default=None  (object or None)

(inherited from dPemMixin)
DroppedTextHandler
Reference to the object that will handle text dropped on this control.
When text is dropped, that text will be passed to this object's
'processDroppedText()' method. Default=None  (object or None)

(inherited from dPemMixin)
DynamicAlignment
Dynamically determine the value of the Alignment property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Alignment property. If DynamicAlignment is set to None (the default), Alignment
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicBackColor
Dynamically determine the value of the BackColor property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
BackColor property. If DynamicBackColor is set to None (the default), BackColor
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicBorderColor
Dynamically determine the value of the BorderColor property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
BorderColor property. If DynamicBorderColor is set to None (the default), BorderColor
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicBorderLineStyle
Dynamically determine the value of the BorderLineStyle property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
BorderLineStyle property. If DynamicBorderLineStyle is set to None (the default), BorderLineStyle
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicBorderStyle
Dynamically determine the value of the BorderStyle property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
BorderStyle property. If DynamicBorderStyle is set to None (the default), BorderStyle
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicBorderWidth
Dynamically determine the value of the BorderWidth property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
BorderWidth property. If DynamicBorderWidth is set to None (the default), BorderWidth
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicCaption
Dynamically determine the value of the Caption property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Caption property. If DynamicCaption is set to None (the default), Caption
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicEnabled
Dynamically determine the value of the Enabled property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Enabled property. If DynamicEnabled is set to None (the default), Enabled
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFont
Dynamically determine the value of the Font property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Font property. If DynamicFont is set to None (the default), Font
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFontBold
Dynamically determine the value of the FontBold property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
FontBold property. If DynamicFontBold is set to None (the default), FontBold
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFontFace
Dynamically determine the value of the FontFace property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
FontFace property. If DynamicFontFace is set to None (the default), FontFace
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFontItalic
Dynamically determine the value of the FontItalic property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
FontItalic property. If DynamicFontItalic is set to None (the default), FontItalic
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFontSize
Dynamically determine the value of the FontSize property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
FontSize property. If DynamicFontSize is set to None (the default), FontSize
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicFontUnderline
Dynamically determine the value of the FontUnderline property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
FontUnderline property. If DynamicFontUnderline is set to None (the default), FontUnderline
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicForeColor
Dynamically determine the value of the ForeColor property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
ForeColor property. If DynamicForeColor is set to None (the default), ForeColor
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicHeight
Dynamically determine the value of the Height property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Height property. If DynamicHeight is set to None (the default), Height
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicInsertionPosition
Dynamically determine the value of the InsertionPosition property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
InsertionPosition property. If DynamicInsertionPosition is set to None (the default), InsertionPosition
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicLeft
Dynamically determine the value of the Left property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Left property. If DynamicLeft is set to None (the default), Left
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicMousePointer
Dynamically determine the value of the MousePointer property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
MousePointer property. If DynamicMousePointer is set to None (the default), MousePointer
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicPasswordEntry
Dynamically determine the value of the PasswordEntry property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
PasswordEntry property. If DynamicPasswordEntry is set to None (the default), PasswordEntry
will not be dynamically evaluated.

(inherited from dTextBoxMixin)
DynamicPosition
Dynamically determine the value of the Position property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Position property. If DynamicPosition is set to None (the default), Position
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicReadOnly
Dynamically determine the value of the ReadOnly property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
ReadOnly property. If DynamicReadOnly is set to None (the default), ReadOnly
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicSelectOnEntry
Dynamically determine the value of the SelectOnEntry property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
SelectOnEntry property. If DynamicSelectOnEntry is set to None (the default), SelectOnEntry
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicSelectionEnd
Dynamically determine the value of the SelectionEnd property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
SelectionEnd property. If DynamicSelectionEnd is set to None (the default), SelectionEnd
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicSelectionLength
Dynamically determine the value of the SelectionLength property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
SelectionLength property. If DynamicSelectionLength is set to None (the default), SelectionLength
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicSelectionStart
Dynamically determine the value of the SelectionStart property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
SelectionStart property. If DynamicSelectionStart is set to None (the default), SelectionStart
will not be dynamically evaluated.

(inherited from dTextBoxMixinBase)
DynamicSize
Dynamically determine the value of the Size property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Size property. If DynamicSize is set to None (the default), Size
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicStatusText
Dynamically determine the value of the StatusText property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
StatusText property. If DynamicStatusText is set to None (the default), StatusText
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicStrictDateEntry
Dynamically determine the value of the StrictDateEntry property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
StrictDateEntry property. If DynamicStrictDateEntry is set to None (the default), StrictDateEntry
will not be dynamically evaluated.

(inherited from dTextBoxMixin)
DynamicTag
Dynamically determine the value of the Tag property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Tag property. If DynamicTag is set to None (the default), Tag
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicToolTipText
Dynamically determine the value of the ToolTipText property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
ToolTipText property. If DynamicToolTipText is set to None (the default), ToolTipText
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicTop
Dynamically determine the value of the Top property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Top property. If DynamicTop is set to None (the default), Top
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicTransparency
Dynamically determine the value of the Transparency property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Transparency property. If DynamicTransparency is set to None (the default), Transparency
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicValue
Dynamically determine the value of the Value property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Value property. If DynamicValue is set to None (the default), Value
will not be dynamically evaluated.

(inherited from dDataControlMixin)
DynamicVisible
Dynamically determine the value of the Visible property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Visible property. If DynamicVisible is set to None (the default), Visible
will not be dynamically evaluated.

(inherited from dPemMixin)
DynamicWidth
Dynamically determine the value of the Width property.

Specify a function and optional arguments that will get called from the
update() method. The return value of the function will get set to the
Width property. If DynamicWidth is set to None (the default), Width
will not be dynamically evaluated.

(inherited from dPemMixin)
Enabled
Specifies whether the object and children can get user input. (bool)

(inherited from Window)
ExtendedCalendar
When True, the calendar is displayed in a larger format with more controls
for quickly moving to any date. Default=False  (bool)
Font
Specifies font object for this control. (dFont)

(inherited from Window)
FontBold
Specifies if the font is bold-faced. (bool)

(inherited from dPemMixin)
FontDescription
Human-readable description of the current font settings. (str)

(inherited from dPemMixin)
FontFace
Specifies the font face. (str)

(inherited from dPemMixin)
FontInfo
Specifies the platform-native font info string. Read-only. (str)

(inherited from dPemMixin)
FontItalic
Specifies whether font is italicized. (bool)

(inherited from dPemMixin)
FontSize
Specifies the point size of the font. (int)

(inherited from dPemMixin)
FontUnderline
Specifies whether text is underlined. (bool)

(inherited from dPemMixin)
ForceCase
Determines if we change the case of entered text. Possible values are:

===========  =====================
None or ""   No changes made (default)
"Upper"      FORCE TO UPPER CASE
"Lower"      Force to lower case
"Title"      Force To Title Case
===========  =====================

			These can be abbreviated to "u", "l" or "t"  (str)

(inherited from dTextBoxMixinBase)
ForeColor
Specifies the foreground color of the object. (str, 3-tuple, or wx.Colour)

(inherited from dPemMixin)
Form
Object reference to the dForm containing the object. Read-only. (dForm).

(inherited from dPemMixinBase)
Height
Specifies the height of the object. (int)

(inherited from dPemMixin)
HelpContextText
Specifies the context-sensitive help text associated with this
window. (str)
			

(inherited from dPemMixin)
Hover
When True, Mouse Enter events fire the onHover method, and
MouseLeave events fire the endHover method  (bool)

(inherited from dPemMixin)
InsertionPosition
Position of the insertion point within the control  (int)

(inherited from dTextBoxMixinBase)
IsSecret
Flag for indicating sensitive data, such as Password field, that is not
to be persisted. Default=False.  (bool)

(inherited from dDataControlMixinBase)
Left
Specifies the left position of the object. (int)

(inherited from dPemMixin)
LogEvents
Specifies which events to log.  (list of strings)

If the first element is 'All', all events except the following listed events
will be logged.
Event logging is resource-intensive, so in addition to setting this LogEvents
property, you also need to make the following call:

	>>> dabo.eventLogging = True


(inherited from dObject)
MaximumHeight
Maximum allowable height for the control in pixels.  (int)

(inherited from dPemMixin)
MaximumSize
Maximum allowable size for the control in pixels.  (2-tuple of int)

(inherited from dPemMixin)
MaximumWidth
Maximum allowable width for the control in pixels.  (int)

(inherited from dPemMixin)
MinimumHeight
Minimum allowable height for the control in pixels.  (int)

(inherited from dPemMixin)
MinimumSize
Minimum allowable size for the control in pixels.  (2-tuple of int)

(inherited from dPemMixin)
MinimumWidth
Minimum allowable width for the control in pixels.  (int)

(inherited from dPemMixin)
MousePointer
Specifies the shape of the mouse pointer when it enters this window. (obj)

(inherited from dPemMixin)
Name
Specifies the name of the object, which must be unique among siblings.

If the specified name isn't unique, an exception will be raised. See also
NameBase, which let's you set a base name and Dabo will automatically append
integers to make it unique.

(inherited from Window)
NameBase
Specifies the base name of the object.

The base name specified will become the object's Name, unless another sibling
already has that name, in which case Dabo will find the next unique name by
adding integers to the end of the base name. For example, if your code says:

	self.NameBase = "txtAddress"

and there is already a sibling object with that name, your object will end up
with Name = "txtAddress1".

This property is write-only at runtime.

(inherited from dPemMixin)
NoneDisplay
Specifies the string displayed if Value is None  (str or None)

If None, self.Application.NoneDisplay will be used.

(inherited from dTextBoxMixinBase)
NumericBlankToZero
Specifies whether a blank textbox gets interpreted as 0.

When True, if the user clears the textbox value, such as by selecting all
and pressing the space bar or delete, the value will become 0 when the
control loses focus. 

When False, the value will revert back to the last numeric value when the 
control loses focus.

The default comes from dabo.dTextBox_NumericBlankToZero, which defaults to 
False.

(inherited from dTextBoxMixin)
Parent
The containing object. (obj)

(inherited from Window)
PasswordEntry
Specifies whether plain-text or asterisks are echoed. (bool)

(inherited from dTextBoxMixin)
PersistSecretData
If True, allow persisting the secret data in encrypted form.
Warning! Security of your data strongly depends on used encryption algorithms!
Default=False.  (bool)

(inherited from dDataControlMixinBase)
Position
The (x,y) position of the object. (tuple)

(inherited from Window)
PreferenceManager
Reference to the Preference Management object  (dPref)

(inherited from dObject)
ReadOnly
Specifies whether or not the text can be edited. (bool)

(inherited from dTextBoxMixinBase)
RegID
A unique identifier used for referencing by other objects. (str)

(inherited from dPemMixin)
Right
The position of the right side of the object. This is a
convenience property, and is equivalent to setting the Left property
to this value minus the Width of the control.  (int)

(inherited from dPemMixinBase)
SaveRestoreValue
Specifies whether the Value of the control gets saved when
destroyed and restored when created. Use when the control isn't
bound to a dataSource and you want to persist the value, as in
an options dialog. Default=False.  (bool)

(inherited from dDataControlMixinBase)
SelectOnEntry
Specifies whether all text gets selected upon receiving focus. (bool)

(inherited from dTextBoxMixinBase)
SelectedText
Currently selected text. Returns the empty string if nothing is selected  (str)

(inherited from dTextBoxMixinBase)
SelectionEnd
Position of the end of the selected text. If no text is
selected, returns the Position of the insertion cursor.  (int)

(inherited from dTextBoxMixinBase)
SelectionLength
Length of the selected text, or 0 if nothing is selected.  (int)

(inherited from dTextBoxMixinBase)
SelectionStart
Position of the beginning of the selected text. If no text is
selected, returns the Position of the insertion cursor.  (int)

(inherited from dTextBoxMixinBase)
Size
The size of the object. (tuple)

(inherited from Window)
Sizer
The sizer for the object.

(inherited from Window)
Source
Reference to the object to which this control's Value is bound  (object)

(inherited from dDataControlMixinBase)
StatusText
Specifies the text that displays in the form's status bar, if any.

The text will appear when the control gets the focus, or when the
mouse hovers over the control, and will clear when the control loses
the focus, or when the mouse is no longer hovering.

For forms, set StatusText whenever you want to display a message.

(inherited from dPemMixin)
StrictDateEntry
Specifies whether date values must be entered in strict ISO8601 format. Default=False.

If not strict, dates can be accepted in YYYYMMDD, YYMMDD, and MMDD format,
which will be coerced into sensible date values automatically.

(inherited from dTextBoxMixin)
StrictNumericEntry
When True, the DataType will be preserved across numeric types. When False, the
DataType will respond to user input to convert to the 'obvious' numeric type.
Default=True. (bool)

(inherited from dTextBoxMixin)
TabStop
Specifies whether this control can receive focus from keyboard navigation.

(inherited from dControlMixin)
Tag
A property that user code can safely use for specific purposes.

(inherited from dPemMixin)
TextLength
The maximum length the entered text can be. (int)

(inherited from dTextBoxMixinBase)
ToolTipText
Specifies the tooltip text associated with this window. (str)

(inherited from dPemMixin)
Top
The top position of the object. (int)

(inherited from dPemMixin)
Transparency
Transparency level of the control; ranges from 0 (transparent) to 255 (opaque).
Default=0. Does not currently work on Gtk/Linux.  (int)

(inherited from dPemMixin)
TransparencyDelay
Time in seconds to change transparency. Set it to zero to see instant changes.
Default=0.25 (float)

(inherited from dPemMixin)
Value
Specifies the current state of the control (the value of the field). (varies)

(inherited from TextCtrl)
Visible
Specifies whether the object is visible at runtime.  (bool)

(inherited from dPemMixin)
VisibleOnScreen
Specifies whether the object is physically visible at runtime.  (bool)

The Visible property could return True even if the object isn't actually
shown on screen, due to a parent object or sizer being invisible.

The VisibleOnScreen property will return True only if the object and all
parents are visible.

(inherited from dPemMixin)
Width
The width of the object. (int)

(inherited from dPemMixin)
WindowHandle
The platform-specific handle for the window. Read-only. (long)

(inherited from dPemMixin)



Events

BackgroundErased
Occurs when a window background has been erased and needs repainting.
Create
Occurs after the control or form is created.
Destroy
Occurs when the control or form is destroyed.
FontPropertiesChanged
Occurs when the properties of a dFont have changed.
GotFocus
Occurs when the control gets the focus.
Hit
Occurs with the control's default event (button click,
listbox pick, checkbox, etc.)
Idle
Occurs when the event loop has no active events to process.

This is a good place to put redraw or other such UI-intensive code, so that it
will only run when the application is otherwise not busy doing other (more
important) things.
InteractiveChange
Occurs when the user interactively changes the control's value.
KeyChar
Occurs when a key is depressed and released on the
focused control or form.
KeyDown
Occurs when any key is depressed on the focused control or form.
KeyEvent

		
KeyUp
Occurs when any key is released on the focused control or form.
LostFocus
Occurs when the control loses the focus.
MenuClose
Occurs when a menu has just been closed.
MenuOpen
Occurs when a menu is about to be opened.
MouseEnter
Occurs when the mouse pointer enters the form or control.
MouseEvent

		
MouseLeave
Occurs when the mouse pointer leaves the form or control.
MouseLeftClick
Occurs when the mouse's left button is depressed
and released on the control.
MouseLeftDoubleClick
Occurs when the mouse's left button is double-clicked on the control.
MouseLeftDown
Occurs when the mouse's left button is depressed on the control.
MouseLeftUp
Occurs when the mouse's left button is released on the control.
MouseMiddleClick
Occurs when the mouse mouse's middle button is depressed
and released on the control.
MouseMiddleDoubleClick
Occurs when the mouse's middle button is double-clicked
on the control.
MouseMiddleDown
Occurs when the mouse's middle button is depressed on the control.
MouseMiddleUp
Occurs when the mouse's middle button is released on the control.
MouseMove
Occurs when the mouse moves in the control.
MouseRightClick
Occurs when the mouse mouse's right button is depressed
and released on the control.
MouseRightDoubleClick
Occurs when the mouse's right button is double-clicked on the control.
MouseRightDown
Occurs when the mouse's right button is depressed on the control.
MouseRightUp
Occurs when the mouse's right button is released on the control.
MouseWheel
Occurs when the user scrolls the mouse wheel.
Move
Occurs when the control's position changes.
Paint
Occurs when it is time to paint the control.
Resize
Occurs when the control or form is resized.
TreeBeginDrag
Occurs when a drag operation begins in a tree.
TreeEndDrag
Occurs when a drag operation ends in a tree.
Update
Occurs when a container wants its controls to update
their properties.
ValueChanged
Occurs when the control's value has changed, whether
programmatically or interactively.



Methods

absoluteCoordinates(self, pos=None)
Translates a position value for a control to absolute screen position.

(inherited from dPemMixin)
addObject(self, classRef, Name=None, *args, **kwargs)
Instantiate object as a child of self.

The classRef argument must be a Dabo UI class definition. (it must inherit
dPemMixin). Alternatively, it can be a saved class definition in XML format,
as created by the Class Designer.

The name argument, if passed, will be sent along to the object's
constructor, which will attempt to set its Name accordingly. If the name
argument is not passed (or None), the object will get a default Name as
defined in the object's class definition.

Additional positional and/or keyword arguments will be sent along to the
object's constructor.

(inherited from dPemMixin)
adjustDate(self, key, ctrl=False, shift=False)
Modifies the current date value if the key is one of the
shortcut keys.
afterInit(self)
Subclass hook. Called after the object's __init__ has run fully.
Subclasses should place their __init__ code here in this hook, instead of
overriding __init__ directly, to avoid conflicting with base Dabo behavior.

(inherited from dObject)
afterInitAll(self)

			
(inherited from dPemMixin)
afterSetProperties(self)

			
(inherited from dPemMixin)
autoBindEvents(self, force=True)
Automatically bind any on*() methods to the associated event.

User code only needs to define the callback, and Dabo will automatically
set up the event binding. This will satisfy lots of common cases where
you want an object or its parent to respond to the object's events.

To use this feature, just define a method on<EventName>(), or	if you
want a parent container to respond to the event, make a method in the
parent on<EventName>_<object Name or RegID>().

For example::
	
	class MyButton(dabo.ui.dButton):
		def onHit(self, evt):
			print "Hit!"

	class MyPanel(dabo.ui.dPanel):
		def afterInit(self):
			self.addObject(MyButton, RegID="btn1")

		def onHit_btn1(self, evt):
			print "panel: button hit!"

When the button is pressed, you'll see both 'hit' messages because of
auto event binding.

If you want to bind your events explicitly, you can turn off auto event
binding by calling::

	 dabo.autoBindEvents = False

This feature is inspired by PythonCard.

(inherited from EventMixin)
beforeInit(self, *args, **kwargs)
Subclass hook. Called before the object is fully instantiated.
Usually, user code should override afterInit() instead, but there may be
cases where you need to set an attribute before the init stage is fully
underway.

(inherited from dObject)
beforeSetProperties(self, properties)

			
(inherited from dPemMixin)
bindEvent(self, eventClass, function, _auto=False)
Bind a dEvent to a callback function.

(inherited from EventMixin)
bindEvents(self, bindings)
Bind a sequence of [dEvent, callback] lists.

(inherited from EventMixin)
bindKey(self, keyCombo, callback, **kwargs)
Bind a key combination such as "ctrl+c" to a callback function.

See dKeys.keyStrings for the valid string key codes.
See dKeys.modifierStrings for the valid modifier codes.

Examples::

	# When user presses <esc>, close the form:
	form.bindKey("esc", form.Close)

	# When user presses <ctrl><alt><w>, close the form:
	form.bindKey("ctrl+alt+w", form.Close)


(inherited from dPemMixin)
bringToFront(self)
Makes this object topmost

(inherited from dPemMixin)
charsAfterCursor(self, num=None, includeSelectedText=False)
Returns the characters immediately after the current InsertionPoint,
or, if there is selected text, before the end of the current selection.
By default, it will return one character, but you can specify a greater
number to be returned.

(inherited from dTextBoxMixinBase)
charsBeforeCursor(self, num=None, includeSelectedText=False)
Returns the characters immediately before the current InsertionPoint,
or, if there is selected text, before the beginning of the current
selection. By default, it will return one character, but you can specify
a greater number to be returned. If there is selected text, and
includeSelectedText is True, this will return the string consisting of
the characters before plus the selected text.

(inherited from dTextBoxMixinBase)
clear(self)
Clears the background of custom-drawn objects.

(inherited from dPemMixin)
clone(self, obj, name=None)
Create another object just like the passed object. It assumes that the
calling object will be the container of the newly created object.

(inherited from dPemMixin)
containerCoordinates(self, cnt, pos=None)
Given a position relative to this control, return a position relative
to the specified container. If no position is passed, returns the position
of this control relative to the container.

(inherited from dPemMixin)
convertStringValueToDataType(self, strVal, dataType)
Given a string value and a type, return an appropriate value of that type.
If the value can't be converted, a ValueError will be raised.

(inherited from dTextBoxMixin)
copy(self)
Called by uiApp when the user requests a copy operation.

Return None (the default) and uiApp will try a default copy operation.
Return anything other than None and uiApp will assume that the copy
operation has been handled.

(inherited from dPemMixin)
cut(self)
Called by uiApp when the user requests a cut operation.

Return None (the default) and uiApp will try a default cut operation.
Return anything other than None and uiApp will assume that the cut
operation has been handled.

(inherited from dPemMixin)
dayInterval(self, days)
Adjusts the date by the given number of days; negative
values move backwards.
drawArc(self, xPos, yPos, rad, startAngle, endAngle, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws an arc (pie slice) of a circle centered around the specified point,
starting from 'startAngle' degrees, and sweeping counter-clockwise
until 'endAngle' is reached.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawBitmap(self, bmp, x=0, y=0, mode=None, persist=True, transparent=True, visible=True, dc=None, useDefaults=False)
Draws a bitmap on the object at the specified position.

(inherited from dPemMixin)
drawCircle(self, xPos, yPos, rad, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a circle of the specified radius around the specified point.

You can set the color and thickness of the line, as well as the
color and hatching style of the fill. Normally, when persist=True,
the circle will be re-drawn on paint events, but if you pass False,
it will be drawn once only.

A drawing object is returned, or None if persist=False. You can
'remove' the drawing by setting the Visible property of the
returned object to False. You can also manipulate the position, size,
color, and fill by changing the various properties of the object.

(inherited from dPemMixin)
drawEllipse(self, xPos, yPos, width, height, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws an ellipse contained within the rectangular space defined by
the position and size coordinates

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawEllipticArc(self, xPos, yPos, width, height, startAngle, endAngle, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws an arc (pie slice) of a ellipse contained by the specified
dimensions, starting from 'startAngle' degrees, and sweeping
counter-clockwise until 'endAngle' is reached.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawGradient(self, orientation, x=0, y=0, width=None, height=None, color1=None, color2=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a horizontal or vertical gradient on the control. Default
is to cover the entire control, although you can specify positions.
The gradient is drawn with 'color1' as the top/left color, and 'color2'
as the bottom/right color.

(inherited from dPemMixin)
drawLine(self, x1, y1, x2, y2, penColor='black', penWidth=1, fillColor=None, lineStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a line between (x1,y1) and (x2, y2).

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawPolyLines(self, points, penColor='black', penWidth=1, lineStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a series of connected line segments defined by the specified points.

The 'points' parameter should be a tuple of (x,y) pairs defining the shape. Lines
are drawn connecting the points sequentially, but a segment from the last
point to the first is not drawn, leaving an 'open' polygon. As a result, there is no
FillColor or HatchStyle defined for this.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawPolygon(self, points, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a polygon defined by the specified points.

The 'points' parameter should be a tuple of (x,y) pairs defining the
polygon.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawRectangle(self, xPos, yPos, width, height, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a rectangle of the specified size beginning at the specified
point.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawRoundedRectangle(self, xPos, yPos, width, height, radius, penColor='black', penWidth=1, fillColor=None, lineStyle=None, hatchStyle=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws a rounded rectangle of the specified size beginning at the specified
point, with the specified corner radius.

See the 'drawCircle()' method above for more details.

(inherited from dPemMixin)
drawText(self, text, x=0, y=0, angle=0, fontFace=None, fontSize=None, fontBold=None, fontItalic=None, fontUnderline=None, foreColor=None, backColor=None, mode=None, persist=True, visible=True, dc=None, useDefaults=False)
Draws text on the object at the specified position
using the specified characteristics. Any characteristics
not specified will be set to the system default.

(inherited from dPemMixin)
endHover(self, evt=None)

			
(inherited from dPemMixin)
fitToSizer(self, extraWidth=0, extraHeight=0)
Resize the control to fit the size required by its sizer.

(inherited from dPemMixin)
flushValue(self)

			
(inherited from dTextBoxMixinBase)
fontZoomIn(self, amt=1)
Zoom in on the font, by setting a higher point size.

(inherited from dPemMixinBase)
fontZoomNormal(self)
Reset the font zoom back to zero.

(inherited from dPemMixinBase)
fontZoomOut(self, amt=1)
Zoom out on the font, by setting a lower point size.

(inherited from dPemMixinBase)
formCoordinates(self, pos=None)
Given a position relative to this control, return a position relative
to the containing form. If no position is passed, returns the position
of this control relative to the form.

(inherited from dPemMixin)
getAbsoluteName(self)
Return the fully qualified name of the object.

(inherited from dObject)
getBlankValue(self)

			
(inherited from dTextBoxMixinBase)
getCaptureBitmap(self)
Return a bitmap snapshot of self as it appears in the UI at this moment.

(inherited from dPemMixin)
getDateTuple(self)

			
		
getDisplayLocker(self)
Returns an object that locks the current display when created, and
unlocks it when destroyed. This is generally safer than calling lockDisplay()
and unlockDisplay(), especially when used with callAfterInterval(), when
the unlockDisplay() calls may not all happen.

(inherited from dPemMixin)
getMousePosition(self)
Returns the current mouse position on the entire screen
relative to this object.

(inherited from dPemMixin)
getPositionInSizer(self)
Convenience method to let you call this directly on the object.

(inherited from dPemMixin)
getProperties(self, propertySequence=(), propsToSkip=(), ignoreErrors=False, *propertyArguments)
Returns a dictionary of property name/value pairs.

If a sequence of properties is passed, just those property values
will be returned. Otherwise, all property values will be returned.
The sequence of properties can be a list, tuple, or plain string
positional arguments. For instance, all of the following are
equivilent::

	print self.getProperties("Caption", "FontInfo", "Form")
	print self.getProperties(["Caption", "FontInfo", "Form"])
	t = ("Caption", "FontInfo", "Form")
	print self.getProperties(t)
	print self.getProperties(\*t)

An exception will be raised if any passed property names don't
exist, aren't actual properties, or are not readable (do not have
getter functions).

However, if an exception is raised from the property getter function,
the exception will get caught and used as the property value in the
returned property dictionary. This allows the property list to be
returned even if some properties can't be evaluated correctly by the
object yet.

(inherited from PropertyHelperMixin)
getShortDataType(self, value)

			
(inherited from dDataControlMixinBase)
getSizerProp(self, prop)
Gets the current setting for the given property from the object's
ControllingSizer. Returns None if object is not in a sizer.

(inherited from dPemMixin)
getSizerProps(self)
Returns a dict containing the object's sizer property info. The
keys are the property names, and the values are the current
values for those props.

(inherited from dPemMixin)
getStringValue(self, value)
Given a value of any data type, return a string rendition.

Used internally by _setValue and flushValue, but also exposed to subclasses
in case they need specialized behavior. The value returned from this
function will be what is displayed in the UI textbox.

(inherited from dTextBoxMixin)
hide(self)
Make the object invisible.

(inherited from dPemMixin)
hourInterval(self, hours)
Adjusts the date by the given number of hours; negative
values move backwards.
initEvents(self)
Hook for subclasses. User code should do custom event binding
here, such as::
	
	self.bindEvent(dEvents.GotFocus, self.customGotFocusHandler)
	

(inherited from dObject)
initProperties(self)
Hook for subclasses. User subclasses should set properties
here, such as::
	
	self.Name = "MyTextBox"
	self.BackColor = (192,192,192)
	

(inherited from dObject)
isContainedBy(self, obj)
Returns True if the containership hierarchy for this control
includes the passed object reference.

(inherited from dPemMixin)
iterateCall(self, funcName, *args, **kwargs)
Call the given function on this object and all of its Children. If
any object does not have the given function, no error is raised; it
is simply ignored.

(inherited from dPemMixinBase)
lockDisplay(self)
Locks the visual updates to the control.

This can significantly improve performance when many items are being
updated at once.

IMPORTANT: you must call unlockDisplay() when you are done, or your
object will never draw. unlockDisplay() must be called once for every
time lockDisplay() is called in order to resume repainting of the
control. Alternatively, you can call lockDisplay() many times, and
then call unlockDisplayAll() once when you are done.

Note that lockDisplay currently doesn't do anything on GTK.

(inherited from dPemMixin)
minuteInterval(self, minutes)
Adjusts the date by the given number of minutes; negative
values move backwards.
monthInterval(self, months)
Adjusts the date by the given number of months; negative
values move backwards.
moveTabOrderAfter(self, obj)
Moves this object's tab order after the passed obj.

(inherited from dPemMixin)
moveTabOrderBefore(self, obj)
Moves this object's tab order before the passed obj.

(inherited from dPemMixin)
objectCoordinates(self, pos=None)
Given a position relative to the form, return a position relative
to this object. If no position is passed, returns the position
of this control relative to the form.

(inherited from dPemMixin)
onHover(self, evt=None)

			
(inherited from dPemMixin)
paste(self)
Called by uiApp when the user requests a paste operation.

Return None (the default) and uiApp will try a default paste operation.
Return anything other than None and uiApp will assume that the paste
operation has been handled.

(inherited from dPemMixin)
posIsWithin(self, xpos, ypos=None)

			
(inherited from dPemMixin)
processDroppedFiles(self, filelist, x, y)
Handler for files dropped on the control. Override in your
subclass/instance for your needs .

(inherited from dPemMixin)
processDroppedText(self, txt, x, y)
Handler for text dropped on the control. Override in your
subclass/instance for your needs .

(inherited from dPemMixin)
raiseEvent(self, eventClass, nativeEvent=None, *args, **kwargs)
Raise the passed Dabo event.

(inherited from dPemMixin)
reCreate(self, child=None)
Abstract method: subclasses MUST override for UI-specifics.

(inherited from dPemMixinBase)
recreate(self, child=None)
Recreate the object.

Warning: this is experimental and is known to cause hair loss.

(inherited from dPemMixin)
redraw(self, dc)
Called when the object is (re)drawn.

This is a user subclass hook, where you should put any drawing routines
to affect the object appearance.

(inherited from dPemMixin)
refresh(self, fromRefresh=False)
Repaints this control and all contained objects.

(inherited from dPemMixin)
relativeCoordinates(self, pos=None)
Translates an absolute screen position to position value for a control.

(inherited from dPemMixin)
release(self)
Destroys the object.

(inherited from dPemMixin)
removeDrawnObject(self, obj)

			
(inherited from dPemMixin)
restoreValue(self)
Set the control's value to the value in dApp's user settings table.

(inherited from dDataControlMixinBase)
saveValue(self)
Save control's value to dApp's user settings table.

(inherited from dDataControlMixinBase)
secondInterval(self, seconds)
Adjusts the date by the given number of seconds; negative
values move backwards.
select(self, position, length)
Select all text from <position> for <length> or end of string.

(inherited from dDataControlMixin)
selectAll(self)
Each subclass must define their own selectAll method. This will
be called if SelectOnEntry is True when the control gets focus.

(inherited from dTextBoxMixinBase)
selectNone(self)
Select no text in the control.

(inherited from dDataControlMixin)
sendToBack(self)
Places this object behind all others.

(inherited from dPemMixin)
setAll(self, prop, val, recurse=True, filt=None, instancesOf=None)
Set all child object properties to the passed value.

No bad effects will happen if the property doesn't apply to a child - only
children with the property will have their property updated.

If 'recurse' is True, setAll() will be called on each child as well.

If 'filt' is not empty, only children that match the expression in 'filt'
will be affected. The expression will be evaluated assuming the child
object is prefixed to the expression. For example, if you want to only
affect objects that are instances of dButton, you'd call::

	form.setAll("FontBold", True, filt="BaseClass == dabo.ui.dButton")

If the instancesOf sequence is passed, the property will only be set if
the child object is an instance of one of the passed classes.

(inherited from dPemMixin)
setDate(self, dt)
Sets the Value to the passed date if this is holding a date value, or
sets the date portion of the Value if it is a datetime.
setFocus(self)
Sets focus to the object.

(inherited from dPemMixin)
setPositionInSizer(self, pos)
Convenience method to let you call this directly on the object.

(inherited from dPemMixin)
setProperties(self, propDict={}, ignoreErrors=False, **propKw)
Sets a group of properties on the object all at once.

You have the following options for sending the properties:
	
	1) Property/Value pair dictionary
	2) Keyword arguments
	3) Both

The following examples all do the same thing::

	self.setProperties(FontBold=True, ForeColor="Red")
	self.setProperties({"FontBold": True, "ForeColor": "Red"})
	self.setProperties({"FontBold": True}, ForeColor="Red")


(inherited from PropertyHelperMixin)
setPropertiesFromAtts(self, propDict={}, ignoreExtra=True, context=None)
Sets a group of properties on the object all at once. This
is different from the regular setProperties() method because
it only accepts a dict containing prop:value pairs, and it
assumes that the value is always a string. It will convert
the value to the correct type for the property, and then set
the property to that converted value. If the value needs to be evaluated
in a specific namespace, pass that as the 'context' parameter.

(inherited from PropertyHelperMixin)
setSizerProp(self, prop, val)
Tells the object's ControllingSizer to adjust the requested property.

(inherited from dPemMixin)
setSizerProps(self, propDict)
Convenience method for setting multiple sizer item properties at once. The
dict should have the property name as the key and the desired new value
as the associated value.

(inherited from dPemMixin)
setToLastMonthDay(self)

			
		
show(self)
Make the object visible.

(inherited from dPemMixin)
showCalendar(self)

			
		
showContainingPage(self)
If this object is inside of any paged control, it will force all containing
paged controls to switch to the page that contains this object.

(inherited from dPemMixin)
showContextMenu(self, menu, pos=None, release=True)
Display a context menu (popup) at the specified position.

If no position is specified, the menu will be displayed at the current
mouse position.

If release is True (the default), the menu will be released after the user
has dismissed it.

(inherited from dPemMixin)
unbindEvent(self, eventClass=None, function=None)
Remove a previously registered event binding.

Removes all registrations that exist for the given binding for this
object. If event is None, all bindings for the passed function are
removed. If function is None, all bindings for the passed event are
removed. If both event and function are None, all event bindings are
removed.

(inherited from EventMixin)
unbindKey(self, keyCombo)
Unbind a previously bound key combination.

Fail silently if the key combination didn't exist already.

(inherited from dPemMixin)
unlockDisplay(self)
Unlocks the visual updates to the control.

Use in conjunction with lockDisplay(), when you are doing lots of things
that would result in lengthy screen updates.

Since lockDisplay() may be called several times on an object, calling
unlockDisplay() will "undo" one locking call. When all locks have been
removed, repainting of the display will resume.

(inherited from dPemMixin)
unlockDisplayAll(self)
Immediately unlocks the display, no matter how many previous
lockDisplay calls have been made. Useful in a callAfterInterval()
construction to avoid flicker.

(inherited from dPemMixin)
update(self)
Update control's value to match the current value from the source.

(inherited from dDataControlMixinBase)
write(*args, **kwargs)
write(self, String text)

(inherited from TextCtrl)

Dabo 0.9.4 (rev. 7089)
9 Feb 2012 23:31:09