User:Clarkbw/STEEL/0.1/STEEL:Application: Difference between revisions
< User:Clarkbw | STEEL | 0.1
Jump to navigation
Jump to search
(adding header) |
|||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
| Line 10: | Line 8: | ||
|- | |- | ||
| <code>steelISearchTerms [[#getNewSearchTerms()|getNewSearchTerms]]()</code> | | <code>steelISearchTerms [[#getNewSearchTerms()|getNewSearchTerms]]()</code> | ||
<!-- | |||
| <code>void [[#addListener()|addListener]](in AString event, in steelIEventListener listener)</code> | | <code>void [[#addListener()|addListener]](in AString event, in steelIEventListener listener)</code> | ||
--> | |||
|} | |} | ||
=Attributes= | =Attributes= | ||
| Line 28: | Line 22: | ||
| class="header"|Examples | | class="header"|Examples | ||
|- | |- | ||
|<code>accounts</code> | |<code>[[User:Clarkbw/STEEL/0.1/STEEL:Application:accounts|accounts]]</code> | ||
|<code>readonly attribute steelIAccounts</code> | |<code>readonly attribute steelIAccounts</code> | ||
|List of | |List of account objects ([[User:Clarkbw/STEEL/0.1/STEEL:Account|steelIAccount]]) like email and newsgroups. | ||
|[[User:Clarkbw/STEEL_Examples#List_all_Accounts|List all Accounts]] | |[[User:Clarkbw/STEEL_Examples#List_all_Accounts|List all Accounts]] | ||
|- | |- | ||
| Line 38: | Line 32: | ||
|[[User:Clarkbw/STEEL_Examples#List_all_Address_books|List all Address books]] | |[[User:Clarkbw/STEEL_Examples#List_all_Address_books|List all Address books]] | ||
|- | |- | ||
|<code>preferences</code> | |<code>[http://developer.mozilla.org/en/docs/FUEL:Preference preferences]</code> | ||
|<code>readonly attribute steelIPreferences</code> | |<code>readonly attribute steelIPreferences</code> | ||
|Provides access to global Thunderbird preferences, for extension only preferences use the extension object below. | |Provides access to global Thunderbird preferences, for extension only preferences use the extension object below. | ||
|[[User:Clarkbw/STEEL_Examples#List_all_Preferences|List all Preferences]] | |[[User:Clarkbw/STEEL_Examples#List_all_Preferences|List all Preferences]] | ||
|- | |- | ||
|<code>extensions</code> | |<code>[http://developer.mozilla.org/en/docs/FUEL:Extensions extensions]</code> | ||
|<code>readonly attribute steelIExtensions</code> | |<code>readonly attribute steelIExtensions</code> | ||
|List of extensions known to Thunderbird, provides access to all extension information and their preferences. | |List of extensions known to Thunderbird, provides access to all extension information and their preferences. | ||
|[[User:Clarkbw/STEEL_Examples#List_all_Extensions|List all Extensions]] | |[[User:Clarkbw/STEEL_Examples#List_all_Extensions|List all Extensions]] | ||
|- | |||
|<code>[http://developer.mozilla.org/en/docs/FUEL:Console console]</code> | |||
|<code>readonly attribute steelIConsole</code> | |||
|Object for accessing the thunderbird error / log console. | |||
|[[User:Clarkbw/STEEL_Examples#Console_Logging|Console Logging]] | |||
|- | |||
|<code>[http://developer.mozilla.org/en/docs/FUEL:Events events]</code> | |||
|<code>readonly attribute steelIEvents</code> | |||
|Event object for adding and removing listeners to the Application level | |||
| | |||
|} | |} | ||
=Methods= | =Methods= | ||
==search()== | ==search()== | ||
'''This method is not currently implemented''' | |||
Returns all messages matching the search terms to the provided listenerb | Returns all messages matching the search terms to the provided listenerb | ||
| Line 61: | Line 66: | ||
<h5 style="border:none;">Return value</h5> | <h5 style="border:none;">Return value</h5> | ||
<tt>none</tt> | |||
==getNewSearchTerms()== | ==getNewSearchTerms()== | ||
| Line 74: | Line 80: | ||
: Returns a new steelISearchTerms object for use in the [[#search()|search()]] method | : Returns a new steelISearchTerms object for use in the [[#search()|search()]] method | ||
=Events= | |||
* messageShow — ''triggers when a message is shown in the message pane'' | |||
* messageShow | |||
<!-- # these are for sub event objects | <!-- # these are for sub event objects | ||
* newMail | * newMail | ||
| Line 88: | Line 88: | ||
* folderRemoved | * folderRemoved | ||
--> | --> | ||
=See Also= | =See Also= | ||
Latest revision as of 15:32, 21 April 2008
Method Overview
AString search([array] in steelISearchTerms terms, in steelIListener listener)
|
steelISearchTerms getNewSearchTerms()
|
Attributes
| Attribute | Type | Description | Examples |
accounts
|
readonly attribute steelIAccounts
|
List of account objects (steelIAccount) like email and newsgroups. | List all Accounts |
addressBooks
|
readonly attribute steelIAddressBooks
|
List of address books like Local, LDAP, and others. | List all Address books |
preferences
|
readonly attribute steelIPreferences
|
Provides access to global Thunderbird preferences, for extension only preferences use the extension object below. | List all Preferences |
extensions
|
readonly attribute steelIExtensions
|
List of extensions known to Thunderbird, provides access to all extension information and their preferences. | List all Extensions |
console
|
readonly attribute steelIConsole
|
Object for accessing the thunderbird error / log console. | Console Logging |
events
|
readonly attribute steelIEvents
|
Event object for adding and removing listeners to the Application level |
Methods
search()
This method is not currently implemented
Returns all messages matching the search terms to the provided listenerb
Parameters
- terms
- Array of search terms
- listener
- Listener object which is required to implement the function
handleEvent(event)
Return value
none
getNewSearchTerms()
Provides a new steelISearchTerms object
Parameters
none
Return Value
- steelISearchTerms
- Returns a new steelISearchTerms object for use in the search() method
Events
- messageShow — triggers when a message is shown in the message pane