wxAutomationObject

wxAutomationObject クラスは IDispatch ポインタのみをメンバに持つ OLE オートメーションオブジェクトを表しています。 このクラスにはオートメーションの操作や、プロパティの設定、取得を簡単に行う関数がたくさん含まれています。 このクラスは wxVariant クラスを頻繁に使用しています。
The wxAutomationObject class represents an OLE automation object containing a single data member, an IDispatch pointer. It contains a number of functions that make it easy to perform automation operations, and set and get properties. The class makes heavy use of the wxVariant class.
このクラスの使用方法は Visual Basic での OLE オートメーションの使用方法にとても近いです。 API は高級で、アプリケーションはひとつの文字列で複数のプロパティを指定できます。 以下の例は現在の Excel のインスタンスを取得し、インスタンスが存在していれば アクティブなセルを太字にします。
The usage of these classes is quite close to OLE automation usage in Visual Basic. The API is high-level, and the application can specify multiple properties in a single string. The following example gets the current Excel instance, and if it exists, makes the active cell bold.
  wxAutomationObject excelObject;
  if (excelObject.GetInstance("Excel.Application"))
      excelObject.PutProperty("ActiveCell.Font.Bold", true);
このクラスは Windows でのみ動作することに注意してください。
Note that this class obviously works under Windows only.

継承元
Derived from

wxObject

インクルードファイル
Include files

<wx/msw/ole/automtn.h>

参照
See also

wxVariant

メンバ
Members


wxAutomationObject::wxAutomationObject

wxAutomationObject(WXIDISPATCH* dispatchPtr = NULL)
コンストラクタ。引数に IDispatch ポインタを取ることができます。 このポインタはオブジェクトが削除されたときに解放されます。
Constructor, taking an optional IDispatch pointer which will be released when the object is deleted.

wxAutomationObject::~wxAutomationObject

~wxAutomationObject()
デストラクタ。内部の IDispatch ポインタが null でなければポインタを解放します。
Destructor. If the internal IDispatch pointer is non-null, it will be released.

wxAutomationObject::CallMethod

wxVariant CallMethod(const wxString& method, int noArgs, wxVariant args[]) const
wxVariant CallMethod(const wxString& method, ... ) const
このオブジェクトのオートメーション関数を呼びます。 最初の形式は関数名、引数の数、 variant の値の配列を引数に取ります。 2 番目の形式は関数名と 0 から 6 までの variant への const リファレンスを引数に取ります。 variant クラスは基本データ型を引数に取るコンストラクタを持ち、 C++ は一時オブジェクトを自動的に提供するため、以下の例は両方とも構文的には有効です。
Calls an automation method for this object. The first form takes a method name, number of arguments, and an array of variants. The second form takes a method name and zero to six constant references to variants. Since the variant class has constructors for the basic data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid:
  wxVariant res = obj.CallMethod("Sum", wxVariant(1.2), wxVariant(3.4));
  wxVariant res = obj.CallMethod("Sum", 1.2, 3.4);
method にはドットで区切ったプロパティ名を含めることができることに注意してください。 こうすることでアプリケーションが一時オブジェクトを使用して GetProperty を何度も呼ぶ必要を 失くすことができます。
Note that method can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects. For example:
  object.CallMethod("ActiveCell.Font.ShowDialog", "My caption");

wxAutomationObject::CreateInstance

bool CreateInstance(const wxString& classId) const
クラス ID を基に新しいオブジェクトを作成します。 作成に成功したら true を、そうでなければ false を返します。
Creates a new object based on the class id, returning true if the object was successfully created, or false if not.

wxAutomationObject::GetDispatchPtr

IDispatch* GetDispatchPtr() const
IDispatch ポインタを取得します。
Gets the IDispatch pointer.

wxAutomationObject::GetInstance

bool GetInstance(const wxString& classId) const
クラス ID に関連付けられている現在のオブジェクトを取り出し、 IDispatch ポインタをこのオブジェクトへ添付します。 ポインタの取り出しに成功したら true を、そうでなければ false を返します。
Retrieves the current object associated with a class id, and attaches the IDispatch pointer to this object. Returns true if a pointer was successfully retrieved, false otherwise.
Excel のコピーが 2 つ実行中のときのように、指定した OLE オブジェクトのインスタンスが 同時に 2 つアクティブなときはうまく処理することができないことに注意してください。 どちらのオブジェクトを指しているのか指定することは今のところできません。
Note that this cannot cope with two instances of a given OLE object being active simultaneously, such as two copies of Excel running. Which object is referenced cannot currently be specified.

wxAutomationObject::GetObject

