gecko-dev/toolkit/components/autocomplete/nsAutoCompleteController.h

147 lines
5.3 KiB
C++

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Joe Hewitt <hewitt@netscape.com> (Original Author)
* Masayuki Nakano <masayuki@d-toybox.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef __nsAutoCompleteController__
#define __nsAutoCompleteController__
#include "nsIAutoCompleteController.h"
#include "nsIAutoCompleteInput.h"
#include "nsIAutoCompletePopup.h"
#include "nsIAutoCompleteResult.h"
#include "nsIAutoCompleteSearch.h"
#include "nsString.h"
#include "nsITreeView.h"
#include "nsITreeSelection.h"
#include "nsITimer.h"
#include "nsTArray.h"
#include "nsCOMArray.h"
#include "nsCycleCollectionParticipant.h"
class nsAutoCompleteController : public nsIAutoCompleteController,
public nsIAutoCompleteObserver,
public nsITimerCallback,
public nsITreeView
{
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsAutoCompleteController,
nsIAutoCompleteController)
NS_DECL_NSIAUTOCOMPLETECONTROLLER
NS_DECL_NSIAUTOCOMPLETEOBSERVER
NS_DECL_NSITREEVIEW
NS_DECL_NSITIMERCALLBACK
nsAutoCompleteController();
virtual ~nsAutoCompleteController();
protected:
nsresult OpenPopup();
nsresult ClosePopup();
nsresult StartSearch(PRUint16 aSearchType);
nsresult BeforeSearches();
nsresult StartSearches();
void AfterSearches();
nsresult ClearSearchTimer();
nsresult ProcessResult(PRInt32 aSearchIndex, nsIAutoCompleteResult *aResult);
nsresult PostSearchCleanup();
nsresult EnterMatch(bool aIsPopupSelection);
nsresult RevertTextValue();
nsresult CompleteDefaultIndex(PRInt32 aResultIndex);
nsresult CompleteValue(nsString &aValue);
nsresult GetResultAt(PRInt32 aIndex, nsIAutoCompleteResult** aResult,
PRInt32* aRowIndex);
nsresult GetResultValueAt(PRInt32 aIndex, bool aValueOnly,
nsAString & _retval);
nsresult GetResultLabelAt(PRInt32 aIndex, bool aValueOnly,
nsAString & _retval);
private:
nsresult GetResultValueLabelAt(PRInt32 aIndex, bool aValueOnly,
bool aGetValue, nsAString & _retval);
protected:
nsresult GetDefaultCompleteValue(PRInt32 aResultIndex, bool aPreserveCasing,
nsAString &_retval);
nsresult ClearResults();
nsresult RowIndexToSearch(PRInt32 aRowIndex,
PRInt32 *aSearchIndex, PRInt32 *aItemIndex);
// members //////////////////////////////////////////
nsCOMPtr<nsIAutoCompleteInput> mInput;
nsCOMArray<nsIAutoCompleteSearch> mSearches;
nsCOMArray<nsIAutoCompleteResult> mResults;
// Caches the match counts for the current ongoing results to allow
// incremental results to keep the rowcount up to date.
nsTArray<PRUint32> mMatchCounts;
// Temporarily keeps the results alive while invoking startSearch() for each
// search. This is needed to allow the searches to reuse the previous result,
// since otherwise the first search clears mResults.
nsCOMArray<nsIAutoCompleteResult> mResultCache;
nsCOMPtr<nsITimer> mTimer;
nsCOMPtr<nsITreeSelection> mSelection;
nsCOMPtr<nsITreeBoxObject> mTree;
nsString mSearchString;
bool mDefaultIndexCompleted;
bool mBackspaced;
bool mPopupClosedByCompositionStart;
enum CompositionState {
eCompositionState_None,
eCompositionState_Composing,
eCompositionState_Committing
};
CompositionState mCompositionState;
PRUint16 mSearchStatus;
PRUint32 mRowCount;
PRUint32 mSearchesOngoing;
PRUint32 mSearchesFailed;
bool mFirstSearchResult;
PRUint32 mImmediateSearchesCount;
};
#endif /* __nsAutoCompleteController__ */