その他/設定可能なキー一覧/StaticString - uLilithフェイス作成方法wiki

StaticStringのキー

Category = StaticStringのフィールドのキー一覧です。

• キー名が赤字と青字のキーは必須のキーです。
  （青字のキーは他のキーの設定状況などによっては省略することも可能です）
• キー名が緑字のキーは、作成するアイテムの種類によっては必須になるキーです。
  （該当するアイテム以外を作成する場合は省略してもかまいません）
• キー名の左の欄に*があるキーは、
  ModifyItemコマンドで後から設定を変更することができます。

カテゴリの設定

	キー名	値	内容
	Category	StaticString	カテゴリをStaticStringに指定

表示する文字列の内容の設定

	キー名	値	内容	初期値
*	Caption	文字列	表示する文字列の内容

文字列の表示色・フォント設定

☆TextColor・FontFace・FontSizeキーは必須です。
   ただし、文字列を画像ファイルによる描画設定にする場合
   （StringByImageキーをTrueにしている状態）は
   文字色・フォント表示設定（この表のキー）は無効になるので
   TextColor・FontFace・FontSizeキーは不要になります。

	キー名	値	内容	初期値
*	TextColor	色指定	文字列の文字色・透明度	0x00000000
*	ShadowColor	色指定	文字列の影の文字色・透明度	0x00000000
*	UseStringEdge	TrueかFalse	True：ShadowColorの色指定を            文字の縁取りの色の設定に変更する	False
*	FontFace	フォント名	文字列の表示フォント
*	AlternateFontFace	フォント名	FontFaceで指定したフォントが インストールされていない場合に 代わりに使用する表示フォント
*	FontSize	数値	文字列のフォントのサイズ（高さ）
*	FontStyle	【※】	文字列のフォントの装飾設定

※Bold（太字）Italic（斜体）Underline（下線）Strikeout（取り消し線）の４種類。
   複数同時に使用することも可能。（半角スペース・カンマで区切って指定する）

画像ファイルによる文字表示の設定

☆文字列を画像ファイルによる描画設定にする場合は
   StringByImage・StringImageFileキーが必須キーになります。

	キー名	値	内容	初期値
	StringByImage	TrueかFalse	True：文字列の表示が            画像による文字描画に変更される	False
	StringImageFile	画像ファイル名	文字（数字・記号）の表示に使用される 画像ファイルを指定【※】

※「0123456789:.,-+%」の１６文字を等間隔で描いた画像ファイルを指定します。
   画像を縦に１６分割した部分（『幅：画像の１６分の１×高さ：画像の高さ』のサイズ）が
   １文字として表示されます。
   例えば0を表示する場合は分割した一番左の部分、1の場合は左から２番目の部分、
   2の場合は左から３番目の部分、……（中略）……%の場合は一番右の部分
   というように表示されます。
   「0123456789:.,-+%」以外の文字は空白として表示されます。

文字列の表示方向の設定

	キー名	値	内容	初期値
	IsVertical	TrueかFalse	True：文字列を縦書きで表示する【※】	False

※全角の文字を表示している、あるいは画像ファイルで文字を表示している場合は
   文字自体の向きは変わらず、正しく縦書き表示できます。
   半角文字を表示している場合は文字が横に寝てしまいます。

文字列のスクロール設定

	キー名	値	内容	初期値
	ScrollPixels	数値（整数）	文字列がスクロールする速度 （ピクセル単位。0でスクロール停止）	+20
	RepeatPixels	数値（整数） （0以上）	スクロールが発生した場合の 繰り返し表示の始まるまでの 空白部分の長さ（ピクセル単位）	30

背景色の設定

	キー名	値	内容	初期値
*	BackgroundColor	色指定	アイテムの背景色（・透明度）の設定【※】	0x00000000

※アイテムの表示領域の矩形（長方形）部分全体ではなく、
   文字が表示されている部分を中心に設定した色・透明度で背景が表示されます。
   文字列のすぐ下に（奥に）背景色が表示されます。

アイテムの表示サイズの指定

	キー名	値	内容	初期値
