C# Class ACAT.Extensions.Default.FunctionalAgents.PhraseSpeakAgent.PhraseSpeakScanner

Mostra file Open project: brlima94/acat-localization Class Usage Examples

Public Methods

Method Description
CheckWidgetEnabled ( CheckEnabledArgs arg ) : bool

Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.

ClearFilter ( ) : void

Clears the search filter

GetInvoker ( ) : ExtensionInvoker

Returns the extension invoker object

Initialize ( StartupArg startupArg ) : bool

Initializes the form. Sets the position, initializes the scannercommon object

IsFilterEmpty ( ) : bool

Checks if the search filter is empty

LoadAbbreviations ( ) : void

Get the list of abbreviations, selects those whose mode is "Speak" and populates the list

OnFocusChanged ( WindowActivityMonitorInfo monitorInfo ) : void

Not used

OnPause ( ) : void

Pauses animation

OnQueryPanelChange ( PanelRequestEventArgs eventArg ) : bool

Show we allow deactivation?

OnResume ( ) : void

Resumes animation

OnRunCommand ( string command, bool &handled ) : void

Not used

OnWidgetActuated ( Widget widget, bool &handled ) : void

Called when a widget on the scanner is activated

Pause ( ) : void

Temporary disable keypress, pause animation

PhraseSpeakScanner ( ) : System

Initializes a new instance of the class.

Resume ( ) : void

Resume key press handlers, resume animation

SetTargetControl ( Form parent, Widget widget ) : void

Not used

createStatusBar ( ) : void

Creates a status bar for the scanner

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

OnFormClosing ( FormClosingEventArgs e ) : void

Invoked when the form is closing. Release resources

Private Methods

Method Description
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

Instance_EvtScannerClosed ( object sender, ScannerCloseEventArg arg ) : void

Event handler for when a scanner closes. Reposition this scanner to its default position

Instance_EvtScannerShow ( object sender, ScannerShowEventArg arg ) : void

Displayed when the alphaet scanner is displayed. Dock this form with the currently active scanner

PhraseSpeakScanner_FormClosing ( object sender, FormClosingEventArgs e ) : void

Release resources and stop threads/timers

PhraseSpeakScanner_KeyDown ( object sender, KeyEventArgs e ) : void

Key down event handler

PhraseSpeakScanner_Load ( object sender, EventArgs e ) : void

Initilaze. Load the phrases, populate list and display them.

PhraseSpeakScanner_LocationChanged ( object sender, EventArgs e ) : void

Event handler for when location of the form changes. Disallow this an redock the form

PhraseSpeakScanner_Shown ( object sender, EventArgs e ) : void

Invoked when the form is shown. Make it the active window with focus

SearchFilter_TextChanged ( object sender, EventArgs e ) : void

User typed something in the search filter. Do a search to find matches in the list and display only those

SortOrderIcon_Click ( object sender, EventArgs e ) : void

User clicked on the sort order button. Switch the sort order

WndProc ( Message &m ) : void
_keyboardActuator_EvtKeyPress ( object sender, KeyPressEventArgs e ) : void

Key press handler

actuateWidget ( Widget widget, bool &handled ) : void

Handles actuation of a widget

dockToScanner ( Form scanner ) : void

Docks this form to the active scanner

enableWatchdogs ( ) : void

Enable watchdogs to see tha the form stays active

filterAbbreviations ( IEnumerable abbrList, String filter ) : List

If there is a search filter, show only phrases that match the filter

gotoNextPage ( ) : void

Show the next pageful of entries

gotoPreviousPage ( ) : void

Show the previous pageful of entries

handleWidgetSelection ( Widget widget, bool &handled ) : void

Handles actuation of a widget

highlightOff ( ) : void

Turn highlight off on everything

includeAbbr ( Abbreviation abbr, String filter ) : bool

Matchs the abbr expansion with the filter and tells whether there is a match or not.

refreshPhrasesList ( ) : void

Refreshes the list of abbreviations and displays the current pageful of abbreviations in the UI.

removeWatchdogs ( ) : void

Disable watchdogs

setFormStyles ( CreateParams createParams ) : CreateParams

Set the style of the form

sort ( List list, SortOrder order ) : List

Sorts the input list based on the sort order

subscribeToEvents ( ) : void

Subscribes to the various events

switchSortOrder ( ) : void

Switch the sort order and refresh the abbreviations list

updateButtonBar ( ) : void

Updates the button bar with page number info, sort order etc.

updateStatusBar ( ) : void

Updates the status bar

Method Details

CheckWidgetEnabled() public method

Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.
public CheckWidgetEnabled ( CheckEnabledArgs arg ) : bool
arg CheckEnabledArgs info about the scanner button
return bool

ClearFilter() public method

Clears the search filter
public ClearFilter ( ) : void
return void

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

GetInvoker() public method

Returns the extension invoker object
public GetInvoker ( ) : ExtensionInvoker
return ExtensionInvoker

Initialize() public method

Initializes the form. Sets the position, initializes the scannercommon object
public Initialize ( StartupArg startupArg ) : bool
startupArg StartupArg args
return bool

IsFilterEmpty() public method

Checks if the search filter is empty
public IsFilterEmpty ( ) : bool
return bool

LoadAbbreviations() public method

Get the list of abbreviations, selects those whose mode is "Speak" and populates the list
public LoadAbbreviations ( ) : void
return void

OnFocusChanged() public method

Not used
public OnFocusChanged ( WindowActivityMonitorInfo monitorInfo ) : void
monitorInfo WindowActivityMonitorInfo
return void

OnFormClosing() protected method

Invoked when the form is closing. Release resources
protected OnFormClosing ( FormClosingEventArgs e ) : void
e FormClosingEventArgs event arg
return void

OnPause() public method

Pauses animation
public OnPause ( ) : void
return void

OnQueryPanelChange() public method

Show we allow deactivation?
public OnQueryPanelChange ( PanelRequestEventArgs eventArg ) : bool
eventArg PanelRequestEventArgs event arg
return bool

OnResume() public method

Resumes animation
public OnResume ( ) : void
return void

OnRunCommand() public method

Not used
public OnRunCommand ( string command, bool &handled ) : void
command string
handled bool
return void

OnWidgetActuated() public method

Called when a widget on the scanner is activated
public OnWidgetActuated ( Widget widget, bool &handled ) : void
widget Widget widget activated
handled bool true if handled
return void

Pause() public method

Temporary disable keypress, pause animation
public Pause ( ) : void
return void

PhraseSpeakScanner() public method

Initializes a new instance of the class.
public PhraseSpeakScanner ( ) : System
return System

Resume() public method

Resume key press handlers, resume animation
public Resume ( ) : void
return void

SetTargetControl() public method

Not used
public SetTargetControl ( Form parent, Widget widget ) : void
parent Form
widget Widget
return void

createStatusBar() public method

Creates a status bar for the scanner
public createStatusBar ( ) : void
return void