toolkit/components/commandlines/nsICommandLineValidator.idl@6474c204b198 (annotated)
toolkit/components/commandlines/nsICommandLineValidator.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 2 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 3 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 4 | |
| michael@0 | 5 | #include "nsISupports.idl" |
| michael@0 | 6 | |
| michael@0 | 7 | interface nsICommandLine; |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * Validates arguments on the command line of an XUL application. |
| michael@0 | 11 | * |
| michael@0 | 12 | * Each validator is registered in the category "command-line-validator". |
| michael@0 | 13 | * The entries in this category are read in alphabetical order, and each |
| michael@0 | 14 | * category value is treated as a service contractid implementing this |
| michael@0 | 15 | * interface. |
| michael@0 | 16 | * |
| michael@0 | 17 | * By convention, validator with ordinary priority should begin with "m". |
| michael@0 | 18 | * |
| michael@0 | 19 | * Example: |
| michael@0 | 20 | * Category Entry Value |
| michael@0 | 21 | * command-line-validator b-browser @mozilla.org/browser/clh;1 |
| michael@0 | 22 | * command-line-validator m-edit @mozilla.org/composer/clh;1 |
| michael@0 | 23 | * command-line-validator m-irc @mozilla.org/chatzilla/clh;1 |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | [scriptable, uuid(5ecaa593-7660-4a3a-957a-92d5770671c7)] |
| michael@0 | 28 | interface nsICommandLineValidator : nsISupports |
| michael@0 | 29 | { |
| michael@0 | 30 | /** |
| michael@0 | 31 | * Process the command-line validators in the proper order, calling |
| michael@0 | 32 | * "validate()" on each. |
| michael@0 | 33 | * |
| michael@0 | 34 | * @throws NS_ERROR_ABORT if any validator throws NS_ERROR_ABORT. All other |
| michael@0 | 35 | * errors thrown by validators will be silently ignored. |
| michael@0 | 36 | */ |
| michael@0 | 37 | void validate(in nsICommandLine aCommandLine); |
| michael@0 | 38 | }; |