*	Width	数値	アイテムの表示サイズ（幅）	Captionの文字列の表示幅
*	Height	数値	アイテムの表示サイズ（高さ）	Captionの文字列の表示の高さ

☆Width・Heightキーが省略された場合、
   Width・HeightはCaptionの文字列の表示幅・高さになります。

アイテムの表示位置指定

☆通常は『PosX・PosYキー両方とも』
   ウィンドウの特定位置（四隅・四辺の中央など）からの相対位置にする場合は
   『TopLeftAnchorキー』が、それぞれ必須キーになります。
   （PosX・PosYは省略してもエラーにはなりませんが
     TopLeftAnchorキーが未設定のときにPosX・PosYも省略すると
     PosX・PosYがどちらも0扱いとなり、アイテムがフェイス左上端に配置されてしまうので
     基本的にはPosX・PosYを省略せずに記述するようにしてください。
     なお、OriginItemキー設定時で
     基準アイテムと同じ位置に配置する場合は省略してもかまいません。）

	キー名	値	内容	初期値
*	PosX	数値	アイテムの左上端位置のX座標	0
*	PosY	数値	アイテムの左上端位置のY座標	0
	OriginItem	基準になるアイテムの フィールド名【※1】	アイテムの表示位置が キーの値に指定した フィールド名のアイテムの表示位置からの 相対位置になる【※2】
*	TopLeftAnchor	【※3】	アイテムの表示領域の左上座標を 指定した原点からの相対座標に固定する 【※4】	None
*	BottomRightAnchor	【※3】	アイテムの表示領域の右下座標を 指定した原点からの相対座標に固定し、 ウィンドウサイズの大きさに応じて 表示サイズを自動調整する【※5】	None
	Priority	数値	アイテムの表示の優先度	0

※1 iniファイル（定義ファイル）内で、
     このキーを記述するフィールドの前に記述されているフィールド名のみが対象。
     （このキーを記述するフィールドの後にあるフィールド名や
       iniファイル内に存在しないフィールド名はエラーになります。）
※2 OriginItemキーを記述した場合、
     アイテムの左上端位置のX座標は、
     「OriginItemで指定したアイテムのPosX＋このアイテムのPosX」に、
     Y座標は「OriginItemで指定したアイテムのPosY＋このアイテムのPosY」になります。
     PosX・PosYキーの数値にマイナスの数値を指定することで、
     OriginItemで指定したアイテムよりも上や左に配置することもできます。
     PosX・PosYキーの数値がどちらも0の場合（または、キーを省略した場合）は
     OriginItemで指定したアイテムと同じ位置に配置されます。
※3 〔原点〕, 〔相対X座標〕, 〔相対Y座標〕の３つを半角スペースとカンマで区切って指定します。
     原点はTopLeft（左上端）・TopCenter（上端中央）・TopRight（右上端）・
    CenterLeft（左端中央）・Center（中央）・CenterRight（右端中央）・
    BottomLeft（左下端）・BottomCenter（下端中央）・BottomRight（右下端）・
    None（自動補正を行わない）のうちどれか１つ。
     相対X座標と相対Y座標はピクセル単位だけでなく、
     ウィンドウの幅や高さに対する割合でも設定が可能です。
     割合で指定する場合は数値の後に半角で%を記述してください。
     （%表記の場合、10.0%というふうに小数表記も可能です）
※4 このキーはPosX・PosYキーの代わりに設定します。
     また、OriginItemキーの設定は無視されます。
※5 このキーはTopLeftAnchorキーとともに設定します。
     アイテムの表示サイズはウィンドウサイズに応じて自動的に調整されますが、
     初期サイズとしてのWidth・Heightキーは設定しておいてください。

文字列の配置設定

	キー名	値	内容	初期値
	Align	【※】	アイテムの表示領域内での文字列の表示位置	TopLeft

※ TopLeft（左上端）・TopCenter（上端中央）・TopRight（右上端）・
   CenterLeft（左端中央）・Center（中央）・CenterRight（右端中央）・
   BottomLeft（左下端）・BottomCenter（下端中央）・BottomRight（右下端）のうち
   どれか１つ

マウスオーバー／クリックへの反応の設定

	キー名	値	内容	初期値
