書式について


書式とは

書式とは、年月日、時分秒、曜日等から、何をどのように時計に出力するかを指定するための文字列です。
書式の指定は、オプションダイアログの書式設定タブ内で行います。
TTClockでは「テキストブロック」を使用して描画のレイアウト等を書式で指定することもできます。

エスケープ文字一覧

書式に使用するエスケープ文字の一覧です。
エスケープ文字以外の文字列はそのまま時計に出力されます。

\Y 年(4桁)
\y 年(2桁)
\e 年(元号表記, 2桁)(e.g. \e, \-1988e)
※ 数値が未指定の場合(\e)は、書式タブの「元号表記(西暦との差)」で指定した値
  が使用されます
※ 参考:昭和 \-1925e, 平成 \-1988e, 令和 \-2018e
\M 月(2桁)
\D 日(2桁)
\h 時(24時間表記)
\H 時(12時間表記)
\m 分(2桁)
\s 秒(2桁)
\a 曜日を表す文字列
\A 曜日を表す文字列(ユーザ定義)
※ 文字列の設定はオプションダイアログの書式設定タブ内で行います
画像ファイル描画時は設定できません
\p 午前/午後を表す文字列
\P 午前/午後を表す文字列(ユーザ定義)
※ 文字列の設定はオプションダイアログの書式設定タブ内で行います
画像ファイル描画時は設定できません
\w 月を表す文字列
\W 月を表す文字列(ユーザ定義)
※ 文字列の設定はオプションダイアログの書式設定タブ内で行います
画像ファイル描画時は設定できません
\n 改行
\\ \
画像ファイル描画時は設定できません
\[ テキストブロック開始
\] テキストブロック終了
\L 左寄せ
※ テキストブロック単位で指定可能
\C 中寄せ
※ テキストブロック単位で指定可能
\R 右寄せ
※ テキストブロック単位で指定可能
\T 上寄せ
※ テキストブロック単位で指定可能
\V 中寄せ(縦方向)
※ テキストブロック単位で指定可能
\B 下寄せ
※ テキストブロック単位で指定可能
\% 拡大/縮小率(例: \50%, \200%)
※ テキストブロック単位で指定可能
\r 描画位置の微調整 (横方向) (e.g. \+3r, \-10r)
※ テキストブロック単位で指定可能
\b 描画位置の微調整 (縦方向) (e.g. \+3b, \-10b)
※ テキストブロック単位で指定可能
\G GMT(グリニッジ標準時)との時差で日時を表示 (e.g. \+09:00G, \-10:00G)
※ テキストブロック単位で指定可能
\X モニタリング結果を表示 (e.g. \2X)
\0X ・・・ CPU使用率
\1X ・・・ メモリ使用率
\2X ・・・ ネットワーク受信量(指定した最大受信ビットレート値を 100 とした時の割合)
\3X ・・・ ネットワーク送信量(指定した最大送信ビットレート値を 100 とした時の割合)
\4X ・・・ バッテリー残量
\U 現在ログオンしているユーザのユーザ名
\N コンピュータ名
\J ドメインに参加している場合はドメイン名
ワークグループに参加している場合はワークグループ名



テキストブロックについて
テキストブロックを使用し、書式のレイアウトやスタイル適用範囲を指定することができます。


レイアウト構成
次のように描画したい場合を考えます。

01:23:45 Jul 18
土曜日

時間の右側に、「日付\n曜日」を表示しています。
テキストブロックを使用せずに書くと、
\h:\m:\s \w \M\n\A
となりますが、これは次のように表示されてしまいます。

01:23:45 Jul 18
土曜日

上図のレイアウトを実現するには、「日付\n曜日」の部分をテキストブロックで括り、
\h:\m:\s\[\w \M\n\A\]
とします。

上図の様にサイズを変更する場合は、書式は、
\h:\m:\s\[\50%\w \M\n\50%\A\]
となります(\50%が複数必要な理由は後述)。


スタイル適用範囲
次のように描画したい場合を考えます。

普通 大きく 普通

拡大率を指定するエスケープ文字は、テキストブロック内でのみ有効なので、書式は、
普通\[\200%大きく\]普通
となります。

配置指定
次のように描画したい場合を考えます。

あいうえお

これもスタイルの適用と同様、配置や拡大率を指定するエスケープ文字は、テキストブロック内でのみ有効なので、書式は、
あいうえお\n\[\L\]\n\[\C\]\n\[\R\]
となります。
なお、複数のテキストブロックが1行にある場合は位置合わせすることはできませんので、スペース文字等で調節をお願いします。
例えば、以下では各テキストブロックで配置指定を行っていても「左中右」が左寄せで表示されます
あいうえお\n\[\L\]\[\C\]\[\R\]
あいうえお
左中右



書式の構文解析時に、改行(\n)の前後にテキストブロックが自動挿入されます。
そのため、テキストブロック単位で指定するエスケープシーケンスは各テキストブロック内(各行)で指定する必要があります。
例)
\50%あいうえお\n123
という書式は、改行の前後でテキストブロックが挿入されて、
\[\50%あいうえお\]\n\[123\]
と内部では解釈されるため、\50%は「あいうえお」にのみ有効となります。

「あいうえお」と「123」の両方を50%のサイズにするには、
\50%あいうえお\n\50%123
と指定する必要があります。