LuaDoc

• Index

Files

• mz3_lua_api.luadoc

File mz3_lua_api.luadoc

Functions

event_listener1 (serialize_key, event_name, data)	フック関数(タイプ1)
event_listener2 (event_name, text, data)	フック関数(タイプ2)
mz3.add_event_listener (event, event_handler, call_first)	各種イベントに対するフック関数を追加する。 call_first が true の場合、 同一イベントに対して複数のフック関数が登録されている場合、最後に登録された関数から順に呼び出す。 false の場合は逆順に呼び出す。
mz3.alert (msg, title)	Win32 API の MessageBox() を呼び出す。
mz3.camera_capture (wnd)	カメラ撮影(撮影結果のファイル名を返す) ※MZ3 & Pro Mode Only
mz3.change_view (view_name)	ビュー切り替え
mz3.confirm (msg, title, type)	確認画面
mz3.convert_encoding (text, in_encoding, out_encoding)	文字コード変換
mz3.copy_file (from_path, to_path)	ファイルコピー
mz3.decode_html_entity (text)	HTMLエンティティをデコードした文字列を返す。
mz3.estimate_access_type_by_url (url)	URLから類推されるアクセス種別を取得する。
mz3.exec_mz3_command (command)	汎用MZ3コマンドの実行
mz3.get_access_type_by_key (key)	シリアライズキーからアクセス種別を取得する。
mz3.get_app_build_type ()	BuildType("MZ3", "TkTweets")を返す
mz3.get_app_name ()	アプリケーション名("MZ3", "MZ4")を返す
mz3.get_app_version ()	アプリケーションのバージョン("1.0.0 Beta13")を返す
mz3.get_last_request_url ()	前回のリクエストのURL取得
mz3.get_open_file_name (wnd, caption, title, flags, initial_dir, initial_file, filter)	ファイル選択画面の表示
mz3.get_serialize_key_by_access_type (type)	アクセス種別からシリアライズキーを取得する。
mz3.get_service_type (key)	シリアライズキーからサービス種別を取得する。
mz3.get_text_length (text)	文字列の長さ取得
mz3.get_tick_count ()	Win32 API の GetTickCount() を呼び出す。
mz3.is_mixi_logout (serialize_key)	mixiのログアウト状態判定
mz3.keybd_event (key, state)	キーボード操作
mz3.logger_debug (msg)	ログ出力(DEBUGレベル)を行う。
mz3.logger_error (msg)	ログ出力(ERRORレベル)を行う。
mz3.logger_info (msg)	ログ出力(INFOレベル)を行う。
mz3.make_image_logfile_path_from_url_md5 (url)	画像ファイルパス生成(MD5型)
mz3.open_url (wnd, access_type, url, referer, type, user_agent, post, blocking, file_type)	URL を開く MZ3 の通信処理を開始する
mz3.open_url_by_browser (url)	URL をブラウザで開く
mz3.open_url_by_browser_with_confirm (url)	URL をブラウザで開く(確認付き)
mz3.regist_service (service_name, default_selected)	サービス登録(タブの初期化用)
mz3.set_parser (key, parser)	パーサを指定する。
mz3.set_vib_status (vib_status)	[MZ3 only] バイブをON/OFFする バイブをON/OFFする。機種依存により動作しない可能性もある。
mz3.show_common_edit_dlg (caption, msg, initial_text, title)	共通エディット画面の表示
mz3.show_common_select_dlg (caption, initial_text_list, title)	共通選択画面の表示
mz3.show_detail_view (write_view_type, data)	詳細画面の起動
mz3.start_write_view (write_view_type, data)	書き込み画面の起動
mz3.trace (msg)	TRACE出力を行う。MZ3のコンソール付きバージョンのみで表示可能。
mz3.url_encode (text, encoding)	URL エンコードした文字列を返す
mz3_access_type_info.new_access_type ()	新しいアクセス種別の作成
mz3_access_type_info.set_body_header (type, header_no, header_type, header_text)	ヘッダー
mz3_access_type_info.set_body_integrated_line_pattern (type, line_no, pattern)	統合カラムモード(2行表示モード)の行表示パターン
mz3_access_type_info.set_cache_file_pattern (type, file_pattern)	キャッシュファイルのパターン設定
mz3_access_type_info.set_cruise_target (type, is_cruise_target)	巡回対象とするかの設定
mz3_access_type_info.set_default_url (type, url)	デフォルトURLの設定
mz3_access_type_info.set_info_type (type, info_type)	アクセス種別の種別の設定
mz3_access_type_info.set_request_encoding (type, encoding)	エンコーディングの設定
mz3_access_type_info.set_request_method (type, method_type)	リクエストメソッドの設定
mz3_access_type_info.set_serialize_key (type, serialize_key)	シリアライズキーの設定
mz3_access_type_info.set_service_type (type, service_type)	サービス種別の設定
mz3_access_type_info.set_short_title (type, short_title)	簡易タイトルの設定
mz3_account_provider.get_value (service_name, param_name)	アカウント情報の取得(ユーザ設定値の取得)
mz3_account_provider.set_param (service_name, param_name, param_value)	アカウント情報登録(各プラグインでどのような情報が必要か)
mz3_account_provider.set_value (service_name, param_name, param_value)	アカウント情報の設定
mz3_data.add_body_with_extract (data, value)	value からリンク等を抽出、整形し、HTML の整形をして、body 配列に追加する
mz3_data.add_child (data, child)	子要素の追加
mz3_data.add_link_list (data, url, text, type)	link_list に追加する
mz3_data.add_text_array (data, name, value)	name という名前の配列に value を追加する。
mz3_data.clear (data)	各リスト、子要素の削除
mz3_data.create ()	MZ3Data オブジェクトの生成
mz3_data.delete (data)	MZ3Data オブジェクトの破棄 注意：Lua 内で create した MZ3Data オブジェクトは必ず delete すること。
mz3_data.get_access_type (data)	アクセス種別を取得する。
mz3_data.get_date (data)
mz3_data.get_integer (data, name)
mz3_data.get_integer64_as_string (data, name)
mz3_data.get_link_list_size (data)	link_list の個数を取得する
mz3_data.get_link_list_text (data, idx)	link_list から TEXT(キャプション) を取得する
mz3_data.get_link_list_url (data, idx)	link_list から URL を取得する
mz3_data.get_serialize_key* (data)	シリアライズキーを取得する。
mz3_data.get_text (data, name)
mz3_data.get_text_array (data, name, idx)
mz3_data.get_text_array_size (data, name)
mz3_data.parse_date_line (data, line)
mz3_data.set_access_type (data, type)	アクセス種別を設定する。
mz3_data.set_date (data, date)	日付の設定 任意の日付(文字列形式)を設定するために利用します。 通常は mz3_data.parse_date_line を利用して下さい。
mz3_data.set_integer (data, name, value)
mz3_data.set_integer64_from_string (data, name, value)
mz3_data.set_text (data, name, value)
mz3_data_list.add (data_list, data)	data_list の末尾に data を追加する。
mz3_data_list.clear (data_list, data)	data_list の要素をすべて消去する。
mz3_data_list.create ()	data_list の生成
mz3_data_list.delete (data_list)	data_list の消去
mz3_data_list.get_count (data_list)	data_list の個数取得
mz3_data_list.get_data (data_list, idx)	data_list の要素取得
mz3_data_list.insert (data_list, index, data)	data_list の index に data を挿入する。
mz3_data_list.merge (data_list, new_list, max_size)	data_list のmerge
mz3_graphics.draw_image (dc, image_cache_index, x, y, w, h)	画像の描画
mz3_graphics.draw_rect (dc, type, x, y, w, h, color_or_color_name)	矩形の描画
mz3_graphics.draw_text (dc, text, x, y, w, h, format)	文字列の描画
mz3_graphics.get_line_height (dc)	行の高さ
mz3_graphics.set_color (dc, type, color_or_color_name)	色の変更
mz3_graphics.set_font_size (dc, size)	フォントサイズ
mz3_group_data.append_tab (group, tab)	タブをグループに追加する
mz3_group_data.get_group_item_by_name (group, name)	タブ名からグループを取得する
mz3_group_data.get_services (group)	サポートするサービス種別を取得する
mz3_group_item.append_category (tab, title, serialize_key, url)	カテゴリを追加する
mz3_group_item.create (title)	タブを作成する
mz3_group_item.delete (tab)	MZ3GroupItem オブジェクトの削除
mz3_htmlarray.get_all_text (htmlarray, index)	全て結合した文字列を返す
mz3_htmlarray.get_at (htmlarray, index)	index の要素を取得する。
mz3_htmlarray.get_count (htmlarray)	データ数を取得する。
mz3_image_cache.get_image_index_by_url (url)	URLに相当するキャッシュインデックスを取得する
mz3_inifile.get_value (name, section)	ini ファイルから値を取得する
mz3_inifile.set_value* (name, section, value)
mz3_main_view.append_category (title, url, key)	カテゴリの追加
mz3_main_view.get_body_item_list ()	下ペイン要素一覧取得
mz3_main_view.get_body_list_count_per_page ()
mz3_main_view.get_edit_text ()	edit エリアの文字列取得
mz3_main_view.get_focus ()	フォーカス取得
mz3_main_view.get_selected_body_item ()	現在選択中の下ペイン要素取得
mz3_main_view.get_selected_body_item_idx ()	現在選択中の下ペイン要素のインデックス取得
mz3_main_view.get_selected_category_access_type ()	現在選択中の上ペイン要素の種別取得
mz3_main_view.get_selected_category_item ()	現在選択中の上ペイン要素取得
mz3_main_view.get_wnd ()	メインビューの取得
mz3_main_view.redraw_body_images ()	下ペインアイコンの再描画
mz3_main_view.retrieve_category_item ()	カテゴリの再読み込み
mz3_main_view.select_body_item (idx)	現在選択中の下ペイン要素を変更する
mz3_main_view.set_edit_text (text)	edit エリアへの文字列設定
mz3_main_view.set_focus (focus_control)	フォーカス移動
mz3_main_view.set_info_text (text)	info エリアへの文字列設定
mz3_main_view.set_post_mode (mode)	Twitter 風書き込み用モードの変更(書き込み先URL/API識別用) : いわゆるアクセス種別と同じ値
mz3_main_view.update_control_status (mode)	コントロールの再配置
mz3_menu.append_menu (menu, type, title, item_id)	メニューの追加
mz3_menu.append_submenu (menu, title, submenu)	サブメニューの追加
mz3_menu.create_popup_menu ()	メニュー作成 作成したメニュー(返り値)は必ず mz3_menu.delete() で削除すること
mz3_menu.delete (menu)	メニューの破棄
mz3_menu.insert_menu (menu, index, title, item_id)	メニューの挿入 2009/02/10 現在、メイン画面のみサポート。
mz3_menu.popup (menu, wnd)	メニューのポップアップ
mz3_menu.regist_menu (hook_function_name)	メニュー用フック関数の登録。 登録した関数は insert_menu, append_menu で利用可能。
mz3_post_data.append_additional_header (post, text)	POST するヘッダーの追加
mz3_post_data.append_file (post, filename)	ファイル(バイナリファイル)を追加
mz3_post_data.append_post_body (post, text)	POST する文字列の追加
mz3_post_data.create ()	PostData の生成 スレッドセーフではない点に注意！
mz3_post_data.set_content_type (post, content_type)	Content-Type の設定
mz3_report_view.get_wnd ()	レポートビューの取得
mz3_write_view.get_text (name)	書き込み画面の要素の取得
mz3_write_view.get_wnd ()	書き込み画面の取得
mz3_write_view.set_text (name, text, value)	書き込み画面の要素の設定

