Class dListControl

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

When True (default), all non-string values are forced to strings. When False,
attempting to use a non-string value will throw an error.  (bool)

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

The base Dabo class of the object. Read-only.  (class)

Base key used when saving/restoring preferences  (str)

Specifies the color of the border drawn around the control, if any.

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

Style of line for the border drawn around the control.

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

Specifies the type of border for this window. (str).

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

Width of the border drawn around the control, if any. (int)

Default=0 (no border)
			

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)

The caption of the object. (str)

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)

Since dListControl doesn't have the equivalent to 'Choices' as the
other item controls do, this will return an empty list and print a warning
message. (read-only) (list)

The class the object is based on. Read-only.  (class)

Number of columns in the control  (int)

Reference to the columns in the control. (read-only) (list)

Columns data alignment, the 'Left', 'Center' or 'Right' literals can be used
or their abbreviations, e.g. ('c', 'l', 'r').  (tuple of str)

Reference to the sizer that controls this control's layout.  (dSizer)

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)
			

Number of rows in the control (read-only). Alias for RowCount  (int)

Specifies the data field of the dataset to use as the source
of data. (str)

Specifies the dataset to use as the source of data.  (str)

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

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)

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)

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Dynamically determine the value of the HeaderVisible 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
HeaderVisible property. If DynamicHeaderVisible is set to None (the default), HeaderVisible
will not be dynamically evaluated.

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.

Dynamically determine the value of the HorizontalRules 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
HorizontalRules property. If DynamicHorizontalRules is set to None (the default), HorizontalRules
will not be dynamically evaluated.

Dynamically determine the value of the KeyValue 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
KeyValue property. If DynamicKeyValue is set to None (the default), KeyValue
will not be dynamically evaluated.

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.

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.

Dynamically determine the value of the MultipleSelect 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
MultipleSelect property. If DynamicMultipleSelect is set to None (the default), MultipleSelect
will not be dynamically evaluated.

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.

Dynamically determine the value of the PositionValue 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
PositionValue property. If DynamicPositionValue is set to None (the default), PositionValue
will not be dynamically evaluated.

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.

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.

Dynamically determine the value of the StringValue 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
StringValue property. If DynamicStringValue is set to None (the default), StringValue
will not be dynamically evaluated.

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.

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.

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.

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.

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.

Dynamically determine the value of the ValueColumn 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
ValueColumn property. If DynamicValueColumn is set to None (the default), ValueColumn
will not be dynamically evaluated.

Dynamically determine the value of the ValueMode 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
ValueMode property. If DynamicValueMode is set to None (the default), ValueMode
will not be dynamically evaluated.

Dynamically determine the value of the VerticalRules 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
VerticalRules property. If DynamicVerticalRules is set to None (the default), VerticalRules
will not be dynamically evaluated.

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.

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.

Specifies whether the object and children can get user input. (bool)

Designates the column to expand to fill the control when ExpandToFit is True.
Can either be an integer specifying the column number, or the string 'LAST' (default),
which will expand the rightmost column.  (int or str)

When True (default), the column designated by ExpandColumn expands to fill the width of the control.  (bool)

Specifies font object for this control. (dFont)

Specifies if the font is bold-faced. (bool)

Human-readable description of the current font settings. (str)

Specifies the font face. (str)

Specifies the platform-native font info string. Read-only. (str)

Specifies whether font is italicized. (bool)

Specifies the point size of the font. (int)

Specifies whether text is underlined. (bool)

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

Object reference to the dForm containing the object. Read-only. (dForm).

Specifies whether the header is shown or not.

Specifies the height of the object. (int)

Specifies the context-sensitive help text associated with this
window. (str)
			

Returns the index of the last hit item.

Specifies whether light rules are drawn between rows.

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

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

Specifies the key value or values of the selected item or items.
-> Type can vary. Read-write at runtime.
Returns the key value or values of the selected item(s), or selects
the item(s) with the specified KeyValue(s).	An exception will be
raised if the Keys property hasn't been set up to accomodate.

Specifies a mapping between arbitrary values and item positions.
-> Dictionary. Read-write at runtime.
The Keys property is a dictionary, where each key resolves into a
list index (position). If using keys, you should update the Keys
property whenever you update the Choices property, to make sure they
are in sync.
-> Optionally, Keys can be a list/tuple that is a 1:1 mapping of the
Choices property. So if your 3rd Choices entry is selected, KeyValue
will return the 3rd entry in the Keys property.

Returns the index of the last selected item.

Specifies the left position of the object. (int)

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

Maximum allowable height for the control in pixels.  (int)

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

Maximum allowable width for the control in pixels.  (int)

