Class dColumn

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

Color for the background of each cell in the column.

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

Base key used when saving/restoring preferences  (str)

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)

Specifies the caption displayed in this column's header.

Color for the background of the current cell in the column.

Specifies whether the current cell's font is bold-faced.

Color for the foreground (text) of the current cell in the column.

List of child objects.

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

Return our column index in the grid, or -1.

Custom Editor class for this column. Default: None.

Set this to override the default editor class, which Dabo will
select based on the data type of the field.

Dictionary of custom editors for this column. Default: {}.

Set this to override the default editor class on a row-by-row basis.
If there is no custom editor class for a given row in CustomEditors,
the CustomEditor property setting will apply.

Dictionary of custom list choices for this column. Default: {}.

Set this to override the default list choices on a row-by-row basis.
If there is no custom entry for a given row in CustomListEditorChoices,
the ListEditorChoices property setting will apply.

Custom Renderer class for this column. Default: None.

Set this to override the default renderer class, which Dabo will select based
on the data type of the field.

Dictionary of custom renderers for this column. Default: {}.

Set this to override the default renderer class on a row-by-row basis.
If there is no custom renderer for a given row in CustomRenderers, the
CustomRendererClass property setting will apply.

Field key in the data set to which this column is bound.  (str)

Description of the data type for this column  (str)

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 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 CellBackColor 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
CellBackColor property. If DynamicCellBackColor is set to None (the default), CellBackColor
will not be dynamically evaluated.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dynamically determine the value of the VerticalAlignment 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
VerticalAlignment property. If DynamicVerticalAlignment is set to None (the default), VerticalAlignment
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.

If True, and if the grid is set as Editable, the cell values in this
column are editable by the user. If False, the cells in this column
cannot be edited no matter what the grid setting is. When editable,
incremental searching will not be enabled, regardless of the
Searchable property setting.  (bool)

Returns the editor class used for cells in the column. This
will be self.CustomEditorClass if set, or the default editor for the
datatype of the field.  (varies)

Does this column expand/shrink as the grid width changes?
Default=False  (bool)

The font properties of the column's cells. (dFont)

Specifies if the cell font (for all cells in the column) is bold-faced. (bool)

Human-readable description of the column's cell font settings. (str)

Specifies the font face for the column cells. (str)

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

Specifies whether the column's cell font is italicized. (bool)

Specifies the point size of the column's cell font. (int)

Specifies whether cell text is underlined. (bool)

Color for the foreground (text) of each cell in the column.

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

Optional color for the background of the column header  (str)

The font properties of the column's header. (dFont)

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

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

Specifies the font face for the column header. (str)

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

Specifies whether the header font is italicized. (bool)

Specifies the point size of the header font. (int)

Specifies whether column header text is underlined. (bool)

Optional color for the foreground (text) of the column header  (str)

Specifies the horizontal alignment of the header caption. ('Left', 'Center', 'Right')

Specifies the vertical alignment of the header caption. ('Top', 'Center', 'Bottom')

Horizontal alignment for all cells in this column. (str)
Acceptable values are:
	'Automatic': The cell's contents will align right for numeric data, left for text. (default)
	'Left'
	'Center'
	'Right' 

Specifies the list of choices that will appear in the list. Only applies
if the DataType is set as "list".  (list)

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

Specifies whether this column is movable by the user.

Note also the dGrid.MovableColumns property - if that is set
to False, columns will not be movable even if their Movable
property is set to True.

The name of the object.  (str)

Order of this column. Columns in the grid are arranged according
to their relative Order. (int)

The containing object.  (obj)

Number of decimal places to display for float values  (int)

Reference to the Preference Management object  (dPref)

Returns the renderer class used for cells in the column. This will be
self.CustomRendererClass if set, or the default renderer class for the
datatype of the field.  (varies)

Specifies whether this column is resizable by the user.

Note also the dGrid.ResizableColumns property - if that is set
to False, columns will not be resizable even if their Resizable
property is set to True.

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)

Specifies whether this column's incremental search is enabled.
Default: True. The grid's Searchable property will override this setting.
(bool)

Specifies whether this column can be sorted. Default: True. The grid's
Sortable property will override this setting.  (bool)

Returns the current value of the column from the underlying dataset or bizobj.

Vertical alignment for all cells in this column. Acceptable values
are 'Top', 'Center', and 'Bottom'.  (str)

Controls whether the column is shown or not  (bool)

Width of this column  (int)

When True, text longer than the column width will wrap to the next line  (bool)

Create an instance of classRef, and make it a child of self.

Abstract method: subclasses MUST override for UI-specifics.

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.

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.

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.

Abstract method: subclasses MUST override for UI-specifics.

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.

Return the fully qualified name of the object.

Return the cell editor class for the passed row.

Return the list of choices for the list editor for the given row.

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.

Return the cell renderer class for the passed row.

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)
	

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.

Send the event to all registered listeners.

If uiEvent is sent, dEvents.Event will be able to parse it for useful
information to send along to the callback. 

Additional arguments, if any, are sent along to the constructor	of the
event. While this feature exists so that UI-lib event handlers can pass
along information (such as the keystroke information in a key event), user
code may pass along additional arguments as well, which	will exist in the
event.EventData dictionary property.

In most cases, user code should call raiseEvent() with
the event class (dEvents.Hit, for example) as the only parameter.

Abstract method: subclasses MUST override for UI-specifics.

Abstract method.

Usually don't need this, but it helps to keep this in
line with other Dabo objects.

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.

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.