Wide Studio Object Reference

Wide Studio Home
Up to

## クラスの型

WSCtextField

## メソッド関数仕様

### getTextFrame 関数の説明

書式
  WSCbase* getTextFrame()
機能
  テキストフィールド内部の複数行入力テキストクラス (WSCvmifield クラス)のインスタンスを取得する関数です。
処理
引数
  なし。
返値
  内部の複数行入力テキストインスタンス。
注意
サンプル

        //内部の WSCvifieldインスタンスを取得するには、次のようにします。
        WSCbase* ifield = newtext_000->getTextFrame();

### addString 関数の説明

書式
  void addString(char* var,long encoding = WS_EN_DEFAULT)
機能
  現在表示中の文字列の末尾に、指定した文字列を追記する関数です。 エンコーディングを省略すると WS_EN_DEFAULT が指定されたものと とみなされます。 文字列を置き換えたい場合は、プロパティ WSNlabelString を 用いてください。
処理
引数

  (in)char* var | 追加したい文字列
  (in)long encoding | 文字列のエンコーディング

指定できるエンコーディングは、WSCstring(char*,long) を 参照ください。
返値
  なし。
注意
サンプル

        //現在表示中の文字列に指定された文字列を追加します。
        newtext_000->addString("文字列の追加");

  ### getBuf 関数の説明

  書式
    WSCushort* getBuf()
  機能
    内部のテキストバッファを取得する関数です。 このバッファの内容はユニコード(UCS2)です。
  処理
  引数
    なし。
  返値
    テキストバッファ。
  注意
    返されたバッファを解放してはいけません。 また、キー入力が行われ、バッファの内容が変更されると、 確保されていた領域は無効となります。したがって、 この関数が返す領域の永続的な利用は避け、 なるべく他の領域にコピーして使用してください。
  サンプル

          //現在表示中の文字列のUCS2文字列バッファを取得します。
          WSCushort* buf = newtext_000->getBuf();

  ### onActivate 関数の説明

  書式
    void onActivate()
  機能
    スクロールバーによるスクロールが完了したとき、 この関数が実行されます。 派生クラスでは、トリガ(WSEV_ACTIVATE)による イベントプロシージャを用いる代わりに、 この関数をオーバーライドすることでも、スクロールに関する イベント処理を行うことができます。
  処理
  引数
    なし。
  返値
    なし。
  注意
    なし。
  サンプル

        void new_class::onActivate(){
          //一連のスクロール動作が完了した場合に行う処理を記述します。

          //処理を派生元クラスに引き継ぎます。
          old_class::onActivate();
        }

  ### onValueChange 関数の説明

  書式
    void onValueChange()
  機能
    文字列が入力され、変化したとき、この関数が実行されます。 派生クラスでは、トリガ(WSEV_VALUE_CH)による イベントプロシージャを用いる代わりに、 この関数をオーバーライドすることでも、文字列入力に関する イベント処理を行うことができます。
  処理
  引数
    なし。
  返値
    なし。
  注意
    なし。
  サンプル

        void new_class::onValueChange(){
          //入力が行われ、文字列が変更された場合に行う処理を記述します。

          //処理を派生元クラスに引き継ぎます。
          old_class::onValueChange();
        }

  ### onKey() 関数の説明

  書式
    void onKey(WSDkeyboard* keyboard,WSCbool keydown);
  機能
    キーボードが押下または解放されたとき、この関数が実行されます。 キーボード押下状態は、True（押下）または Flase（解放）で 渡されます。 派生クラスでは、トリガ(WSEV_KEY_PRESS/WSEV_KEY_RELEASE)による イベントプロシージャを用いる代わりに、 この関数をオーバーライドすることでも、キーボード入力に関する イベント処理を行うことができます。
  処理
  引数

    (in)WSDkeyboard* keyboard | キーボードインスタンス
    (in)WSCbool keydown | True = Press、False = Release

  返値
    なし。
  注意
  サンプル

        void new_class::onKey(WSDkeyboard* keyboard,WSCbool keydown){
          //キー入力された場合に呼び出されます。
          if (keydown != False){   //キー押下
            //キーの取得
            long key = keyboard->getKey();
            //入力文字列の取得
            WSCstring str = keyboard->getText();
          }

          //処理を派生元クラスに引き継ぎます。
          old_class::onKey(keyboard,keydown);
        }

  ### onKeyHook() 関数の説明

  書式
    void onKeyHook(WSDkeyboard* keyboard);
  機能
    キーボードをフックします。キーボード入力が行われたとき、 この関数が実行されます。 派生クラスでは、トリガ(WSEV_KEY_HOOK)による イベントプロシージャを用いる代わりに、 この関数をオーバーライドすることでも、キーボード入力に関する イベント処理を行うことができます。
  処理
  引数

    (in)WSDkeyboard* keyboard | キーボードインスタンス

  返値
    なし。
  注意
  サンプル

        void new_class::onKeyHook(WSDkeyboard* keyboard){
          //キー入力された場合に呼び出されます。
          //入力文字列の取得
          WSCstring str = keyboard->getText();
          //keyboard->setText(...) で、文字列を置き換えることで、
          //文字列入力を操作することができます。

          //処理を派生元クラスに引き継ぎます。
          old_class::onKeyHook(keyboard);
        }

  ### replaceSelectedString() 関数の説明

  書式
    void replaceSelectedString(char* str,long encoding = WS_EN_DEFAULT);
  機能
    選択中の文字列を引数で指定された文字列で置き換える関数です。 エンコーディングを省略すると WS_EN_DEFAULT が指定されたもの とみなされます。
  処理
  引数

    (in)char* str | 置換後の文字列
    (in)long encoding | 文字列のエンコーディング

    指定できるエンコーディングは、WSCstring(char*,long) を 参照ください。
  返値
    なし。
  注意
  サンプル

          //現在選択状態にある文字列を指定した文字列で置換します。
          newtext_000->replaceSelectedString("置換文字列");

  ### getSelectedString() 関数の説明

  書式
    WSCstring getSelectedString()
  機能
    選択中の文字列を取得する関数です。
  処理
  引数
    なし。
  返値
    選択文字列
  注意
  サンプル

          //現在選択状態にある文字列を取得します。
          WSCstring stext = newtext_000->getSelectedString();

  ### getString() 関数の説明

  書式
    WSCstring getString()
  機能
    入力文字列を取得する関数です。
  処理
  引数
    なし。
  返値
    入力文字列
  注意
  サンプル

          //現在の入力文字列を取得します。
          WSCstring text = newtext_000->getString();

  ### deleteSelectedString() 関数の説明

  書式
    void deleteSelectedString()
  機能
    選択文字列を削除する関数です。 保持している入力文字列が変更されます。 選択部分以降にあった文字列は前に詰められます。
  処理
    選択された文字列の部分だけ削除します。
  引数
    なし。
  返値
    なし。
  注意
  サンプル

          //現在選択状態にある文字列を削除します。
          newtext_000->deleteSelectedString();

  ### setSelect() 関数の説明

  書式
    long setSelect(long pos,long len)
  機能
    指定された位置から、指定された長さの 文字列を選択状態にする関数です。
  処理
    文字位置 pos から指定された長さの文字列を選択状態にします。
  引数

    (in)long pos | 文字列開始位置
    (in)long len | 文字列長

  返値
    WS_NO_ERR= 正常、それ以外はエラー。
  注意
  サンプル

          //指定した位置の文字列を選択状態にします。
          //例えば先頭から５文字目までを選択状態にするには次のようにします。
          newtext_000->setSelectedString(0,5);

  ### getSelectedPos() 関数の説明

  書式
    long setSelectedPos()
  機能
    選択文字列が先頭からの何文字目にあるかを取得する関数です。
  処理
  引数
    なし。
  返値
    先頭からの文字数
  注意
  サンプル

          //選択状態にある文字列の先頭からの文字数を取得します。
          long pos = newtext_000->setSelectedPos();

  ### getLines() 関数の説明

  書式
    long setLines()
  機能
    テキスト全体の行数を取得する関数です。
  処理
  引数
    なし。
  返値
    行数
  注意
  サンプル

          //現在の入力文字列の行数を取得します。
          long pos = newtext_000->getLines();

  ### getTopLine() 関数の説明

  書式
    long getTopLine()
  機能
    現在表示中の最上段の行番号を取得する関数です。 行番号は先頭行が 0 で、全行数-1 までの値になります。
  処理
  引数
    なし。
  返値
    表示中の最上段の行
  注意
  サンプル

          //現在、最上段に表示されている入力文字列の行を取得します。
          long pos = newtext_000->getTopLine();

  ### setTopLine() 関数の説明

  書式
    long setTopLine(long line)
  機能
    指定した行が最上段に表示されるようにスクロールさせる関数です。 行番号は先頭行が 0 で、全行数-1 までの値を指定できます。
  処理
  引数

    (in)long line | 行(0,1,2〜)

  返値
    WS_NO_ERR= 正常、それ以外はエラー。
  注意
  サンプル

          //最上段に表示すべき入力文字列の行を指定します。
          //たとえば、11行目を最上段にスクロールさせたい場合は次のように指定します。
          newtext_000->setTopLine(10);

  ### getBottomLine() 関数の説明

  書式
    long getBottomLine()
  機能
    現在表示中の最下段の行番号を取得する関数です。
  処理
  引数
    なし。
  返値
    表示中の最下段の行
  注意
  サンプル

          //現在最下段に表示されている入力文字列の行を取得します。
          long line = newtext_000->getBottomLine();

  ### setBottomLine() 関数の説明

  書式
    long setBottomLine(long line)
  機能
    指定した行が最下段に表示されるようにスクロールさせる 関数です。行数が足りず、最下段に届かない場合は、 最も近い行になります。
  処理
  引数

    (in)long line | 行(0,1,2〜)

  返値
    WS_NO_ERR= 正常、それ以外はエラー。
  注意
    表示行数の関係から、最下段に届かない場合は 近い行でとまります。
  サンプル

          //最下段に表示すべき入力文字列の行を指定します。
          //たとえば、11行目を最下段にスクロールさせたい場合は次のように指定します。
          newtext_000->setBottomLine(10);

  Document Release 3.70
  For Use with Wide Studio Release 3.70, Spring 2004

  WideStudio Home | Up to

  Copyright(C) WideStudio Development Team, 1999-2004 |  | Last modified: May. 25, 2004