アドオンAPIのリファレンス

アドオンAPIは、多くの便利なAPIを持ち合わせています。

class AddonAPI
完全名

libmarusoftware.addon.AddonAPI

api_ver: int

アドオンAPIのバージョン

api_ver_minor: int

アドオンAPIのマイナーバージョン

name: str

アドオンの名前

logger: Logger

アドオン用ロガーオブジェクト

appinfo: dict

Marutoolsの動作環境情報

ext: str

開くことのできるファイル拡張子

ui: UI

UIコントローラー

app: Core

Marutoolsコア

saved: bool

ファイルが保存されているかどうかのフラグ

UI

UIコントローラークラス

注釈

ここにあるのはウェジットを作成する関数のみです。ウェジットに対して操作を行うにはウェジットオブジェクト下にある関数を使用する必要があります。

class UI
parent

親UIオブジェクト。ない場合は None

type: str
UIオブジェクトの種類。UIオブジェクトはフレームウィジェットかウィンドウを示します。
main:メインウィンドウ
frame:フレームウェジット
dialog:ダイアログウェジット(警告ウィンドウのようなもの)
sub:サブウィンドウ
backend: str
バックエンドの名前
tkinter:tkinter(GUIライブラリー)
changeTitle(title)

ウィンドウのタイトル変更

警告

UIオブジェクトの型が main か sub の時のみ、正常に動作します。

パラメータ

title (str) -- 設定するタイトル

changeIcon(icon_path)

ウィンドウのアイコン(タイトルバーとタスクバーの)を変更

警告

UIオブジェクトの型が main か sub の時のみ、正常に動作します。

パラメータ

title (str) -- 設定するアイコンのファイルパス

fullscreen(tf=None)

ウィンドウをフルスクリーンに展開する

警告

UIオブジェクトの型が main か sub の時のみ、正常に動作します。

パラメータ

tf (bool) -- True ならフルスクリーンに、False なら通常のスクリーンに、何も指定しなかった場合は、通常のスクリーンサイズになります。

changeSize(size)

ウィンドウのサイズを変更

警告

UIオブジェクトの型が main か sub の時のみ、正常に動作します。

パラメータ

size (str) -- {横}x{縦}+{x}+{y}

uisetting(frame, txt)

UIの設定のウェジット

パラメータ

  • frame (libmarusoftware.Frame) -- フレームの設定表示

  • txt (Lang) -- 翻訳されたテキストを格納するdictに似たオブジェクト

setcallback(name, callback)

コールバックを設定する

パラメータ

  • name (str) --

    コールバック名
    close:ウィンドウが閉じられたとき
    macos_help:Macosでヘルプメニューボタンが押されたとき
    macos_settings:Macosで設定ボタンが押されたとき。

  • callback (callable) -- コールバック関数

makeSubwindow(dialog=False, **options)

サブウィンドウを作成

パラメータ

dialog (bool) -- ダイアログモード

close()

ウィンドウまたはフレームを閉じる

wait()

ウィンドウが閉じられるまで待機

警告

UIオブジェクトの型が main か sub の時のみ、正常に動作します。

exist()

ウィンドウ・フレームを開かれているかどうかを返します。

戻り値

ウィンドウ・フレームが開かれているかどうか

戻り値の型

bool

mainloop()

ウィンドウのメインループ

警告

UIオブジェクトの型が main の時のみ、正常に動作します。 また、二回以上同時に実行することはできません。

Frame()

フレームウィジェット

戻り値

フレームウェジットのオブジェクト

戻り値の型

UI

Label(label=None)

ラベルウィジェット

パラメータ

label (str) -- ラベルテキスト

戻り値

ラベルウェジットのオブジェクト

戻り値の型

WidgetBase

Image(image=None)

画像ウィジェット

戻り値

画像ウェジットのオブジェクト

戻り値の型

WidgetBase

Menu()

メニューウェジット

戻り値

メニューウェジットのオブジェクト

戻り値の型

Menu

Notebook()

タブ切り替えウェジット

戻り値

タブ切り替えウェジットのオブジェクト

戻り値の型

Notebook

Dialog: Dialog
Input: Input
class Dialog
askfile(multi=False, save=False)

ファイルパスを尋ねるダイアログ

パラメータ

  • multi (bool) -- 複数選択の可否

  • save (bool) -- 保存するファイルのパス(true)か開くファイルのパス(False)

戻り値

ファイルパス

戻り値の型

str or None

askdir()

ディレクトリ(フォルダ)を尋ねるダイアログ

戻り値

ディレクトリのパス

戻り値の型

str

error()

エラーダイアログを表示

info()

情報ダイアログを表示

warn()

警告ダイアログの表示

question(type, title, message)

確認ダイアログ

パラメータ

  • type (str) --

    質問の種類
    okcancel: "ok"(True を返す)と"cancel"(False を返す)から選ぶ
    retrycancel: "retry"(True)と"cancel"(False) から選ぶ
    yesno: "yes"(True)と"no"(False)から選ぶ
    yesnocancel: "yes"(True)と"no"(False)と"cancel"(None)から選ぶ
    text: テキスト入力。 もし、キャンセルされたときは、None を返す。

  • title (str) -- ダイアログのタイトル

  • message (str) -- ダイアログのメッセージ

戻り値

選択(または入力)された値

戻り値の型

bool or str or None

class Input
Button(label='', command=None)

ボタンウィジェット

パラメータ

  • label (str) -- ボタンのラベル

  • command (callable) -- ボタンが押されたときのコールバック

戻り値

ボタンウィジェットのオブジェクト

戻り値の型

Button

List()

表ウィジェット

戻り値

表ウェジットのオブジェクト

戻り値の型

List

Form(type='text', command=None)

一行テキスト入力ウィジェット

パラメータ

  • type (str) --

    フォームの種類
    text: 通常のプレーンテキストの入力
    password: パスワードの入力.
    filesave: 保存するファイルを尋ねる
    fileopen: 開くファイルを尋ねる
    fileopenmulti: 開くファイルを尋ねる (複数選択可)。
    filesavemulti: 保存するファイルを尋ねる (複数選択可)。

  • command (callable) -- フォームのテキストが変更された時のコールバック

戻り値

フォームウェジットのオブジェクト

戻り値の型

Form

Text(scroll=True, command=None)

テキスト入力ウェジット(複数行)。

パラメータ

  • scroll (bool) -- スクロールバーの有無

  • command (callable) -- テキストが変更された時のコールバック

  • readonly (bool) -- 読み取り専用

戻り値

テキストウェジットのオブジェクト(複数行入力)

戻り値の型

Text

CheckButton(label=None, command=None, default=False)

チェックボタンウィジェット

パラメータ

  • label (str) -- ボタンのラベル

  • command (callable) -- チェックボタンがクリックされた時のコールバック

  • default (bool) -- 初期値

戻り値

チェックボタンウィジェットのオブジェクト

戻り値の型

CheckButton

Select(default='', command=None, values=[], inline=False, label='')

選択ウィジェット

パラメータ

  • default (str) -- 初期値

  • command (callable) -- 要素が選択された時のコールバック

  • values (List[str]) -- 選択される値のリスト

  • inline (bool) -- インラインモード

  • label (str) -- 選択ウィジェットのラベル

戻り値

選択ウィジェットのオブジェクト

戻り値の型

Select

ロガー

編集中…

class Logger