Functions

event_listener1 (serialize_key, event_name, data)

フック関数(タイプ1)

Parameters

• serialize_key: シリアライズキー
• event_name: イベント名
• data: データ(イベント毎に内容は異なる)

Return value:

[bool] 次のフック関数またはデフォルト動作をさせる場合は false, それ以外は true。

event_listener2 (event_name, text, data)

フック関数(タイプ2)

Parameters

• event_name: イベント名
• text: 文字列
• data: データ(イベント毎に内容は異なる)

Return value:

[bool, integer] 次のフック関数またはデフォルト動作をさせる場合は false, それ以外は true。true 時は integer を返却可能。

mz3.add_event_listener (event, event_handler, call_first)

各種イベントに対するフック関数を追加する。 call_first が true の場合、 同一イベントに対して複数のフック関数が登録されている場合、最後に登録された関数から順に呼び出す。 false の場合は逆順に呼び出す。

Parameters

• event: イベント名
• event_handler: フック関数名({テーブル}.{関数名})
• call_first: コール順序(未指定時はtrueとみなす)

See also:

• event_listener1
• event_listener2

mz3.alert (msg, title)

Win32 API の MessageBox() を呼び出す。

Parameters

• msg: メッセージ
• title: タイトル

mz3.camera_capture (wnd)