*	TipHint	文字列	マウスカーソルがアイテムの表示位置に 一定時間置かれたときに表示されるチップヒントの内容
*	Enable	TrueかFalse	True：クリックに反応するようになる【※1】           Commandキーが設定されているアイテムの場合、            クリック時にそのコマンドが実行される	False
	MouseCursor	【※2】	マウスオーバー／クリック時の マウスカーソルの指定	Auto

※1 StaticStringアイテムの場合、クリック／マウスオーバーしても
     文字色や背景色が変更されないので、
     クリックされたかどうかは見た目では判断できません。
     ただし、Commandキーが設定されていればコマンドは実行されます。
※2 マウスカーソルに使用する*.curのカーソルファイル名か、
     以下の値のうちどれか１つ
     Auto・Normal・Finger・
     TopLeftResizer・TopRightResizer・BottomLeftResizer・BottomRightResizer・
     Arrow・IBeam・Wait・Cross・UpArrow・Size・
     SizeNWSE・SizeNESW・SizeWE・SizeNS・No・Hand・AppStarting・Help
     設定可能なマウスカーソルの一覧はこちら。

アイテムの初期表示状態の設定

	キー名	値	内容	初期値
*	IsHided	TrueかFalse	True：初期状態でアイテムを非表示にする【※】	False

※HideItemコマンドで非表示にしたのと同じ状態です。
   後からShowItem・SwitchShowItemコマンドで表示させることはできます。

アイテムの透明度の設定

☆背景色や文字色に指定した透明度設定を編集すれば
   ConstAlphaキーを使用しなくても
   アイテムの表示透明度を制御することは可能です。

	キー名	値	内容	初期値
*	ConstAlpha	数値（整数） （0～255か-1）	アイテムの定数α(不透明度)を指定【※】	-1

※「0」で完全透明、
   「255」で不透明（背景色や文字色自体が半透明なら、その透明度のまま）になります。
   ただし、不透明扱いにするのならキーを省略（-1に設定）するほうが高速に描画されるので
   このキーで透明度を調整する必要が無い場合は、キーを省略してください。
   なお、背景色・文字色指定の透明度が設定されている場合
   ConstAlphaキーの設定が乗算されます。

アイテムの表示エリアの差分描画の設定

	キー名	値	内容	初期値
	DisablePartialUpdate	TrueかFalse	True：差分描画が行われなくなる	False

コマンドの設定

	キー名	値	内容	初期値
*	Command	コマンド名	クリック時に実行するコマンド名
*	CommandParamType	【※1】	コマンドのパラメータの種類 （パラメータが必要なコマンドのみ）
*	CommandParam	【※2】	コマンドのパラメータの内容 （パラメータが必要なコマンドのみ）
	CommandTargetWindow	ウィンドウ名【※3】	コマンドを実行する対象のウィンドウ （別のウィンドウに対して実行する場合のみ。 省略した場合は Commandキーを記述したウィンドウ自身が 対象になる）
	CommandTargetPlugin	プラグイン名	コマンドを実行する対象のプラグイン名 （プラグインに対して実行する場合のみ）
*	CommandCount	数値	実行するコマンドの数 （複数のコマンドを設定する場合のみ【※4】）
	UseAsyncCommand	TrueかFalse	True：コマンドを非同期実行するようにする	False

※1 Int・String・Double・Bool・RandomInt・RandomString のうちどれか１つ
     （コマンドによって使用できる種類が異なる）
※2 文字列や数値など、コマンドによって異なる
※3 CreateSubFace・ToggleSubFaceコマンドで開くときにパラメータで指定した「ウィンドウ名」。
     サブウィンドウに記述したコマンドで、メインウィンドウを対象とする場合は
     「uLilith::MainWindow」と指定する。
※4 １つのアイテムに複数のコマンドを設定する場合、
     CommandCountキーを設定した上で
     Command・CommandParamType・CommandParam・
     CommandTargetWindow・CommandTargetPluginの全てのキーの末尾に
     （スペースは入れずに）連番をつける必要があります。
     例：「Command2」「CommandParamType2」など
     コマンドはキー末尾につけた連番の番号の順に実行されます。