Back to index

lightning-sunbird  0.9+nobinonly
nsAutoCompleteCollector.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim:set ts=2 sw=2 sts=2 et cindent: */
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Metrics extension.
00017  *
00018  * The Initial Developer of the Original Code is Google Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2006
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Brian Ryner <bryner@brianryner.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 // nsAutoCompleteCollector listens for autocomplete events using the
00040 // observer service notification "autocomplete-text-entered".  The
00041 // AutoCompleteInput is examined to determine the autocomplete index,
00042 // and the length of typed and completed text.  The text itself is not logged.
00043 // This data, along with the hashed id of the AutoCompleteInput, is logged
00044 // to the MetricsService in a <uielement action="autocomplete"> event.
00045 
00046 #ifndef nsAutoCompleteCollector_h_
00047 #define nsAutoCompleteCollector_h_
00048 
00049 #include "nsIMetricsCollector.h"
00050 #include "nsIObserver.h"
00051 
00052 class nsAutoCompleteCollector : public nsIMetricsCollector,
00053                                 public nsIObserver
00054 {
00055  public:
00056   NS_DECL_ISUPPORTS
00057   NS_DECL_NSIMETRICSCOLLECTOR
00058   NS_DECL_NSIOBSERVER
00059 
00060   nsAutoCompleteCollector();
00061 
00062  private:
00063   ~nsAutoCompleteCollector();
00064 };
00065 
00066 #define NS_AUTOCOMPLETECOLLECTOR_CLASSNAME "AutoComplete Collector"
00067 #define NS_AUTOCOMPLETECOLLECTOR_CID \
00068 { 0x62cb877d, 0x5c8a, 0x44ca, {0xab, 0xcd, 0x1c, 0xaa, 0x76, 0x7c, 0xf4, 0xd4}}
00069 
00070 #endif  // nsAutoCompleteCollector_h_