カメラ撮影(撮影結果のファイル名を返す) ※MZ3 & Pro Mode Only

Parameters

• wnd: ウィンドウ(mz3_main_view.get_wnd() 等で取得した値)

Return value:

(string) 選択ファイルパス, ユーザキャンセル時は nil

mz3.change_view (view_name)

ビュー切り替え

Parameters

• view_name: ビュー名('main_view', 'report_view', 'write_view')

mz3.confirm (msg, title, type)

確認画面

Parameters

• msg: メッセージ
• title: タイトル
• type: "yes_no", "yes_no_cancel"

Return value:

"yes", "no", "cancel"

mz3.convert_encoding (text, in_encoding, out_encoding)

文字コード変換

Parameters

• text: 対象文字列
• in_encoding: "utf8", "sjis"
• out_encoding: "utf8", "sjis"

mz3.copy_file (from_path, to_path)

ファイルコピー

Parameters

• from_path: コピー元パス
• to_path: コピー先パス

mz3.decode_html_entity (text)

HTMLエンティティをデコードした文字列を返す。

Parameters

• text:

mz3.estimate_access_type_by_url (url)

URLから類推されるアクセス種別を取得する。

Parameters

• url: [string] URL

Return value:

[integer] アクセス種別

mz3.exec_mz3_command (command)

