Google Gadgets API 入門 (9)

2007-01-19 Google Gadgets API 入門 (9)

ユーザ・プリファレンスのデータ型に新しく "list" 型が追加されました。（Google Group での投稿 Google Gadgets: New Features and Updates! でアナウンスが行われました）。今回は、"list" 型のユーザ・プリファレンスの解説を行います。

上の画像は "list" データ型のユーザ・プリファレンスを編集するときの様子です。リストの各項目の右端の [x] ボタンを押すことで、その項目を削除することができます。また、リストの項目はプログラム的に変更することもできます。

"list" 型のユーザ・プリファレンスを作成するには、<UserPref> の datatype 属性に "list" を指定します：

<Module>
  ...
  <UserPref name="colors" datatype="list" default_value="赤|緑|青" />
  ...
</Module>

また、default_value 属性でデフォルト値を指定する場合は、上の例のように項目値を '|' 区切りで指定します。

"list" 型のユーザ・プリファレンスの値の取得/設定は、_IG_Prefs() 関数で生成した prefs オブジェクトを通して行います：

var prefs = new _IG_Prefs(__MODULE_ID__)
prefs.getArray("colors")

以下に、"list" 型のユーザ・プリファレンスに関する関数を一覧します：

getString(name)	"list" 型の値を、項目値が '\|' で区切られた文字列（<UserPref> の default_value に指定する値と同じ形式）として返します。
getArray(name)	"list" 型の値を配列として返します。
setArray(name, array)	"list" 型の値を設定します。この関数の使用には setprefs ライブラリが必要です。（<ModulePrefs> の内側に <Require feature="setprefs" /> を追加します）。

setArray() の使用例：

var prefs = new _IG_Prefs(__MODULE_ID__)
prefs.setArray("colors", ["白", "黒"])