Trees       Indices       Help   
SUE - Revision 232
Module BookmarkScript :: Class BookmarkScript
[hide private]
[frames] | no frames]

Class BookmarkScript

source code

                                  object --+        
                                           |        
AccessEngine.AEUserInterface.AEUserInterface --+    
                                               |    
                  AccessEngine.AEScript.AEScript --+
                                                   |
                                                  BookmarkScript
Defines a user interface into a collection of bookmarked AEPors.

Instance Methods [hide private]
 
init(self)
Registers tasks that can be mapped to AEInput.Gestures.		 source code
string
getName(self)
Provides the localized name of this AEScript.		 source code
string
getDescription(self)
Describe which AETier this script applies to by default.		 source code
 
_sayBookmark(self, por, **kwargs)
Speaks information about the given AEPor using an audio output device.		 source code
string
_reverseBookmarks(self, gesture)
Does a reverse lookup on bookmarks using given gesture.		 source code
 
addBookmark(self, cycle_count, gesture=None, **kwargs)
Adds a new bookmarks.		 source code
string
_reverseGotoGestures(self, gesture)
Does a reverse lookup on goto_gestures using given gesture.		 source code
 
gotoBookmark(self, gesture=None, **kwargs)
Triggers a 'pointer to por' event using the bookmarked AEPor.		 source code
 
reviewBookmark(self, cycle_count, gesture=None, **kwargs)
Reviews all bookmarks saved in the current application.		 source code
string
_reverseCompare(self, gesture)
Does a reverse lookup on bm_compare_gestures using given gesture.		 source code
 
compareBookmark(self, gesture=None, **kwargs)
Compares the position of a given bookmark to that of the current AETier.virtual_por and announces comparison information.		 source code
string
_reverseWhereAmI(self, gesture)
Does a reverse lookup on whereami_gestures using given gesture.		 source code
 
whereAmIBookmark(self, gesture=None, **kwargs)
Reports the location of the selected bookmark by announcing all control and container names in child-to-parent order.		 source code
 
regBookmarkAddGesture(self, dev=None, gesture=None, name=None, **kwargs)
Register a named 'add' bookmark gesture.		 source code
 
regBookmarkGotoGesture(self, dev=None, gesture=None, name=None, **kwargs)
Register a named 'goto' bookmark gesture.		 source code
 
regBookmarkWhereAmIGesture(self, dev=None, gesture=None, name=None, **kwargs)
Register a named 'where am i' bookmark gesture.		 source code
 
regBookmarkCompareGesture(self, dev=None, gesture=None, name=None, **kwargs)
Register a named 'compare bookmark' gesture.		 source code

Inherited from AccessEngine.AEScript.AEScript: __init__, bindToEvent, chainTask, close, doCyclicInputTask, doTask, getAETier, getAnchorScriptClassName, getAnchorTaskId, getChainSegment, getChooserTask, getCommandTask, getEventTasks, getIdealOutput, getLastKey, getOutputDevices, getPointerPOR, getRegisteredTask, getScriptSetting, getScriptSettingVal, getState, getTaskKeys, getTempData, getVirtualPOR, mergeChain, postClose, preInit, registerChooserTask, registerCommand, registerCyclicInputTask, registerCyclicInputTasks, registerModifiers, registerTask, registerTimerTask, setIdealOutput, setPointerPOR, setScriptSettingVal, setTempData, setVirtualPOR, unbindFromEvent, unchainTask, unregisterChooserTask, unregisterCommand, unregisterCyclicInputTask, unregisterModifiers, unregisterTask, unregisterTaskFromCyclicInputTask, unregisterTimerTask

Inherited from AccessEngine.AEScript.AEScript (private): _changeDefaultOutput

Inherited from AccessEngine.AEUserInterface.AEUserInterface: getClassName, getPath

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]

Inherited from AccessEngine.AEScript.AEScript: STATE

Instance Variables [hide private]
dictionary bm_compare_gestures
Collection of 'compare' gestures (Alt+Caps-Lock+Shift+1-0):
dictionary bookmarks
Collection of bookmarks (Alt+Caps-Lock+1-0):
dictionary goto_gestures
Collection of 'goto' gestures (Caps-Lock+1-0):
dictionary whereami_gestures
Collection of 'where am i' gestures (Alt+Shift+1-0):

Inherited from AccessEngine.AEScript.AEScript: after_chains, around_chains, around_tasks, before_chains, chooser_tasks, command_descriptions, commands, cyclic_input_tasks, def_out, event_tasks, out_caps, registered_modifiers, registered_tasks, state, tier

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

init(self)

source code 
Registers tasks that can be mapped to AEInput.Gestures.
Overrides: AccessEngine.AEScript.AEScript.init