汎用MZ3コマンドの実行

Parameters

• command: コマンド("FONT_SHRINK", "FONT_MAGNIFY", "NEXT_TAB", "PREV_TAB", "CHANGE_MAIN_BODY_HEADER_MODE", "SHORT_CUT_MOVE_ON_MAIN_BODY_LIST")

mz3.get_access_type_by_key (key)

シリアライズキーからアクセス種別を取得する。

Parameters

• key: シリアライズキー

Return value:

[integer] アクセス種別

mz3.get_app_build_type ()

BuildType("MZ3", "TkTweets")を返す

Return value:

[string] アプリケーション名

mz3.get_app_name ()

アプリケーション名("MZ3", "MZ4")を返す

Return value:

[string] アプリケーション名

mz3.get_app_version ()

アプリケーションのバージョン("1.0.0 Beta13")を返す

Return value:

[string] バージョン文字列

mz3.get_last_request_url ()

前回のリクエストのURL取得

mz3.get_open_file_name (wnd, caption, title, flags, initial_dir, initial_file, filter)

ファイル選択画面の表示

Parameters

• wnd: ウィンドウ(mz3_main_view.get_wnd() 等で取得した値)
• caption:
• title: キャプション
• flags: ファイルオープンフラグ(OPENFILENAME:Flags の値)
• initial_dir: 初期ディレクトリ
• initial_file: 初期ファイル
• filter: ファイルフィルタ("JPEGﾌｧｲﾙ (*.jpg)%0*.jpg;*.jpeg%0すべてのﾌｧｲﾙ (*.*)%0*.*%0%0"など) "\0" は引き渡し時に無視されるため "%0" で指定すること。

Return value:

(string) 選択ファイルパス, ユーザキャンセル時は nil

mz3.get_serialize_key_by_access_type (type)

アクセス種別からシリアライズキーを取得する。

Parameters

• type: [integer]アクセス種別

Return value:

[string] シリアライズキー

mz3.get_service_type (key)

シリアライズキーからサービス種別を取得する。

Parameters

• key: シリアライズキー

Return value:

[string] サービス種別

mz3.get_text_length (text)

文字列の長さ取得

Parameters

• text: 対象文字列

Return value:

integer 長さ

mz3.get_tick_count ()

Win32 API の GetTickCount() を呼び出す。

Return value:

[integer] OS起動時からの経過時間(ms)

mz3.is_mixi_logout (serialize_key)

mixiのログアウト状態判定

Parameters

• serialize_key: シリアライズキー

mz3.keybd_event (key, state)

キーボード操作

Parameters

• key: キー値
• state: "keydown" or "keyup"

mz3.logger_debug (msg)

ログ出力(DEBUGレベル)を行う。

Parameters

• msg: 出力する文字列

mz3.logger_error (msg)

ログ出力(ERRORレベル)を行う。

Parameters

• msg: 出力する文字列

Usage:

mz3.logger_error('text')

mz3.logger_info (msg)

