マクロ
|
| Variable | Type | Description |
| ctx | pyuno | コンポーネントコンテキスト |
| config | mytools_Mri.config.Config | 設定 |
| web | mytools_Mri.web.IDL | ウェブページなどをウェブブラウザで開く |
| engine | mytools_Mri.engine.Engine | イントロスペクションとリフレクション |
| history | mytools_Mri.node.Root | 履歴の階層構造 |
| current | mytools_Mri.engine.Entry | 現在のエントリ |
| cg | mytools_Mri.cg.CodeGenerator | コードジェネレータを管理 |
| mode | bool | ノーマルモードのとき True、False ではマクロモード |
| open_new | bool | True のとき次のターゲーットを新規ウィンドウで開きます |
| macros | mytools_Mri.macros.Macros | マクロを管理 |
| ui | mytools_Mri.ui.MRIUi | ユーザーインターフェース |
css.uno.XComponentContext インターフェースを ctx インスタンス変数に保持しています。新規サービスが必要な場合などに利用できます。
MRI は現在のターゲーットを current インスタンス変数に保持しています。この値は mytools_Mri.engine.Entry クラスのインスタンスです。
エンジンは UNO オブジェクトの情報を取得するためのコアオブジェクトです。このクラスでは css.beans.Introspection、 css.reflection.CoreReflection と css.reflection.TypeDescription サービスを利用しています。mytools_Mri.engine.Engine クラスで実装されています。エンジンインスタンスは MRI の engine インスタンス変数から取得できます。
def use_engine(mri):
""" Shows type name of the current target. """
engine = mri.engine
current = mri.current
mri.ui.message(engine.get_type_name(current))
ウェブオブジェクトは設定で指定されたウェブブラウザを開く手助けをしてくれます。mytools_Mri.web.IDL クラスで実装されています。
def open_url(mri):
""" URL をウェブブラウザで開く """
url = "http://example.com/"
mri.web.open_url(url)
def open_ref(mri):
""" IDL リファレンスを開きます。
二番目の引数はオプションです。 """
idl = "com.sun.star.awt.Rectangle"
name = "X"
mri.web.open_idl_reference(idl, name)
mytools_Mri.ui.MRIUi クラスは MRI のウィンドウを管理します。
| Variable | Type | Description |
| ctx | pyuno | コンポーネントコンテキスト |
| main | mytools_Mri.MRI | MRI インスタンス |
| desktop | pyuno | デスクトップインスタンス |
| listeners | dict | リスナー |
| property_mode | bool | True のときプロパティを取得。False で設定 |
| tree | mytools_Mri.ui.pages.HistoryTreeUi | ツリー構造の履歴 |
| dlgs | mytools_Mri.ui.dialogs.Dialogs | ダイアログを提供します |
| status_eraser | threading.Timer | ステータス文字列を消去するタイマー |
| frame | pyuno | MRI ウィンドウの入ったフレーム |
| cont | pyuno | コンテナウィンドウ |
| pages | mytools_Mri.ui.pages.InfoUi/GridUi | コントロールへのアクセスを提供 |
mytools_Mri.ui.dialogs.Dialogs クラスが提供するダイアログが利用できます。MRIUi インスタンスの dlgs インスタンス変数からアクセスできます。
def dialog_select(mri):
items = ("Item 1", "Item 2", "Item 3", "Item 1")
item = mri.ui.dlgs.dialog_select(items, "Title")
mri.ui.dlgs.dialog_info("%s is selected. " % item)
dialog_select メソッドの二番目の引数はダイアログのタイトルを指定します。この例では二つの Item 1 がありますが、これらを区別したいときには三番目の引数に True を指定してください。そうすると返り値として選択された値ではなく選択された位置が返ります。キャンセルされたときには None が返ります。
ユーザーに入力させたいときには dialog_input メソッドを利用してください。
def dialog_input(mri):
text = mri.ui.dlgs.dialog_input(
"Service Name", "Input a service name.",
"com.sun.star.awt.")
mri.ui.message(text)
全ての引数は省略可能です。
履歴から項目を選択させるダイアログがあります。
def history_selector(mri):
entry = mri.ui.dlgs.history_selector("Select Entry")
if entry:
mri.ui.message(entry.name)
返り値は mytools_Mri.engine.Entry クラスのインスタンスです。
メッセージを表示したり、ユーザーの反応が必要なときには message メソッドを利用できます。このメソッドは css.awt.XMessageBoxFactory へのショートカットを提供します。詳細についてはリファレンスを参照してください。メソッドは次のように定義されています。
def message(self, message, title="", type="messbox", buttons=1):
Entry クラスは現在またはそれ以外のターゲットを保持するために利用されています。例えば、現在のターゲットは MRI インスタンスの current インスタンス変数から取得できます。Entry クラスは mytools_Mri.engine モジュールで定義されており、次のような継承関係を持っています。
mytools_Mri.engine.Entry < (mytools_Mri.engine.EntryBase, mytools_Mri.node.Node)
Entry クラスは二つの親クラスを継承していますが、自身ではメソッドを定義していません。Node クラスは履歴の階層構造を構築するためのものです。EntryBase クラスはそのインスタンスを利用したマクロを書くための重要なメソッドを定義しています。
次の表では Entry クラスのインスンタンス変数を説明します。
| Variable | Type | Description |
| target | object | インスタンスがラップしている実際の値 |
| inspected | pyuno | css.beans.XIntrospectionAccess インターフェース |
| type | pyuno | css.reflection.CoreReflection による IDL 型情報 |
| mri | mytools_Mri.MRI | MRI への参照 |
| code_entry | mytools_Mri.cg.CodeEntry | コード生成用の情報 |
次の表に示したメソッドも提供しています。
| Method | Description |
| get_target() | target インスタンス変数を利用してください |
| has_interface(name) | ターゲットが指定したインターフェースをエクスポートしているかどうか調べます。 |
| supports_service(name) | ターゲットが指定したサービスをサポートしているかどうか調べます。 |
| append(obj) | obj をリストに追加します。このメソッドは MRI インスタンスの create_sequence メソッドで作成されたエントリのみで動作します |
MRIUi の pages インスタンス変数は mytools_Mri.pages.InfoUi または GridUi クラスのインスタンスを保持しています。どちらの値かどうかはウィンドウに表示されているコントロールに依存します。これらのクラスの継承構造は少し複雑です。次に示す継承構造のクラスは全て mytools_Mri.ui.pages モジュールで定義されています。
InfoUi < (Ui, PageStatus, Pages < PagesBase) GridUi < (Ui, PageStatus, GridPages < GridPagesBase < PagesBase)
Ui クラスは型や実装名、検索と履歴のコントロールへのアクセスを提供します。次の表に Ui クラスで定義されている重要なメソッドを示します。
| Method | Description |
| get_type_name() | 型名を返します |
| set_type_name(name) | 型名を設定します |
| get_imple_name() | 実装名を返します |
| set_imple_name(name) | 実装名を設定します |
| get_code() | 現在のコードのテキストを返します |
| set_code(txt) | コードのテキストを設定します |
PageStatus クラスは情報ページのステータスを保持しています。
PagesBase クラスはその子クラスで定義するべきクラスを定義しており、情報のコントロールへのアクセスを提供します。これらのメソッドは index を引数に取ります。これらの値は Properties: 0, Methods: 1, Interfaces: 2, Services 3 です。
| Method | Description |
| get_selected(index=None) | 選択されているテキストを返します |
| get_current_line(index=None) | 現在の行のテキストを返します |
| get_first_word(index=None) | 現在の行の最初の単語を返します |
| activate(index) | アクティブなページを設定します |
| get_active() | アクティブなページを設定します |
| search(search_text, index=None) | 検索します |
これらのコントロールの内容は最初にアクティブになったときに更新されることに注意してください。
MRI はウィンドウのフレームに接続される独自のコントローラを利用しています。コントローラ自身は Python で書かれており、MRI インスタンスへのアクセスを可能にします。全ての MRI ウィンドウはデスクトップのフレームに登録されており、css.frame.XFrame インターフェースからアクセスできます。
def do_something_with(mri):
# デスクトップから MRI ウィンドウを探す
found = None
frames = mri.ui.desktop.getFrames()
for i in range(frames.getCount()):
frame = frames.getByIndex(i)
if frame.getTitle() == "MRI":
found = frame
break
if found:
controller = found.getController()
# もうひとつの MRI の MRIUi インスタンス
ui = controller.ui
mri2 = ui.main # instance of mytools_Mri.MRI
この方法はオフィースの同じ Python インスタンスで動作している全ての Python コードで利用できます。bundle.py - Diff マクロはこの方法で他の MRI からターゲットエントリを取得します。
MRI ウィンドウの構造を示します。
frame: css.frame.Frame
- Controller: mytools_Mri.ui.controller.Controller
- Model: always None
- Container Window: general window
- Component Window: css.awt.UnoControlContainer
- splitter: does not added in the container
- label_status: FixedText keeps status text.
- edit_type: Edit shows type information.
- edit_in: Edit shows implementation name.
- list_hist: List of history.
- btn_back: Back button.
- btn_forward: Forward button.
- edit_search: Search edit.
- btn_search: Search Button.
- btn_tree: Open tree button.
- btn_index_acc: Index button.
- btn_name_acc: Name button.
- subcont: css.awt.UnoControlContainer (without tab)
- info_0:
- info_1:
- info_2:
- info_3:
- subcont: css.awt.UnoControlContainer (with tab)
- page_0
- info_0
- page_1
- info_1
- page_2
- info_2
- page_3
- info_3
subcont の構造はタブコントロールを利用しているかどうかで変化します。MRIUi クラスの pages インスタンスがコントロールへの簡単なアクセス方法を提供しています。
拡張機能パッケージの Macros ディレクトリにある bundle.py ファイルにいくつか例があります。
以下の短いコードで現在の図形描写コレクションから子図形描写オブジェクトをインスペクトします。
def inspect_shapes(mri):
""" Inspect Shapes
Inspect all shapes in this container. """
shape = mri.current # current target
# check current shape is correct type
if shape.supports_service("com.sun.star.drawing.ShapeCollection"):
# getCount call is not collected to code
for i in range(shape.target.getCount()):
child = shape.getByIndex(i)
Entry クラスの supports_service メソッドはそのターゲットが正しい型かどうかを調べるために利用できます。ターゲットが css.lang.XServiceInfo インターフェースをサポートしていなければ False が返ります。型が無効なことをユーザーに示したければ、例外を raise するか mri.message メソッドでメッセージを表示してください。
Entry インスタンスは実際の値をラップしています。ターゲットの実際の値が必要なら target インスタンス変数を参照してください。
def show_property_value(mri):
current = mri.current
ui = mri.ui
ui.message(current.target)
