Skip to content

Latest commit

 

History

History
524 lines (345 loc) · 16.6 KB

functions.org

File metadata and controls

524 lines (345 loc) · 16.6 KB

Fakeymacs functions manual

関数（Functions）

拡張機能（Extensions）を作成する際に利用する可能性がある関数は以下のとおりです。

■ checkWindow

ウィンドウが指定した条件に該当するかチェックする

Function

def checkWindow(process_name, class_name, text, window=None):

Parameters

ParameterDescription
process_nameウインドウの所属するプロセス名（Unix のシェル形式のワイルドカードで指定可能）
class_nameウインドウのクラス名（Unix のシェル形式のワイルドカードで指定可能）
textウインドウのタイトル文字列（Unix のシェル形式のワイルドカードで指定可能）
windowpyauto.Windowオブジェクト（default 値の場合はキーボードフォーカスを持っているウインドウ）

Returns

  • True : 該当する
  • False : 該当しない

■ define_key

キーマップにキーを定義する

Function

def define_key(window_keymap, keys, command, skip_check=True):

Parameters

ParameterDescription
window_keymapWindowKeymapオブジェクト
keys設定するキー（マルチストロークのキーはスペースで区切る）
command実行するコマンド（関数）
skip_checkキー設定のスキップ判定を行うかどうかを指定する

Returns

  • 無し

■ define_key2

キーマップにキーを定義する（skip_settings_key に定義したキーであっても設定するバージョン）

Function

def define_key2(window_keymap, keys, command):

Parameters

ParameterDescription
window_keymapWindowKeymapオブジェクト
keys設定するキー（マルチストロークのキーはスペースで区切る）
command実行するコマンド（関数）

Returns

  • 無し

■ define_key3

キーマップにキーを定義する（キーに定義されている関数に新しいコマンドを分岐実行させるバージョン）

Function

def define_key3(window_keymap, keys, command, chek_func):

Parameters

ParameterDescription
window_keymapWindowKeymapオブジェクト
keysキーの定義（マルチストロークのキーはスペースで区切る）
command実行するコマンド（関数）
check_func新しいコマンドを実行するかを判定する関数

Returns

  • 無し

■ mergeMultiStrokeKeymap

第2引数の WindowKeymapオブジェクトのキーマップにに第1引数の WindowKeymapオブジェクトの キーマップをマージ（上書き）し、第1引数の WindowKeymapオブジェクトのキーマップに設定する

Function

def mergeMultiStrokeKeymap(window_keymap1, window_keymap2, keys):

Parameters

ParameterDescription
window_keymap1WindowKeymapオブジェクト1
window_keymap2WindowKeymapオブジェクト2
keysマージするマルチストロークのキー

Returns

  • 無し

■ getKeyAction

キーにより実行されるアクションを取り出す関数を返す

Function

def getKeyAction(key):

Parameters

ParameterDescription
keyキーにより実行されるアクションを取り出すキー

Returns

  • キーにより実行されるアクションを取り出す関数

■ getKeyCommand

キーに定義されている関数を返す

Function

def getKeyCommand(window_keymap, keys):

Parameters

ParameterDescription
window_keymapWindowKeymapオブジェクト
keys定義されている関数を取り出すキー（マルチストロークのキーはスペースで区切る）

Returns

  • キーに定義されている関数

■ makeKeyCommand

キーに定義されている関数に新しいコマンドを分岐実行させる新たな関数を返す

Function

def makeKeyCommand(window_keymap, keys, command, check_func):

Parameters

ParameterDescription
window_keymapWindowKeymapオブジェクト
keys定義されている関数を取り出すキー（マルチストロークのキーはスペースで区切る）
command新しく実行するコマンド（関数）
check_func新しいコマンドを実行するかを判定する関数

Returns

  • キーに定義されている関数に新しいコマンドを分岐実行させる新たな関数

■ InputKeyCommand

キーを入力する関数を返す （Microsoft Word 等で Ctrl に反応してサブウインドウが開き、そのサブウインドウに カーソルが移動するのを抑制する対策がされた keymap.InputKeyCommand 関数を返す）

Function

def InputKeyCommand(*key_list, usjis_conv=True):

Parameters

ParameterDescription
*key_list入力するキーの羅列（キー文字列をカンマで区切って指定する）
usjis_convキーの US -> JIS 変換を行うかどうかを指定する

Returns

  • 引数で指定したキーを入力する関数

■ self_insert_command

キーを入力する関数を返す（InputKeyCommand の上位関数）

Function

def self_insert_command(*key_list, usjis_conv=True):

Parameters

ParameterDescription
*key_list入力するキーの羅列（キー文字列をカンマで区切って指定する）
usjis_convキーの US -> JIS 変換を行うかどうかを指定する

Returns

  • 引数で指定したキーを入力する関数

■ self_insert_command2

キーを入力する関数を返す （Emacs 日本語入力モード使用時で IME が ON の際、文字を入力すると Emacs 日本語入力モード に移行するバージョン）

Function

def self_insert_command2(*key_list, usjis_conv=True):

Parameters

ParameterDescription
*key_list入力するキーの羅列（キー文字列をカンマで区切って指定する）
usjis_convキーの US -> JIS 変換を行うかどうかを指定する

Returns

  • 引数で指定したキーを入力する関数

■ self_insert_command3

キーを入力する関数を返す（キーの入力後、IME を OFF にするバージョン）

Function

def self_insert_command3(*key_list, usjis_conv=True):

Parameters

ParameterDescription
*key_list入力するキーの羅列（キー文字列をカンマで区切って指定する）
usjis_convキーの US -> JIS 変換を行うかどうかを指定する

Returns

  • 引数で指定したキーを入力する関数

■ mark

mark がセットされていれば、その mark から func で移動した場所までのリージョンを拡張する ための新たな関数を返す

Function

def mark(func, forward_direction):

Parameters

ParameterDescription
func処理を施す関数
forward_directionfunc で指定した関数が前方に進む処理の場合は True、そうでない場合は False を指定する

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ mark2

func で移動した場所までのリージョンを拡張するための新たな関数を返す （Shift を使ったリージョン拡張処理などで利用）

Function

def mark2(func, forward_direction):

Parameters

ParameterDescription
func処理を施す関数
forward_directionfunc で指定した関数が前方に進む処理の場合は True、そうでない場合は False を指定する

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ reset_mark

mark の状態を reset する新たな関数を返す

Function

def reset_mark(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ reset_counter

repeat counter の状態を reset する新たな関数を返す

Function

def reset_counter(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ reset_undo

undo/redo の状態を undo に reset する新たな関数を返す

Function

def reset_undo(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ reset_search

検索中の状態を reset する新たな関数を返す

Function

def reset_search(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ repeat

数引数の値に従い、repeat の処理を施した新たな関数を返す

Function

def repeat(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ repeat2

数引数の値に従い、repeat の処理を施した新たな関数を返す （リーションが設定してある場合は、一回のみ処理を行うバージョン）

Function

def repeat2(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ repeat3

数引数の値に従い、repeat の処理を施した新たな関数を返す （repaet 回数を func の引数で渡すバージョン）

Function

def repeat3(func):

Parameters

ParameterDescription
func処理を施す関数

Returns

  • 引数で指定した func に本関数の処理を施した新たな関数

■ delay

処理を指定した時間停止する

Function

def delay(sec=0.02):

Parameters

ParameterDescription
sec停止する秒数（デフォルト値は 0.02秒）

Returns

  • 無し