OpenOffice.org Basicのドキュメント

Using new-style service constructors

OpenOffice.org 3.2から始まるOpenOffice.org Basicでは、UNOの新しいスタイルのサービスコンストラクタをサポートしています。詳細については、Servicesのセクションを確認して下さい。上で使用されるサンプル・サービスのため、コンストラクタは、このように定義することができました。：

  module com { module sun { module star { module nowhere {
 
  service ServiceThatNeedsInitialization: XFoo { 
      create1([in] long arg);
      create2([in] string important1, [in] string important2);
  };
 
  }; }; }; };

UNOサービスは、OpenOffice.org Basicオブジェクトにマッピングされています。それらは、完全なUNO名前空間パスを使用して、対処する必要があります。コンストラクタは、これらのサービス・オブジェクトのメソッドとして、呼び出すことができます。：

  Dim oServiceObj
  oServiceObj = com.sun.star.nowhere.ServiceThatNeedsInitialization
  Dim oInstance As Object
  oInstance = oServiceObj.create2( "Useless", "Invalid" )

もちろん!サービス・オブジェクトは、予め、変数に格納する必要ありません。また、インスタンスは、1つのステートメントだけで実行します。：

  Dim oInstance As Object
  oInstance = com.sun.star.nowhere.ServiceThatNeedsInitialization.create1( 42 )

内部的に、UNOの既定のコンテキストは、作成するために使用され、サービスに渡されます。また、それは、最初の引数として追加する代わりに、独自のコンテキストを使用することもできます。：

  Dim oMyContext As Object
  oMyContext = GetContextFromSomewhere()
  oInstance = oServiceObj.create1( oMyContext, 42 )

新しいスタイルのサービスだけが、暗黙のコンストラクタを持っている場合、それは、OpenOffice.org Basicで、パラメータなしで、メソッド"create"にマッピングされました。

Build in properties

Basic RTLは、APIエントリ・ポイントとして特別なプロパティを提供します。それらは、OpenOffice.org Basicの機能で、更に詳細に説明されています。：

ThisComponentは、StarDesktop.CurrentComponentより推奨されます。IDEからの開発とデバッグに便利なため、BasicIDEがアクティブである場合、ThisComponentが、常にコンポーネントを参照するしている間、StarDesktop.CurrentComponentは、BasicIDEそのものを参照します。それは、BasicIDEが、一番上のウインドウになる前に、アクティブでした。

原文「Checking for interfaces during runtime」

けれども、Basicでは、C ++やJavaのような、queryInterfaceの概念はサポートされていません。知っていることが、役に立つことがあります。特定のインターフェイスが、UNO Basicオブジェクトでサポートされている、あるいは、されていない場合、 関数HasUnoInterfaces()は、これを検出します。

HasUnoInterfaces()が期待する最初のパラメータは、テストする必要があるオブジェクトです。１つ以上の完全修飾されたインターフェイス名のパラメータは、次に関数に渡すことができます。これらすべてのインタフェースが、オブジェクトによってサポートされている場合、関数は、True、それ以外の場合、falseを返します。

  Sub Main
    Dim oSimpleFileAccess
    oSimpleFileAccess = CreateUnoService( "com.sun.star.ucb.SimpleFileAccess" )
 
  Dim bSuccess
      Dim IfaceName1$, IfaceName2$, IfaceName3$
      IfaceName1$ = "com.sun.star.uno.XInterface"
      IfaceName2$ = "com.sun.star.ucb.XSimpleFileAccess2"
      IfaceName3$ = "com.sun.star.container.XPropertySet"
 
      bSuccess = HasUnoInterfaces( oSimpleFileAccess, IfaceName1$ )
      MsgBox bSuccess ' Displays True because XInterface is supported
			  ' XInterfaceがサポートされているため、Trueを表示します
 
      bSuccess = HasUnoInterfaces( oSimpleFileAccess, IfaceName1$, IfaceName2$ )
      MsgBox bSuccess ' Displays True because XInterface
      ' and XSimpleFileAccess2 are supported
			  ' XInterfaceとXSimpleFileAccess2がサポートされるため、Trueを表示します
 
      bSuccess = HasUnoInterfaces( oSimpleFileAccess, IfaceName3$ )
      MsgBox bSuccess ' Displays False because XPropertySet is NOT supported
			  ' XPropertySetがサポートされないため、Falseを表示します
 
      bSuccess = HasUnoInterfaces( oSimpleFileAccess, IfaceName1$, IfaceName2$, IfaceName3$ )
      MsgBox bSuccess ' Displays False because XPropertySet is NOT supported
			  ' XPropertySetがサポートされないため、Falseを表示します
  End Sub

