title: Phi::Label
author: YOSHIDA Kazuhiro
mailto: moriq@moriq.com

1. Phi::Label

テキストを表示する非ウィンドウコントロール

1.1. super class

Phi::Control#

1.1. class methods

: new(parent, name) : Phi::Label

1.1. properties

: alignment : Fixnum
  ラベル内でのテキストの横方向の配置

: auto_size : Boolean
  テキストに合わせてラベルのサイズを自動的に変更するかどうか

: focus_control : Phi::Control
  ラベルに関連付けられたウィンドウコントロール

  ユーザが accelarater key を押したときに focus を受け取る window control を設定する。 key を指定するには， key にしたい文字の前に & を追加して， #show_accel_char を true に設定する。

: layout : Fixnum
  ラベル内でのテキストの縦方向の配置 TextLayout#

: show_accel_char : Boolean
  ラベルテキスト内にある & の表示方法

  : true の場合
    & の右側の文字が accelarater key となり，下線付きで表示される。 #focus_control が設定されている場合，ユーザがこの下線付きの文字を入力すると， #focus_control で指定される window control が入力 focus を受け取る。 & を表示するには， && を使う。

  : false の場合
    & はそのまま & として表示される。 #focus_control の値は使用されない。

: transparent : Boolean
  フォーム上でラベルの下にあるコントロールがラベルから透けて見えるようにするかどうか

  transparent を true に設定すると，ラベルによってフォーム上のほかのコントロールが隠れない。例えば，ラベルを使ってグラフィックにテキストを追加した場合，ラベルは独立したオブジェクトとしては表示されない。

  背景が透過になるようにテキストを書き込むと， transparent が false のときにテキストを書き込む場合より時間がかかる。複雑なイメージを処理する場合， transparent を false にしてラベルがイメージを隠さないようにして，ラベルの背景色をその下にあるオブジェクトと一致させることで処理効率を改善できる。

: word_wrap : Boolean
  ラベルテキストがラベルの幅より長い場合にテキストを改行するかどうか

  : true に設定
    ラベルに複数行のテキストを表示できる。ラベルコントロールの幅より長いテキストは右側で改行され，折り返されたテキストは 2 行目以降に移行する。
  : false に設定
    ラベルテキストは 1 行だけで表示される。ラベルの幅を越えたテキストは切り捨てられる。

: canvas : Phi::Canvas
  コントロールの描画面

1.1. event handlers


* Phi::Control#on_click
* Phi::Control#on_dbl_click
* Phi::Control#on_drag_drop
* Phi::Control#on_drag_over
* Phi::Control#on_end_dock
* Phi::Control#on_end_drag
* Phi::Control#on_mouse_down
* Phi::Control#on_mouse_move
* Phi::Control#on_mouse_up
* Phi::Control#on_start_dock
* Phi::Control#on_start_drag