bool GetObject(wxAutomationObject& obj const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const
このオブジェクトからプロパティ、つまり IDispatch ポインタを取り出し、 そのポインタで obj を初期化します。 IDispatch ポインタを直接扱うことを避けるため、他のオブジェクトからオブジェクトを取り出すときは wxAutomationObject::GetProperty よりも この関数を使用するようにしてください。
Retrieves a property from this object, assumed to be a dispatch pointer, and initialises obj with it. To avoid having to deal with IDispatch pointers directly, use this function in preference to wxAutomationObject::GetProperty when retrieving objects from other objects.
IDispatch ポインタは wxVariant オブジェクト内に void* ポインタとして格納されていることに注意してください。
Note that an IDispatch pointer is stored as a void* pointer in wxVariant objects.

参照
See also

wxAutomationObject::GetProperty

wxAutomationObject::GetProperty

wxVariant GetProperty(const wxString& property, int noArgs, wxVariant args[]) const
wxVariant GetProperty(const wxString& property, ... ) const
このオブジェクトのプロパティの値を取得します。 最初の形式はプロパティ名、引数の数、 variant の値の配列を引数に取ります。 2 番目の形式はプロパティ名と 0 から 6 までの variant への const リファレンスを引数に取ります。 variant クラスは基本データ型を引数に取るコンストラクタを持ち、 C++ は一時オブジェクトを自動的に提供するため、以下の例は両方とも構文的には有効です。
Gets a property value from this object. The first form takes a property name, number of arguments, and an array of variants. The second form takes a property name and zero to six constant references to variants. Since the variant class has constructors for the basic data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid:
  wxVariant res = obj.GetProperty("Range", wxVariant("A1"));
  wxVariant res = obj.GetProperty("Range", "A1");
property にはドットで区切ったプロパティ名を含めることができることに注意してください。 こうすることでアプリケーションが一時オブジェクトを使用して GetProperty を何度も呼ぶ必要を 失くすことができます。
Note that property can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects.

wxAutomationObject::Invoke

bool Invoke(const wxString& member, int action, wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[] = 0) const
この関数は IDispatch Invoke 関数にアクセスできる低級な実装です。 これはアプリケーションによって直接呼び出されるのではなく、他の便利な関数から呼び出されるという意味です。
This function is a low-level implementation that allows access to the IDispatch Invoke function. It is not meant to be called directly by the application, but is used by other convenience functions.

引数
Parameters

member
メンバ関数かプロパティの名前
The member function or property name.
action
ビットリスト: DISPATCH_PROPERTYPUT、 DISPATCH_PROPERTYPUTREF、 DISPATCH_METHOD を含みます。
Bitlist: may contain DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, DISPATCH_METHOD.
retValue
戻り値 (戻り値がなければ無視されます)
Return value (ignored if there is no return value)
.
noArgs
argsptrArgs の引数の数
Number of arguments in args or ptrArgs.
args
null でなければ variant の配列。
If non-null, contains an array of variants.
ptrArgs
null でなければ variant の const ポインタの配列。
If non-null, contains an array of constant pointers to variants.

戻り値
Return value

操作が成功すれば true を、そうでなければ false を返します。
true if the operation was successful, false otherwise.

注釈
Remarks

可能であれば効率のためにポインタを使用できるように、引数の配列を 2 種類提供しています。
Two types of argument array are provided, so that when possible pointers are used for efficiency.

wxAutomationObject::PutProperty

bool PutProperty(const wxString& property, int noArgs, wxVariant args[]) const
bool PutProperty(const wxString& property, ... )
このオブジェクトにプロパティの値をセットします。 最初の形式はプロパティ名、引数の数、 variant の値の配列を引数に取ります。 2 番目の形式はプロパティ名と 0 から 6 までの variant への const リファレンスを引数に取ります。 variant クラスは基本データ型を引数に取るコンストラクタを持ち、 C++ は一時オブジェクトを自動的に提供するため、以下の例は両方とも構文的には有効です。
Puts a property value into this object. The first form takes a property name, number of arguments, and an array of variants. The second form takes a property name and zero to six constant references to variants. Since the variant class has constructors for the basic data types, and C++ provides temporary objects automatically, both of the following lines are syntactically valid:
  obj.PutProperty("Value", wxVariant(23));
  obj.PutProperty("Value", 23);
property にはドットで区切ったプロパティ名を含めることができることに注意してください。 こうすることでアプリケーションが一時オブジェクトを使用して GetProperty を何度も呼ぶ必要を 失くすことができます。
Note that property can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects.

wxAutomationObject::SetDispatchPtr

void SetDispatchPtr(WXIDISPATCH* dispatchPtr)
IDispatch ポインタをセットします。 この関数はすでに IDispatch ポインタが存在するかチェックしません。
Sets the IDispatch pointer. This function does not check if there is already an IDispatch pointer.
この関数を呼ぶときは IDispatch* を WXIDISPATCH* にキャストする必要があります。
You may need to cast from IDispatch* to WXIDISPATCH* when calling this function.