Minimum allowable height for the control in pixels.  (int)

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

Minimum allowable width for the control in pixels.  (int)

Specifies the shape of the mouse pointer when it enters this window. (obj)

Specifies whether multiple rows can be selected in the list.

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.

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.

The containing object. (obj)

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

The (x,y) position of the object. (tuple)

Specifies the position (index) of the selected item(s).
-> Integer or tuple of integers. Read-write at runtime.
Returns the current position(s), or sets the current position(s).

Reference to the Preference Management object  (dPref)

A unique identifier used for referencing by other objects. (str)

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)

Number of rows in the control (read-only).  (int)

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)

Returns a list of selected row indices.  (list of int)

The size of the object. (tuple)

The sizer for the object.

Column to be sorted when sort() is called. Default=0  (int)

Function used to sort list items when Sorted=True. Default=None,
which gives the default sorting  (callable or None)

When True (default), clicking a column header cycles the sorting on that column.  (bool)

Are the items in the control automatically sorted? Default=False.
If True, whenever the Choices property is changed, the resulting list
will be first sorted using the SortFunction property, which defaults to
None, giving a default sort order.  (bool)

Reference to the object to which this control's Value is bound  (object)

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.

Specifies the text of the selected item.
-> String or tuple of strings. Read-write at runtime.
Returns the text of the selected item(s), or selects the item(s)
with the specified text. An exception is raised if there is no
position with matching text.

Specifies whether this control can receive focus from keyboard navigation.

A property that user code can safely use for specific purposes.

Specifies the tooltip text associated with this window. (str)

The top position of the object. (int)

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

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

Returns current value (str)

The column whose text is reflected in Value (default=0).  (int)

Specifies the information that the Value property refers to.
-> String. Read-write at runtime.

============= =========================
'Position'    Value refers to the position in the choices (integer).
'String'      Value refers to the displayed string for the selection (default) (string).
'Key'         Value refers to a separate key, set using the Keys property (can vary).
============= =========================

Returns a list containing the Value of all selected rows  (list of str)

Specifies whether light rules are drawn between rows.

Specifies whether the object is visible at runtime.  (bool)

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.

The width of the object. (int)

The platform-specific handle for the window. Read-only. (long)

Occurs when a window background has been erased and needs repainting.

Occurs after the control or form is created.

Occurs when the control or form is destroyed.

Occurs when the properties of a dFont have changed.

Occurs when the control gets the focus.

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.

Occurs when the user interactively changes the control's value.

Occurs when a key is depressed and released on the
focused control or form.

Occurs when any key is depressed on the focused control or form.

Occurs when any key is released on the focused control or form.

Occurs when a selected item is deselected in a list control.

Occurs when an item is highlighted in a list control.

Occurs when the control loses the focus.

Occurs when a menu has just been closed.

Occurs when a menu is about to be opened.

Occurs when the mouse pointer enters the form or control.

Occurs when the mouse pointer leaves the form or control.

Occurs when the mouse's left button is depressed
and released on the control.

Occurs when the mouse's left button is double-clicked on the control.

Occurs when the mouse's left button is depressed on the control.

Occurs when the mouse's left button is released on the control.

Occurs when the mouse mouse's middle button is depressed
and released on the control.

Occurs when the mouse's middle button is double-clicked
on the control.

Occurs when the mouse's middle button is depressed on the control.

Occurs when the mouse's middle button is released on the control.

Occurs when the mouse moves in the control.

Occurs when the mouse mouse's right button is depressed
and released on the control.

Occurs when the mouse's right button is double-clicked on the control.

Occurs when the mouse's right button is depressed on the control.

Occurs when the mouse's right button is released on the control.

Occurs when the user scrolls the mouse wheel.

Occurs when the control's position changes.

Occurs when it is time to paint the control.

Occurs when the control or form is resized.

Occurs when a drag operation begins in a tree.

Occurs when a drag operation ends in a tree.

Occurs when a container wants its controls to update
their properties.

Occurs when the control's value has changed, whether
programmatically or interactively.

Translates a position value for a control to absolute screen position.

Add a column with the selected caption.

Adds the passed image to the control's ImageList, and maintains
a reference to it that is retrievable via the key value.

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.

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.

Appends a row with the associated text in the specified column.
If the value for tx is a list/tuple, the values will be set in the columns
starting with the passed value. If either case results in an attempt to
add to a non-existent column, it will be ignored.

Adds a new item to the end of the list

Accepts a list/tuple of data. Each element in the sequence
will be another row in the control. If the data is plain text, it
will be added in the specified column. If the data is also a
list/tuple, it will be appended into columns beginning with the
specified column.

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.

Auto-sizes the specified column.