Testing if an object is a struct during runtime

先程、構造体のマッピングのセクションで説明したように、構造体は、値として扱われるため、オブジェクトと異なる方法で処理されます。 それを確認するためにIsUnoStruct()関数を使用して、UNO Basicオブジェクトは、オブジェクトや構造体を表します。この関数は1つのパラメータを必要とし、Trueを返します。このパラメータが、UNO構造体である場合、それ以外の場合は、Falseです。

例：

  Sub Main
      Dim bIsStruct
          ' Instantiate a service
      Dim oSimpleFileAccess
      oSimpleFileAccess = CreateUnoService( "com.sun.star.ucb.SimpleFileAccess" )
      bIsStruct = IsUnoStruct( oSimpleFileAccess )
      MsgBox bIsStruct ' Displays False because oSimpleFileAccess is NO struct
                       ' Instantiate a Property struct
                       ' oSimpleFileAccessが、構造体でないため、Falseを表示します
                       ' プロパティ構造体をインスタンス化します
      Dim aProperty As New com.sun.star.beans.Property
      bIsStruct = IsUnoStruct( aProperty )
      MsgBox bIsStruct ' Displays True because aProperty is a struct
                       		  ' aPropertyが構造体であるため、Trueを表示します
      bIsStruct = IsUnoStruct( 42 )
      MsgBox bIsStruct ' Displays False because 42 is NO struct
                       		  ' 42が、構造体でないため、Falseを表示します
  End Sub

Testing objects for identity during runtime

見つけるために、2つのUNO OpenOffice.org Basicオブジェクトが、同じUNOオブジェクト・インスタンスを参照する場合、 関数EqualUnoObjects()を使用します。Basicは、比較演算子=を、型オブジェクトの引数に適用することができません。例えば、Obj1 = Obj2である場合、その次に、実行時エラーを引き起こします。

  Sub Main
      Dim bIdentical
      Dim oSimpleFileAccess, oSimpleFileAccess2, oSimpleFileAccess3
          ' Instantiate a service
          '　サービスのインスタンス化
      oSimpleFileAccess = CreateUnoService( "com.sun.star.ucb.SimpleFileAccess" )
      oSimpleFileAccess2 = oSimpleFileAccess ' Copy the object reference
          '　オブジェクト参照をコピーします
      bIdentical = EqualUnoObjects( oSimpleFileAccess, oSimpleFileAccess2 )
      MsgBox bIdentical ' Displays True because the objects are identical
          ' Instantiate the service a second time
          '　オブジェクトが同一のため、Trueを示します
          '　二度目は、サービスをインスタンス化します
      oSimpleFileAccess3 = CreateUnoService( "com.sun.star.ucb.SimpleFileAccess" )
      bIdentical = EqualUnoObjects( oSimpleFileAccess, oSimpleFileAccess3 )
      MsgBox bIdentical ' Displays False, oSimpleFileAccess3 is another instance
  		         '　Falseを表示し、oSimpleFileAccess3は、他に、インスタンスとしての機能も持っています。
      bIdentical = EqualUnoObjects( oSimpleFileAccess, 42 )
      MsgBox bIdentical ' Displays False, 42 is not even an object
          ' Instantiate a Property struct
          '　Falseを表示し、42は、オブジェクトではありません。プロパティ構造体をインスタンス化します
      Dim aProperty As New com.sun.star.beans.Property
      Dim aProperty2
      aProperty2 = aProperty ' Copy the struct
   			　　　　       '　構造体をコピーします
      bIdentical = EqualUnoObjects( aProperty, aProperty2 )
      MsgBox bIdentical ' Displays False because structs are values
          ' and so aProperty2 is a copy of aProperty
          '　構造体が値であるため、Falseを表示します。そして、このように、aProperty2は、aPropertyのコピーです
          '　
  End Sub

