IAutoComplete

オートコンプリートオブジェクト(CLSID_AutoComplete)によって公開されます。このインターフェイスを使用すると、アプリケーションはオブジェクトの初期化、有効化、無効化を行うことができます。

オートコンプリートは、エディットコントロールに部分的に入力された文字列を、完全な文字列に展開します。たとえば、Windows Internet Explorer のツールバーに埋め込まれたアドレスエディットコントロールにユーザーが URL を入力し始めると、オートコンプリートはその文字列を、既存の部分文字列と一致する 1 つ以上の完全な URL に展開します。「mic」のような部分的な URL 文字列は、「http://www.microsoft.com」や「http://www.microsoft.com/windows」に展開される場合があります。オートコンプリートは通常、エディットコントロールや、comboboxex コントロールのようにエディットコントロールが埋め込まれたコントロールで使用されます。

オートコンプリートには、完成した文字列を表示するための 2 つのモードがあります。これらのモードは独立しているため、どちらか一方または両方を有効にできます。モードを指定するには、IAutoComplete2::SetOptions を呼び出します。モードは次のとおりです。

• autoappend モードでは、オートコンプリートは最も可能性の高い候補文字列の残りの部分を既存の文字に追加し、追加された文字を強調表示します。エディットコントロールは、ユーザーが文字列全体を手動で入力してから追加部分を強調表示したかのように動作します。ユーザーが文字の入力を続けると、それらは既存の部分文字列に追加されます。ユーザーが次の強調表示された文字と同一の文字を入力した場合、その文字の強調表示は解除されます。残りの文字は引き続き強調表示されます。ユーザーが次の強調表示された文字と一致しない文字を入力した場合、オートコンプリートはより大きな部分文字列に基づいて新しい候補文字列の生成を試みます。そして、前と同様に、新しい候補文字列の残りの部分を現在の部分文字列に追加します。候補文字列が見つからない場合は、入力された文字のみが表示され、エディットボックスはオートコンプリートがない場合と同様に動作します。この処理は、ユーザーが文字列を確定するまで続きます。
• autosuggest モードでは、オートコンプリートはエディットコントロールの下に、1 つ以上の完全な候補文字列を含むドロップダウンリストを表示します。ユーザーは通常クリックによって候補文字列の 1 つを選択するか、入力を続けることができます。入力が進むにつれて、ドロップダウンリストは現在の部分文字列に基づいて変更される場合があります。IAutoComplete2::SetOptions の dwFlag パラメーターに ACO_SEARCH フラグを設定すると、ドロップダウンリストの一番下に「'XXX' を検索」という項目が追加されます。これは候補文字列がない場合でも表示されます。「XXX」には現在の部分文字列が設定され、ユーザーが入力を続けるにつれて更新されます。ユーザーが「'...' を検索」を選択した場合、アプリケーションは検索エンジンを起動してユーザーを支援する必要があります。

オートコンプリートを実装する最も簡単な方法は、SHAutoComplete を呼び出すことです。この関数をシステムエディットコントロールに対して呼び出すと、そのコントロールは部分的に入力されたファイルシステムのパスまたは URL をオートコンプリートします。他の種類の文字列に対してオートコンプリートを有効にする場合や、オートコンプリートの動作をより細かく制御する場合は、基盤となるオートコンプリートオブジェクトを直接使用できます。

このインターフェイスは通常、アプリケーションによって実装されるものではありません。シェルのオートコンプリートオブジェクトによって公開され、アプリケーションによって使用されます。

オートコンプリートオブジェクトの IAutoComplete インターフェイスを使用して、オブジェクトの初期化や、オートコンプリートの有効化・無効化を行います。

オートコンプリートオブジェクトを使用してエディットコントロールにオートコンプリートを実装するには、次の手順を実行します。

1. IEnumString インターフェイスをエクスポートする文字列リスト Component Object Model (COM) オブジェクトを実装します。この文字列リストオブジェクトは、オートコンプリートオブジェクトが完成文字列の候補として使用する文字列のリストを提供する役割を担います。
2. CoCreateInstance でオートコンプリートオブジェクトのインスタンスを作成します。その IAutoComplete インターフェイスへのポインターを要求します。
3. IAutoComplete::Init を呼び出します。hwndEdit パラメーターにエディットコントロールのウィンドウハンドルを設定します。エディットコントロールが別のコントロールに埋め込まれている場合は、エディットコントロール自体のハンドルを取得する必要があります。たとえば、comboboxex コントロールに埋め込まれたエディットコントロールのハンドルを取得するには、CBEM_GETEDITCONTROL メッセージを送信します。IAutoComplete::Init の punkACL パラメーターには、文字列リストオブジェクトの IUnknown ポインターを設定します。
4. 既定のオプションを使用しない場合は、オートコンプリートオブジェクトの IAutoComplete2 インターフェイスへのポインターを取得します。IAutoComplete2::SetOptions を呼び出して、目的のオプションを設定します。
5. オートコンプリートオブジェクトは、手順 3 で punkACL として渡された文字列リストオブジェクトの IUnknown ポインターを使用して、そのオブジェクトの IEnumString インターフェイスへのポインターを取得します。その後、オートコンプリートオブジェクトはそのインターフェイスを呼び出して候補文字列のリストを生成します。オートコンプリートオブジェクトは、そのリストからコントロール内の部分文字列に適切に一致する文字列を選択します。autoappend モードでは、文字列を完成させるために必要な文字が部分文字列に追加され、強調表示されます。autosuggest モードでは、1 つ以上の候補文字列のリストを含むドロップダウンボックスがエディットコントロールの下に表示されます。
6. ユーザーがオートコンプリートされた文字列を確定すると、エディットコントロールはその文字列が手動で入力されたかのように動作します。

オートコンプリートは既定で有効になっています。アプリケーションは、オートコンプリートを無効にする場合や、無効になっているものを再度有効にする場合にのみ、IAutoComplete::Enable を呼び出す必要があります。

オートコンプリートオブジェクトを初期化します。

型: HRESULT

このメソッドが成功すると、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

オートコンプリートを有効または無効にします。

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は COM エラー値を返します。

オートコンプリートは既定で有効になっています。アプリケーションは、オートコンプリートを無効にする場合や、無効になっているものを再度有効にする場合にのみ、このメソッドを呼び出す必要があります。

#define global IID_IAutoComplete "{00BB2762-6A77-11D0-A535-00C04FD7D062}"
#usecom global IAutoComplete IID_IAutoComplete "{}"
#comfunc global IAutoComplete_Init    3 sptr,sptr,wstr,wstr
#comfunc global IAutoComplete_Enable  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。