SetTextWindow関数

このページをスマホなどでご覧になる場合は、画面を横長にする方が読みやすくなります。

書式

int8_t SetTextWindow(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)

対応オブジェクト型

対応バージョン

Ver. 0.22以降

説明

テキスト表示するウィンドウを設定する。

通常は画面全体を使ってテキスト表示するが、画面の一部はグラフィック表示のみを行い、別の部分でテキスト表示をしたい事がある。そのような場合に、テキスト表示の範囲を制限するのがSetTextWindow関数である。

SetTextWindow関数を使うと、4つの引数x1、y1、x2、y2で指定される長方形のエリア(テキストウィンドウ)にのみテキストの表示を行う。たくさんの情報を表示して、画面スクロールが起こる場合でも、テキストウィンドウ内でスクロールが行われる。

座標の指定はピクセル単位ではなく、文字単位である。x1とx2は0~GetColumnNum()-1の値を取る。y1とy2は0~GetLineNum()-1の値を取る。(x1,y1)がテキストウィンドウの左上角の座標を表し、(x2,y2)が右下角の座標を表すので、x1≦x2かつy1≦y2である必要がある。

無効な座標を指定するか、シリアル回線経由でLCDがつながっている場合にシリアル回線でエラーが発生すると、テキストウィンドウは設定されず、SetTextWindow関数は負の値を返す。

テキストウィンドウの設定に成功すると、SetTextWindow関数は0を返す。

引数

返り値

関数の呼び出しに成功すると0を、失敗すると負の値を返す。引数に不正な値を渡した場合や、シリアル回線経由でLCDを制御している場合では、回線のエラーが考えられる。

使用例

#include <MGLCD.h>

MGLCD_serial MGLCD(&Serial,500000);

void setup()
{
  while(MGLCD.Reset()); // LCDの初期化
  MGLCD.SetTextWindow(0,0,7,3);
  MGLCD.print("abcdefghijklmnopqrstuvwxyz");
  MGLCD.SetTextWindow(10,0,17,3);
  MGLCD.print("ABCDEFGHIJKLMNOPQRSTUVWXYZ");
}

void loop()
{
}
写真1、実行結果
写真1、実行結果

関連ページ

Arduino 電子工作
このサイトの記事が本になりました。
書名:Arduino 電子工作
ISBN:978-4-7775-1941-5
工学社の書籍の内容の紹介ページ
本のカバーの写真か書名をクリックすると、Amazonの書籍購入ページに移動します。