ログ出力(INFOレベル)を行う。

Parameters

• msg: 出力する文字列

mz3.make_image_logfile_path_from_url_md5 (url)

画像ファイルパス生成(MD5型)

Parameters

• url: url

Return value:

パス

mz3.open_url (wnd, access_type, url, referer, type, user_agent, post, blocking, file_type)

URL を開く MZ3 の通信処理を開始する

Parameters

• wnd: ウィンドウ(mz3_main_view.get_wnd() 等で取得した値)
• access_type: アクセス種別(アクセス種別に応じて取得メソッド[GET/POST]が自動設定される)
• url: URL
• referer: リファラーURL
• type:
• user_agent: ユーザエージェント(nil の場合 "MZ3" or "MZ4" が自動設定される)
• post: POST 用オブジェクト(未サポート)
• blocking: GET のブロッキング型(未指定時は非ブロッキング型)
• file_type: ファイル種別("text", "binary")

Return value:

なし

mz3.open_url_by_browser (url)

URL をブラウザで開く

Parameters

• url:

mz3.open_url_by_browser_with_confirm (url)

URL をブラウザで開く(確認付き)

Parameters

• url:

mz3.regist_service (service_name, default_selected)

サービス登録(タブの初期化用)

Parameters

• service_name: サービス名
• default_selected: デフォルト状態で選択済みにするかどうか

mz3.set_parser (key, parser)

パーサを指定する。

Parameters

• key: シリアライズキー
• parser: パーサ名({テーブル}.{関数名})

Return value:

なし

mz3.set_vib_status (vib_status)

[MZ3 only] バイブをON/OFFする バイブをON/OFFする。機種依存により動作しない可能性もある。

Parameters

• vib_status: バイブ状態(true:ON, false:OFF)

mz3.show_common_edit_dlg (caption, msg, initial_text, title)

共通エディット画面の表示

Parameters

• caption:
• msg: メッセージ
• initial_text: 初期値
• title: キャプション

Return value:

(string) ユーザ入力値, ユーザキャンセル時は nil

mz3.show_common_select_dlg (caption, initial_text_list, title)

共通選択画面の表示

Parameters

• caption:
• initial_text_list: 初期値(table)
• title: キャプション

Return value:

(string) ユーザ選択値, ユーザキャンセル時は nil

mz3.show_detail_view (write_view_type, data)

詳細画面の起動

Parameters

• write_view_type:
• data: MZ3Data(allow nil)

mz3.start_write_view (write_view_type, data)

書き込み画面の起動

Parameters

• write_view_type: 書き込み種別
• data: MZ3Data(allow nil)

mz3.trace (msg)

TRACE出力を行う。MZ3のコンソール付きバージョンのみで表示可能。

Parameters

• msg: 出力する文字列

mz3.url_encode (text, encoding)

URL エンコードした文字列を返す

Parameters

• text: 対象文字列
• encoding: "utf8", 'euc-jp'

mz3_access_type_info.new_access_type ()

新しいアクセス種別の作成

Return value:

アクセス種別

mz3_access_type_info.set_body_header (type, header_no, header_type, header_text)

ヘッダー

Parameters

• type: アクセス種別
• header_no: ヘッダー番号(1 to 3)
• header_type: ヘッダー種別(何を表示するか : 'date', 'title', 'name', 'body', 'none')
• header_text: ヘッダーに表示する文字列

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_body_integrated_line_pattern (type, line_no, pattern)

統合カラムモード(2行表示モード)の行表示パターン

Parameters

• type: アクセス種別
• line_no: 行番号(1 or 2)
• pattern: パターン

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_cache_file_pattern (type, file_pattern)

キャッシュファイルのパターン設定

Parameters

• type: アクセス種別
• file_pattern:

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_cruise_target (type, is_cruise_target)

巡回対象とするかの設定

Parameters

• type: アクセス種別
• is_cruise_target: 巡回対象とするか

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_default_url (type, url)

デフォルトURLの設定

Parameters

• type: アクセス種別
• url:

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_info_type (type, info_type)

アクセス種別の種別の設定

Parameters

• type: アクセス種別
• info_type: アクセス種別の種別('category', 'body', 'post', 'other')

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_request_encoding (type, encoding)

エンコーディングの設定

Parameters

• type: アクセス種別
• encoding: エンコーディング('sjis', 'euc-jp', 'utf8', 'no-conversion')

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_request_method (type, method_type)