Auto-sizes all the columns.

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.

Bind a dEvent to a callback function.

Bind a sequence of [dEvent, callback] lists.

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)

Makes this object topmost

Remove all the rows in the control.

Stub method. Only used in the list box, where there
can be multiple selections.

Create another object just like the passed object. It assumes that the
calling object will be the container of the newly created object.

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.

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.

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.

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.

Draws a bitmap on the object at the specified position.

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.

Draws an ellipse contained within the rectangular space defined by
the position and size coordinates

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

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.

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.

Draws a line between (x1,y1) and (x2, y2).

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

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.

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.

Draws a rectangle of the specified size beginning at the specified
point.

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

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.

Draws text on the object at the specified position
using the specified characteristics. Any characteristics
not specified will be set to the system default.

Resize the control to fit the size required by its sizer.

Save any changes to the underlying source field. First check to make sure
that any changes are validated.

Zoom in on the font, by setting a higher point size.

Reset the font zoom back to zero.

Zoom out on the font, by setting a lower point size.

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.

Return the fully qualified name of the object.

Return the empty value of the control.

Convenience method for getting the caption for a given column number.

Return a bitmap snapshot of self as it appears in the UI at this moment.

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.

Retrieve the data associated with the item.

Returns the index of the specified item's image in the
current image list, or -1 if no image is set for the item.

Returns the current mouse position on the entire screen
relative to this object.

Convenience method to let you call this directly on the object.

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.

Gets the current setting for the given property from the object's
ControllingSizer. Returns None if object is not in a sizer.

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.

Make the object invisible.

Hook for subclasses. User code should do custom event binding
here, such as::
	
	self.bindEvent(dEvents.GotFocus, self.customGotFocusHandler)
	

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

Inserts the item at the specified row, or at the beginning if no
row is specified. Item is inserted at the specified column, as in self.append()

Inserts a column at the specified position
with the selected caption.

Inserts a new item into the specified position.

Accepts a list/tuple of data. Each element in the sequence
will be another row in the control. If the data is plain text, it
will be inserted in the specified column at the specified row.
If the data is also a list/tuple, it will be inserted into columns
beginning with the specified column.

Returns True if the containership hierarchy for this control
includes the passed object reference.

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.

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.

Moves this object's tab order after the passed obj.

Moves this object's tab order before the passed obj.

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.

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.

Handler for files dropped on the control. Override in your
subclass/instance for your needs .

Handler for text dropped on the control. Override in your
subclass/instance for your needs .

Raise the passed Dabo event.

Abstract method: subclasses MUST override for UI-specifics.

Recreate the object.

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

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.

Repaints this control and all contained objects.

Translates an absolute screen position to position value for a control.

Destroys the object.

Remove all the rows in the control.

Removes the specified column, or the last column if
no column number is passed.

Removes the item at the specified position.

Deletes the specified row if it exists, or generates a warning
if it does not.

Resize the last column appropriately.

If the list's columns are too wide to fit within the window, we use
a horizontal scrollbar.  Otherwise, we expand the right-most column
to take up the remaining free space in the list.

This method is called automatically when the wx.ListCtrl is resized;
you can also call it yourself whenever you want the last column to
be resized appropriately (eg, when adding, removing or resizing
columns).

'minWidth' is the preferred minimum width for the last column.
        

Set the control's value to the value in dApp's user settings table.

Save control's value to dApp's user settings table.

Selects the specified row. In a MultipleSelect control, any
other selected rows remain selected.

Selects all rows in a MultipleSelect control, or generates a
warning if the control is not set to MultipleSelect.

De-selects all rows.

Selects the specified row. In a MultipleSelect control, any
other selected rows are de-selected first.

Places this object behind all others.

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.

Convenience method for setting the caption for a given column number.

Sets the width of the specified column.

Accepts a list/tuple of column headings, removes any existing columns,
and creates new columns, one for each element in the list. The current
display settings and data is preserved as much as possible: setting more
columns will result in empty columns, and setting fewer columns will
truncate the data.

Sets focus to the object.

Associate some data with the item.

Sets the specified item's image to the image corresponding
to the specified key. May also optionally pass the index of the
image in the ImageList rather than the key.

Convenience method to let you call this directly on the object.

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")

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.

Specify which column that should be autosized.  Pass either
'LAST' or the column number.  Default is 'LAST'.

Same as setting property PositionValue.

Tells the object's ControllingSizer to adjust the requested property.

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.

Make the object visible.

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.

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.

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.

Unbind a previously bound key combination.

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

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.

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

De-selects the specified row. In a MultipleSelect control, any
other selected rows remain selected.

De-selects all rows.

Update control's value to match the current value from the source.