OpenOffice.org Basicオブジェクトの背後にある基本的な隠蔽されたインターフェイスは、開発者がAPI構造を使用するとき、問題を引き起こします。API参照を理解することは難しい場合があります。そして、オブジェクトにアクセスし、特定の目標に到達する正しい方法を見つけます。

開発とデバッグの間、支援するために、OpenOffice.org BasicのすべてのUNOオブジェクトは、特別なプロパティを持っています。それは、オブジェクト構造についての情報を提供します。これらのプロパティは、開発とデバッギングが意図してそれらが使用されていることを強調するために、すべて、Dbg_が前に置かれます。これらのプロパティ型は、Stringです。プロパティを表示するために、MsgBox関数を使用します。

Inspecting interfaces during debugging

Dbg_SupportedInterfacesは、オブジェクトによってサポートされているすべてのインターフェイスの一覧を表示します。 次の例では、オブジェクトは、前のセクションで、オブジェクトの例として説明した関数GetProcessServiceManager()で、返されます。

  oServiceManager = GetProcessServiceManager()
  MsgBox oServiceManager.Dbg_SupportedInterfaces

これは、メッセージボックスの表示するために呼び出されます。：

Dbg_SupportedInterfacesプロパティ

リストには、オブジェクトによってサポートされる、すべてのインターフェイスが含まれています。インターフェイスのために、他のインターフェイスから派生しています。優れたインターフェイスは、com.sun.star.container.XSetのために、上で示されるように、インデントされています。それは、com.sun.star.container.XElementAccessに基づいて、com.sun.star.container.XEnumerationAccessから派生しています。

インタフェース名の後ろに "（ERROR：Not really supported！）"と表示されている場合、オブジェクトの実装には、通常、バグがあります。なぜなら、オブジェクトは、このインターフェイスをサポートするふりをしています。 （com.sun.star.lang.XTypeProviderごとに、しかし、その失敗のための問合わせは、機能しません。詳細については、UNOリフレクションAPIを参照してください）。

Inspecting properties during debugging

Dbg_Propertiesは、com.sun.star.beans.XPropertySetを通して、そして、Basicオブジェクト・プロパティにマッピングされることができるgetとsetメソッドを通して、オブジェクトによって、サポートされる、すべてのプロパティの一覧を表示します。：

  oServiceManager = GetProcessServiceManager()
  MsgBox oServiceManager.Dbg_Properties

このコードは、次の例のようなメッセージボックスを作成します。：

Dbg_Properties

Inspecting Methods During Debugging

Dbg_Methodsは、オブジェクトによってサポートされるすべてのメソッドの一覧を表示します。

例：

  oServiceManager = GetProcessServiceManager()
  MsgBox oServiceManager.Dbg_Methods

このコードは、以下を表示します：

Dbg_Methods

Dbg_PropertiesとDbg_Methodsで使用される表記は、Basicでは、内部の実装型名前を参照します。Sbx接頭辞は、無視されることができます。残りの名前は、通常のBasic型表記に対応しています。SbxEMPTYは、Variantと同じ型です。 Basic型に関する詳細については、次のChapterで利用できます。

Basicは、検出するために、com.sun.star.lang.XTypeProviderインターフェイスを使用しています。それは、オブジェクトをサポートするインタフェースです。

その結果、このインタフェースをサポートすることが重要です。Basicからアクセスできる必要があるコンポーネントを実装するとき、詳細については、UNOコンポーネントを記述するを確認して下さい。

Inspector tools

これらのDbg_プロパティを使用することは、APIオブジェクトの内容を発見する極めて粗雑な方法です。代わりにXrayツールやMRIツールを使用します。

要素のリストは、MsgBoxで表示するには、不便なほど長くなることがあります。コードは、すべてのDbg_要素を、新しいWriter文書に記述するために、利用できます。OpenOffice.org Macros > Tools > Debug > WritedbgInfoを確認して下さい。 Toolsライブラリが、このルーチンを使用するために、読み込む必要があります。：

GlobalScope.BasicLibraries.LoadLibrary( "Tools" )
Call Tools.WritedbgInfo(MyObject)