リクエストメソッドの設定

Parameters

• type: アクセス種別
• method_type: 'GET' or 'POST'

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_serialize_key (type, serialize_key)

シリアライズキーの設定

Parameters

• type: アクセス種別
• serialize_key:

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_service_type (type, service_type)

サービス種別の設定

Parameters

• type: アクセス種別
• service_type:

Return value:

[bool] 成功時は true、失敗時は false

mz3_access_type_info.set_short_title (type, short_title)

簡易タイトルの設定

Parameters

• type: アクセス種別
• short_title:

Return value:

[bool] 成功時は true、失敗時は false

mz3_account_provider.get_value (service_name, param_name)

アカウント情報の取得(ユーザ設定値の取得)

Parameters

• service_name: サービス名
• param_name: パラメータ名('id', 'password')

mz3_account_provider.set_param (service_name, param_name, param_value)

アカウント情報登録(各プラグインでどのような情報が必要か)

Parameters

• service_name: サービス名
• param_name: パラメータ名('id_name', 'password_name')
• param_value: パラメータ値

mz3_account_provider.set_value (service_name, param_name, param_value)

アカウント情報の設定

Parameters

• service_name: サービス名
• param_name: パラメータ名('id', 'password')
• param_value: パラメータ値

mz3_data.add_body_with_extract (data, value)

value からリンク等を抽出、整形し、HTML の整形をして、body 配列に追加する

Parameters

• data:
• value:

mz3_data.add_child (data, child)

子要素の追加

Parameters

• data:
• child:

mz3_data.add_link_list (data, url, text, type)

link_list に追加する

Parameters

• data: MZ3Data オブジェクト
• url: URL
• text: Text
• type: 'list'(default) or 'page'(ページ変更リンク用)

mz3_data.add_text_array (data, name, value)

name という名前の配列に value を追加する。

Parameters

• data:
• name:
• value:

mz3_data.clear (data)

各リスト、子要素の削除

Parameters

• data:

mz3_data.create ()

MZ3Data オブジェクトの生成

Return value:

MZ3Data オブジェクト

mz3_data.delete (data)

MZ3Data オブジェクトの破棄 注意：Lua 内で create した MZ3Data オブジェクトは必ず delete すること。

Parameters

• data: MZ3Data オブジェクト

Return value:

なし

mz3_data.get_access_type (data)

アクセス種別を取得する。

Parameters

• data: MZ3Data オブジェクト

Return value:

[integer]アクセス種別

mz3_data.get_date (data)

Parameters

• data:

mz3_data.get_integer (data, name)

Parameters

• data:
• name:

mz3_data.get_integer64_as_string (data, name)

Parameters

• data:
• name:

mz3_data.get_link_list_size (data)

link_list の個数を取得する

Parameters

• data:

mz3_data.get_link_list_text (data, idx)

link_list から TEXT(キャプション) を取得する

Parameters

• data: MZ3Data オブジェクト
• idx: インデックス

Return value:

idx が不正な場合は nil、それ以外は URL 文字列を返す

mz3_data.get_link_list_url (data, idx)

link_list から URL を取得する

Parameters

• data: MZ3Data オブジェクト
• idx: インデックス

Return value:

idx が不正な場合は nil、それ以外は URL 文字列を返す

mz3_data.get_serialize_key* (data)

シリアライズキーを取得する。

Parameters

• data: MZ3Data オブジェクト

Return value:

[string]シリアライズキー

mz3_data.get_text (data, name)

Parameters

• data:
• name:

mz3_data.get_text_array (data, name, idx)

Parameters

• data:
• name:
• idx:

mz3_data.get_text_array_size (data, name)

Parameters

• data:
• name:

mz3_data.parse_date_line (data, line)

Parameters

• data:
• line:

mz3_data.set_access_type (data, type)

アクセス種別を設定する。

Parameters

• data: MZ3Data オブジェクト
• type: [integer]アクセス種別

Return value:

なし

mz3_data.set_date (data, date)

日付の設定 任意の日付(文字列形式)を設定するために利用します。 通常は mz3_data.parse_date_line を利用して下さい。

Parameters

• data: MZ3Data オブジェクト
• date: 日付文字列

Return value:

なし

mz3_data.set_integer (data, name, value)

Parameters

• data:
• name:
• value:

mz3_data.set_integer64_from_string (data, name, value)

Parameters

• data:
• name:
• value:

mz3_data.set_text (data, name, value)

Parameters

• data:
• name:
• value:

mz3_data_list.add (data_list, data)

data_list の末尾に data を追加する。

Parameters

• data_list:
• data:

mz3_data_list.clear (data_list, data)

data_list の要素をすべて消去する。

Parameters

• data_list:
• data:

mz3_data_list.create ()

data_list の生成

mz3_data_list.delete (data_list)

data_list の消去

Parameters

• data_list:

mz3_data_list.get_count (data_list)

data_list の個数取得

Parameters

• data_list:

mz3_data_list.get_data (data_list, idx)

data_list の要素取得

Parameters

• data_list:
• idx:

mz3_data_list.insert (data_list, index, data)

data_list の index に data を挿入する。

Parameters

• data_list:
• index:
• data:

mz3_data_list.merge (data_list, new_list, max_size)

data_list のmerge

Parameters

• data_list:
• new_list:
• max_size:

mz3_graphics.draw_image (dc, image_cache_index, x, y, w, h)

画像の描画

Parameters

• dc:
• image_cache_index:
• x:
• y:
• w:
• h:

mz3_graphics.draw_rect (dc, type, x, y, w, h, color_or_color_name)

矩形の描画

Parameters

• dc: DC
• type: "border" or "fill"
• x: x
• y: y
• w: w
• h: h
• color_or_color_name: 文字列の場合はスキンのカラー名、数値の場合はRGB色

mz3_graphics.draw_text (dc, text, x, y, w, h, format)

文字列の描画

Parameters

• dc:
• text:
• x:
• y:
• w:
• h:
• format:

mz3_graphics.get_line_height (dc)

行の高さ

Parameters

• dc: DC

Return value:

行の高さ(px)

mz3_graphics.set_color (dc, type, color_or_color_name)

色の変更

Parameters

• dc: DC
• type: "text" or "bg"
• color_or_color_name: 文字列の場合はスキンのカラー名、数値の場合はRGB色

Return value:

元の色

mz3_graphics.set_font_size (dc, size)

フォントサイズ

Parameters

• dc: DC
• size: 1:大、0:標準、-1:小

mz3_group_data.append_tab (group, tab)

タブをグループに追加する

Parameters

• group: MZ3GroupData
• tab: MZ3GroupItem

mz3_group_data.get_group_item_by_name (group, name)

タブ名からグループを取得する

Parameters

• group: MZ3GroupData
• name: タブ名

Return value:

MZ3GroupItem

mz3_group_data.get_services (group)

サポートするサービス種別を取得する

Parameters

• group: MZ3GroupData

Return value:

サポートするサービス種別のスペース区切り文字列。サービス種別は mz3.regist_service() で登録した文字列。

mz3_group_item.append_category (tab, title, serialize_key, url)

カテゴリを追加する

Parameters

• tab: [MZ3GroupItem] タブ
• title: 表示タイトル
• serialize_key: 関連付ける種別のシリアライズキー
• url: 取得先URL

Return value:

成功時は true、失敗時は false

mz3_group_item.create (title)

タブを作成する

Parameters

• title: タブの名称

Return value:

[MZ3GroupItem] tab

mz3_group_item.delete (tab)

MZ3GroupItem オブジェクトの削除

Parameters

• tab: [MZ3GroupItem] タブ

mz3_htmlarray.get_all_text (htmlarray, index)

全て結合した文字列を返す

Parameters

• htmlarray:
• index:

mz3_htmlarray.get_at (htmlarray, index)

index の要素を取得する。

Parameters

• htmlarray:
• index:

mz3_htmlarray.get_count (htmlarray)

データ数を取得する。

Parameters

• htmlarray:

mz3_image_cache.get_image_index_by_url (url)

URLに相当するキャッシュインデックスを取得する

Parameters

• url: 画像URL

mz3_inifile.get_value (name, section)

ini ファイルから値を取得する

Parameters

• name: iniファイル値
• section: iniファイル値のセクション

Usage:

 t = mz3_inifile.get_value("UseGlobalProxy", "General") 

Return value:

[string] iniの値

mz3_inifile.set_value* (name, section, value)

Parameters

• name:
• section:
• value:

mz3_main_view.append_category (title, url, key)

カテゴリの追加

Parameters

