CraftLaunch APIリファレンス

グローバル関数


関数

def popMenu
 ポップアップメニューを表示する
def joinPath
 ファイルパスを連結する
def splitPath
 ファイルパスをディレクトリ名とファイル名に分離する
def splitExt
 拡張子がN文字以下でASCII文字だけからなるときだけ分離する
def rootPath
 ファイルパスのルートディレクトリ部分を取得する
def normPath
 ファイルパスを標準化する
def replacePath
 ディレクトリ区切り文字を設定にしたがって置き換える
def popMessageBox
 メッセージボックスを表示する

関数

def clnch_misc.joinPath (   args  ) 

ファイルパスを連結する

引数:
*args 連結される任意の個数のパス
戻り値:
連結結果のパス
ファイルパスの連結処理に加えて、ディレクトリ区切り文字の \ と / の置き換え処理も行います。

この関数の動きは os.path.join() に似せてありますが、 os.path.join() とは違い、UNC形式 ( //machine/share/ で始まるもの ) のパスを扱うことが出来ます。

clnch_misc.py764 行で定義されています。

def clnch_misc.normPath (   path  ) 

ファイルパスを標準化する

引数:
path 元になるパス
戻り値:
標準化されたのパス
os.path.normpath() 相当の処理に加え、ディレクトリ区切り文字の \ と / の置き換え処理を行います。

clnch_misc.py826 行で定義されています。

def clnch_listwindow.popMenu (   main_window,
  max_width = None,
  max_height = None,
  title = u"",
  items = [],
  initial_select = 0,
  onekey_search = True,
  onekey_decide = False,
  return_modkey = False,
  keydown_hook = None,
  statusbar_handler = None 
)

ポップアップメニューを表示する

引数:
main_window MainWindowオブジェクト
title メニューウインドウのタイトルバーに表示する文字列
items メニューに表示するアイテムのリスト
initial_select 初期選択位置
onekey_search 文字入力で項目の先頭文字を検索するか
onekey_decide 先頭文字の検索で候補が1つだけだったとき即時決定するか
return_modkey メニューが閉じたときに押されていたモディファイアキーを取得するか
keydown_hook キー入力イベントのフック
statusbar_handler ステータスバーに表示する文字列を返すハンドラ
戻り値:
引数 return_modkey が False の場合は結果値 (選択されたアイテムのインデックスか、キャンセルされた場合は-1)、引数 return_modkey が True の場合は ( 結果値, モディファイアキーの状態 ) を返す。
引数 items には、( 表示名, ... ) 形式のアイテムをリストに格納して渡します。[ ... ] の部分には、どのようなデータが入ってもかまいません。

onekey_search に True を渡したときは、キー入力で項目の先頭文字を検索します。onekey_search に False を渡したときは、F キーでインクリメンタルサーチが開始します。

statusbar_handler にハンドラを渡したときは、ステータスバーが表示されます。

インクリメンタルサーチの検索パターンは、ステータスバーが有効な場合はステータスバーに表示され、ステータスバーが無効な場合はタイトルバーに表示されます。

clnch_listwindow.py470 行で定義されています。

def clnch_msgbox.popMessageBox (   main_window,
  msgbox_type,
  title,
  message,
  return_modkey = False 
)

メッセージボックスを表示する

引数:
main_window MainWindowオブジェクト
msgbox_type メッセージボックスのタイプ
title メッセージボックスのタイトルバーに表示する文字列
message メッセージ文字列
return_modkey 閉じたときのモディファイアキーの状態を取得するかどうか
戻り値:
引数 return_modkey が False の場合は結果値、引数 return_modkey が True の場合は ( 結果値, モディファイアキーの状態 ) を返す
引数 msgbox_type には、以下のいずれかを渡します。
  • cfiler_msgbox.MSGBOX_TYPE_OK
    [ OK ] ボタンを1つ備えたメッセージボックス

  • cfiler_msgbox.MSGBOX_TYPE_YESNO
    [はい] ボタンと [いいえ] ボタンを備えたメッセージボックス

返値の結果値としては、以下のいずれかが返ります。

  • cfiler_msgbox.MSGBOX_RESULT_CANCEL
    キャンセルされた

  • cfiler_msgbox.MSGBOX_RESULT_OK
    [ OK ]ボタンが選択された

  • cfiler_msgbox.MSGBOX_RESULT_YES
    [ はい ]ボタンが選択された

  • cfiler_msgbox.MSGBOX_RESULT_NO
    [ いいえ ]ボタンが選択された

clnch_msgbox.py183 行で定義されています。

def clnch_misc.replacePath (   path  ) 

ディレクトリ区切り文字を設定にしたがって置き換える

引数:
path 元になるパス
戻り値:
置換されたパス
ディレクトリ区切り文字の \ と / の置き換え処理を行います。

clnch_misc.py838 行で定義されています。

def clnch_misc.rootPath (   path  ) 

ファイルパスのルートディレクトリ部分を取得する

引数:
path 元になるパス
戻り値:
ルートディレクトリのパス

clnch_misc.py810 行で定義されています。

def clnch_misc.splitExt (   path,
  maxlen = 5 
)

拡張子がN文字以下でASCII文字だけからなるときだけ分離する

引数:
path 分離されるパス
maxlen 拡張子とみなす最大の長さ (ピリオドを含む)
戻り値:
( ファイル名本体, 拡張子 )
この関数の動きは os.path.splitext() に似せてありますが、 os.path.splitext() とは違い、長い拡張子を分離しないことが出来ます。

clnch_misc.py797 行で定義されています。

def clnch_misc.splitPath (   path  ) 

ファイルパスをディレクトリ名とファイル名に分離する

引数:
path 分離されるパス
戻り値:
( ディレクトリ名, ファイル名 )
この関数の動きは os.path.split() に似せてありますが、 os.path.split() とは違い、UNC形式 ( //machine/share/ で始まるもの ) のパスを扱うことが出来ます。

clnch_misc.py781 行で定義されています。


Copyright © 2009 craftware. All rights reserved.