getName(self)

source code 
Provides the localized name of this AEScript.
Returns: string
Human readable translated description of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getName

getDescription(self)

source code 
Describe which AETier this script applies to by default.
Returns: string
Human readable translated description of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getDescription

_sayBookmark(self, por, **kwargs)

source code 
Speaks information about the given AEPor using an audio output device.
Parameters:
  • por (AEPor) - Point of regard for a bookmark
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

_reverseBookmarks(self, gesture)

source code 
Does a reverse lookup on bookmarks using given gesture.
Parameters:
Returns: string
Bookmark name

addBookmark(self, cycle_count, gesture=None, **kwargs)

source code 
Adds a new bookmarks. If a current, different bookmark will be overwritten, warns the user first and requires they activate this task again.
Parameters:
  • cycle_count (integer) - Number of times this gesture has been issued without interruption
  • gesture (AEInput.Gesture) - given input gesture
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

_reverseGotoGestures(self, gesture)

source code 
Does a reverse lookup on goto_gestures using given gesture.
Parameters:
Returns: string
Bookmark name

gotoBookmark(self, gesture=None, **kwargs)

source code 
Triggers a 'pointer to por' event using the bookmarked AEPor.
Parameters:
  • gesture (AEInput.Gesture) - The given input gesture.
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

reviewBookmark(self, cycle_count, gesture=None, **kwargs)

source code 
Reviews all bookmarks saved in the current application.
Parameters:
  • cycle_count (integer) - Number of times this gesture has been issued without interruption.
  • gesture (AEInput.Gesture) - The given input gesture.
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

_reverseCompare(self, gesture)

source code 
Does a reverse lookup on bm_compare_gestures using given gesture.
Parameters:
Returns: string
bookmark name

compareBookmark(self, gesture=None, **kwargs)

source code 
Compares the position of a given bookmark to that of the current AETier.virtual_por and announces comparison information. ie. 'same POR', 'same container'
Parameters:
  • gesture (AEInput.Gesture) - The given input gesture.
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

_reverseWhereAmI(self, gesture)

source code 
Does a reverse lookup on whereami_gestures using given gesture.
Parameters:
Returns: string
bookmark name

whereAmIBookmark(self, gesture=None, **kwargs)

source code 
Reports the location of the selected bookmark by announcing all control and container names in child-to-parent order.
Parameters:
  • gesture (AEInput.Gesture) - The given input gesture.
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

regBookmarkAddGesture(self, dev=None, gesture=None, name=None, **kwargs)

source code 
Register a named 'add' bookmark gesture.
Parameters:
  • dev (AEInput) - An input device.
  • gesture (list) - List of keys that represent a gesture.
  • name (string) - Point of regard for a bookmark
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

regBookmarkGotoGesture(self, dev=None, gesture=None, name=None, **kwargs)

source code 
Register a named 'goto' bookmark gesture.
Parameters:
  • dev (AEInput) - An input device
  • gesture (list) - List of keys that represent a gesture.
  • name (string) - Point of regard for a bookmark
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

regBookmarkWhereAmIGesture(self, dev=None, gesture=None, name=None, **kwargs)

source code 
Register a named 'where am i' bookmark gesture.
Parameters:
  • dev (AEInput) - An input device
  • gesture (list) - List of keys that represent a gesture.
  • name (string) - Point of regard for a bookmark
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

regBookmarkCompareGesture(self, dev=None, gesture=None, name=None, **kwargs)

source code 
Register a named 'compare bookmark' gesture.
Parameters:
  • dev (AEInput) - An input device
  • gesture (list) - List of keys that represent a gesture.
  • name (string) - Point of regard for a bookmark
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task.

Instance Variable Details [hide private]

bm_compare_gestures

Collection of 'compare' gestures (Alt+Caps-Lock+Shift+1-0): 
 Dictionary {
   key: 'bookmark name',
   value: [compare gesture]
 }
Type:
dictionary

bookmarks

Collection of bookmarks (Alt+Caps-Lock+1-0): 
 Dictionary {
   key: 'bookmark name',
   value: {'add gesture':[gesture], 'por': bookmarkedPor}
 }
Type:
dictionary

goto_gestures

Collection of 'goto' gestures (Caps-Lock+1-0): 
 Dictionary {
   key: 'bookmark name',
   value: [goto gesture]
 }
Type:
dictionary

whereami_gestures

Collection of 'where am i' gestures (Alt+Shift+1-0): 
 Dictionary {
   key: 'bookmark name',
   value: [where am i gesture]
 }
Type:
dictionary

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:59 2008 http://epydoc.sourceforge.net