Home       Trees       Index       Help   
Package gnue :: Package forms :: Package input :: Package displayHandlers :: Module Checkbox :: Class Checkbox
[show private | hide private]

Type Checkbox

object --+        
         |        
EventAware --+    
             |    
    BaseCursor --+
                 |
                Checkbox

Method Summary
  __init__(self, entry, eventHandler, subEventHandler, displayMask, inputMask)
Constructor
  beginEdit(self)
Notifies the handler that it will be doing edits.
  build_display(self, value, editing)
Build the display string from the user value.
  handleToggleChkbox(self, event)
  __sanitize_value(self, value)
  __set(self, value)
  __toggle(self)
  _addText(self, event)
  _moveCursor(self, event, selecting)
Moves the cursor to the specified position optionally selecting the text.
  _moveCursorLeft(self, selecting)
  _moveCursorRight(self, selecting)
  _moveCursorToBegin(self, event, selecting)
Moves the cursor to the beginning optionally selecting the text.
  _moveCursorToEnd(self, event, selecting)
Moves the cursor to the end optionally selecting the text.
    Inherited from BaseCursor
  _autocomplete_(self, new_value, new_cursor)
Descandants can override this method to introduce autocompletion.
  _backspace(self, event)
  _delete(self, event)
  _deleteRange(self, event)
  _insertTextAt(self, event)
  _replace_text(self, event)
  _selectAll(self, event)
Select the entire text of the entry and move the cursor to the end
  _selectLeft(self, event)
Move the selection cursor to the left one unit
  _selectRight(self, event)
Move the selection cursor to the right one unit
  _selectToBegin(self, event)
Select from the current curson position to the beginning of the entry
  _selectToEnd(self, event)
Select from the current curson position to the end of the entry
  _selectWithMouse(self, event)
Select an area of text based upon the mouse
  endEdit(self)
Called when a widget loses focus or when ENTER is hit.
  generateRefreshEvent(self)
Function to emit an event that will cause forms to update the UI.
  get_tip(self)
Descendands can override this method to return a tip which will be displayed in the statusbar if neither the entry nor the field provide such a tip.
  getSelectionArea(self)
Return the selected area
  parse_display(self, display)
  setSelectionArea(self, cursor1, cursor2)
Set the selection area
  updateFieldValue(self)
Update the associated field with the current value of the display handler.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
Return repr(x)...
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self, entry, eventHandler, subEventHandler, displayMask, inputMask)
(Constructor)

Constructor
Parameters:
entry - The GFEntry instance associated with this handler
eventHandler - The
subEventHandler - The event handler this display helper will user to register it's listeners.
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor.__init__ (inherited documentation)

beginEdit(self)

Notifies the handler that it will be doing edits.

Called when a widget first gets focus. It places the display handler into edit mode, syncs the current value with the GFField associated with this display handler, and creates the string to display in the form.
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor.beginEdit (inherited documentation)

build_display(self, value, editing)

Build the display string from the user value.
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor.build_display (inherited documentation)

handleToggleChkbox(self, event)

__sanitize_value(self, value)

__set(self, value)

__toggle(self)

_addText(self, event)

Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._addText

_moveCursor(self, event, selecting=False)

Moves the cursor to the specified position optionally selecting the text.
Parameters:
event - The GFEvent making the request
selecting - Boolean indicating if text should be selected as part of the cursor move
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._moveCursor (inherited documentation)

_moveCursorLeft(self, selecting=False)

Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._moveCursorLeft

_moveCursorRight(self, selecting=False)

Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._moveCursorRight

_moveCursorToBegin(self, event, selecting=False)

Moves the cursor to the beginning optionally selecting the text.
Parameters:
event - The GFEvent making the request
selecting - Boolean indicating if text should be selected as part of the cursor move
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._moveCursorToBegin (inherited documentation)

_moveCursorToEnd(self, event, selecting=False)

Moves the cursor to the end optionally selecting the text.
Parameters:
event - The GFEvent making the request
selecting - Boolean indicating if text should be selected as part of the cursor move
Overrides:
gnue.forms.input.displayHandlers.Cursor.BaseCursor._moveCursorToEnd (inherited documentation)

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Sun Nov 30 23:03:34 2008 http://epydoc.sf.net

GNUe Home

Private API

Developer's Corner