• title: タイトル
• url: URL
• key: シリアライズキー

mz3_main_view.get_body_item_list ()

下ペイン要素一覧取得

mz3_main_view.get_body_list_count_per_page ()

mz3_main_view.get_edit_text ()

edit エリアの文字列取得

mz3_main_view.get_focus ()

フォーカス取得

Return value:

string フォーカスコントロール("edit", "category_list", "body_list", "other")

mz3_main_view.get_selected_body_item ()

現在選択中の下ペイン要素取得

mz3_main_view.get_selected_body_item_idx ()

現在選択中の下ペイン要素のインデックス取得

mz3_main_view.get_selected_category_access_type ()

現在選択中の上ペイン要素の種別取得

mz3_main_view.get_selected_category_item ()

現在選択中の上ペイン要素取得

mz3_main_view.get_wnd ()

メインビューの取得

mz3_main_view.redraw_body_images ()

下ペインアイコンの再描画

mz3_main_view.retrieve_category_item ()

カテゴリの再読み込み

mz3_main_view.select_body_item (idx)

現在選択中の下ペイン要素を変更する

Parameters

• idx: 選択要素のインデックス

mz3_main_view.set_edit_text (text)

edit エリアへの文字列設定

Parameters

• text: 設定する文字列

mz3_main_view.set_focus (focus_control)

フォーカス移動

Parameters

• focus_control: フォーカス移動先コントロール("edit", "category_list", "body_list")

mz3_main_view.set_info_text (text)

info エリアへの文字列設定

Parameters

• text: 設定する文字列

mz3_main_view.set_post_mode (mode)

Twitter 風書き込み用モードの変更(書き込み先URL/API識別用) : いわゆるアクセス種別と同じ値

Parameters

• mode: モード値

mz3_main_view.update_control_status (mode)

コントロールの再配置

Parameters

• mode:

mz3_menu.append_menu (menu, type, title, item_id)

メニューの追加

Parameters

• menu: メニュー用オブジェクト
• type: メニュー種別("string", "separator")
• title: タイトル
• item_id: regist_menu の返り値

mz3_menu.append_submenu (menu, title, submenu)

サブメニューの追加

Parameters

• menu: メニュー用オブジェクト
• title: タイトル
• submenu: サブメニュー用オブジェクト

mz3_menu.create_popup_menu ()

メニュー作成 作成したメニュー(返り値)は必ず mz3_menu.delete() で削除すること

mz3_menu.delete (menu)

メニューの破棄

Parameters

• menu: メニュー用オブジェクト

mz3_menu.insert_menu (menu, index, title, item_id)

メニューの挿入 2009/02/10 現在、メイン画面のみサポート。

Parameters

• menu: メニュー用オブジェクト
• index: 追加位置(0オリジン)
• title: タイトル
• item_id: regist_menu の返り値

mz3_menu.popup (menu, wnd)

メニューのポップアップ

Parameters

• menu: メニュー用オブジェクト
• wnd: 親ウィンドウ

mz3_menu.regist_menu (hook_function_name)

メニュー用フック関数の登録。 登録した関数は insert_menu, append_menu で利用可能。

Parameters

• hook_function_name: メニュー押下時のフック関数名

mz3_post_data.append_additional_header (post, text)

POST するヘッダーの追加

Parameters

• post: POST 用オブジェクト
• text: 追加する文字列

mz3_post_data.append_file (post, filename)

ファイル(バイナリファイル)を追加

Parameters

• post: POST 用オブジェクト
• filename: ファイル名

mz3_post_data.append_post_body (post, text)

POST する文字列の追加

Parameters

• post: POST 用オブジェクト
• text: 追加する文字列

mz3_post_data.create ()

PostData の生成 スレッドセーフではない点に注意！

mz3_post_data.set_content_type (post, content_type)

Content-Type の設定

Parameters

• post: POST 用オブジェクト
• content_type: Content-Type 値

mz3_report_view.get_wnd ()

レポートビューの取得

mz3_write_view.get_text (name)

書き込み画面の要素の取得

Parameters

• name: 取得したい要素名('title_edit', 'body_edit')

mz3_write_view.get_wnd ()

書き込み画面の取得

mz3_write_view.set_text (name, text, value)

書き込み画面の要素の設定

Parameters

• name: 設定したい要素名('title_edit', 'body_edit')
• text:
• value: 設定したい文字列