GUIコール リファレンス マニュアル

目次

概要
型
アプリケーション関数
ウインドウ操作
描画関数
入力制御関数
クリップボード関数
ドラッグアンドドロップ関数
その他
サンプル
索引

概要

GUIで動作するアプリケーションを作成するには gc_〜 で定義される C 言語の関数を呼び出します（GUIコール）。
必要なファイルは gc.h (mpltype.h, cputype.h) と gc.a (kc.a) です。
以降でGUIコールに必要な型及び、個々の関数を説明します。

型

MPL で定義される型を以下に記述します。

GUIコール用に追加される型を以下に記述します。

typedef struct _RGB {
    unsigned char r ;
    unsigned char g ;
    unsigned char b ;
} RGB ;
typedef struct _RGB_IMG {
    unsigned long w ;
    unsigned long h ;
    RGB *rgb ;
} RGB_IMG ;
typedef struct _RGB_BUF {
    unsigned long type ;
    unsigned long w ;
    unsigned long h ;
    void *buf ;
} RAW_BUF ;
typedef struct _POS {
    long x ;
    long y ;
} POS ;
typedef struct _RECT {
    POS pos[2] ;    /* 左上原点で [0]左上 [1]右下 */
} RECT ;
	

関数

アプリケーション関数

gc_init(), gc_main(), gc_exit() の 3 つの関数は GUI アプリケーション全体を制御します。

int gc_init(void)

引数

戻り値

説明

GUIライブラリーを初期化します。
GUIコールを使う場合は最初にこれを呼び出してください。

void gc_main(void)

引数

戻り値

説明

GUIアプリケーションのイベント駆動を開始します。
この関数からは gc_exit() を呼び出してGUI処理を終了するまで戻ってきません。
この関数を呼び出す前に最低1つはウインドウを作成しておいてください。
なんの準備も無く呼び出すと無限ループします。

void gc_exit(void)

引数

戻り値

説明

GUIアプリケーションを終了し、ライブラリーを後始末します。
GUIアプリケーションを終了させる操作（例えばメニューやクローズボタン）のイベント処理で呼び出してください。
gc_init() の成功後、他の初期化に失敗して gc_main() を呼び出さない場合は直接これを呼び出してください。

int gc_pump(HANDLE hwnd)

引数

戻り値

説明

1回だけメッセージ処理を実行します。
引数が0の場合は普通に処理しますがウインドウハンドルを指定した場合はそのウインドウ及び子ウインドウ以外へのメッセージは処理せずに捨てます。

ウインドウ操作

以下の関数はウインドウを操作します。

void gc_get_root_into(long *width, long *height, long *aspect_w, long *aspect_h, long *rawbuf_type)

引数

戻り値

説明

スクリーンの情報を取得します。

rawbuf_type は RAWBUF_X68K_1T と RAWBUF_X68K_4G と RAWBUF_X68K_16G の３種類の値を戻します。
それぞれの意味は「テキストVRAM(2色モード)」と「グラフィックVRAM(16色モード)」と「グラフィックVRAM(65536色モード)」です。
2色モードのパレットは固定値で0.黒 1.白です。
16色モードのパレットは固定値で以下の通りです。

int gc_set_root_img(HIMG img)

引数

戻り値

説明

ルートウインドウに壁紙を設定します。
指定したイメージはシステムが管理するので削除する必要はありません
※壁紙として使用中に削除した場合は壁紙が解除されます。

int gc_set_root_manager(HANDLE hwnd)

引数

戻り値

説明

ルートウインドウのマウスイベントを処理するウインドウを指定します。
指定したウインドウにはルートウインドウに対するマウスイベントがリダイレクトされるのでポップアップメニュー等、必要な機能拡張ができます。

HANDLE gc_window_open(HANDLE parent, const WINDOW_FUNC *func, const RECT *rect, unsigned long type)

引数

戻り値

説明

ウインドウを開きます。

rect の書式は３種類有り、そえぞれ意味が異なります。

※ウインドウサイズのみをシステムに任せる事はできません。

ウインドウの動作は引数 func によってオープン時に決定します。
WINDOW_FUNC 型は各イベント発生時のコールバック関数のアドレスを羅列した物です。
処理が必要なコールバック関数はアドレスを設定し、他はNULLにしてください。
内容は以下の通りです。

typedef struct _WINDOW_FUNC {
    void (*on_window_open)(HANDLE hwnd) ;
    int  (*on_window_close)(HANDLE hwnd) ;
    void (*on_window_visible)(HANDLE hwnd, int show) ;
    void (*on_window_move)(HANDLE hwnd, const POS *pos) ;
    void (*on_window_size)(HANDLE hwnd, const POS *pos) ;
    void (*on_window_paint)(HANDLE hwnd, const RECT *rect) ;

    void (*on_mouse_enter)(HANDLE hwnd, const POS *pos) ;
    void (*on_mouse_leave)(HANDLE hwnd) ;
    void (*on_mouse_move)(HANDLE hwnd, const POS *pos) ;
    void (*on_mouse_ldown)(HANDLE hwnd, const POS *pos) ;
    void (*on_mouse_lup)(HANDLE hwnd, const POS *pos) ;
    void (*on_mouse_rdown)(HANDLE hwnd, const POS *pos) ;
    void (*on_mouse_rup)(HANDLE hwnd, const POS *pos) ;

    void (*on_keyboard_getfocus)(HANDLE hwnd) ;
    void (*on_keyboard_lostfocus)(HANDLE hwnd) ;
    void (*on_keyboard_push)(HANDLE hwnd, unsigned char ch) ;
    void (*on_keyboard_release)(HANDLE hwnd, unsigned char ch) ;
    void (*on_keyboard_char)(HANDLE hwnd, unsigned char ch) ;

    void (*on_menu)(HANDLE hwnd, const POS *pos) ;

    void (*on_drop)(HANDLE hwnd, int type, void *data, unsigned char opt_key) ;
} WINDOW_FUNC ;
	

ウインドウのタイプには以下の物が有り、必要なフラグを or で重ねて指示します。

void gc_window_close(HANDLE hwnd)

引数

戻り値

説明

ウインドウを閉じます。

void gc_window_remap(HANDLE hwnd, const RECT *rect, int zorder)

引数

戻り値

説明

ウインドウの配置（位置・サイズ）を変更します。

void gc_window_visible(HANDLE hwnd, int show)

引数

戻り値

説明

ウインドウの表示状態を変更します。

void gc_window_invalidate(HANDLE hwnd, const RECT *rect)

引数

戻り値

説明

ウインドウの表示を無効化し再描画イベントを発生させます。

void gc_window_drawclip(HANDLE hwnd, const RECT *rect)

引数

戻り値

説明

描画命令に対するクリッピング領域を設定します。
通常 on_window_paint() コールバック内では事前に要求矩形が設定済みで、かつ事後にリセットされます。
on_window_paint() 外での描画時、もしくは on_window_paint() の設定を上書きする場合に呼び出してください。

int gc_set_icon(HANDLE hwnd, const RGB_IMG *image)

引数

戻り値

説明

ウインドウのアイコン（アイコン化時の画像）を設定します。

int gc_set_caption(HANDLE hwnd, const char *caption)

引数

戻り値

説明

ウインドウのタイトル文字列を設定します。
ウインドウのタイトル文字列はフレームを持たないウインドウでは無意味です。

unsigned long gc_get_caption(HANDLE hwnd, char *buff, unsigned long buff_len)

引数

戻り値

説明

ウインドウのタイトル文字列を取得します。

int gc_set_wls(HANDLE hwnd, void *ptr)

引数

戻り値

説明

ウインドウ固有の情報として１つのポインタアドレスを記憶させます。

void* gc_get_wls(HANDLE hwnd)

引数

戻り値

説明

ウインドウ固有の情報としての１つのポインタアドレスを取得します。
エラー終了時には NULL が戻りますがエラーと正常な NULL は区別が付ません。

HANDLE gc_get_parent(HANDLE hwnd)

引数

戻り値

説明

ウインドウの親を取得します。

HANDLE gc_get_frame(HANDLE hwnd)

引数

戻り値

説明

フレームウインドウを取得します。
フレームウインドウを持たない場合は自身のハンドルを戻します。

HANDLE gc_get_client(HANDLE hwnd)

引数

戻り値

説明

フレームウインドウからクライアントウインドウを取得します。
フレームウインドウ以外を指定した場合は自身を戻します。

void gc_get_client_rect(HANDLE hwnd, RECT *rect)

引数

戻り値

説明

ウインドウの矩形をクライアント座標系で戻します。
クライアント座標系は左上が(0, 0)で右下方向に増加する座標系です。

void gc_get_window_rect(HANDLE hwnd, RECT *rect)

引数

戻り値

説明

ウインドウの矩形を親ウインドウの座標系で戻します。
このウインドウが親ウインドウのどの領域かを示します。

void gc_get_screen_rect(HANDLE hwnd, RECT *rect)

引数

戻り値

説明

ウインドウの矩形をスクリーン座標系で戻します。
このウインドウがスクリーンのどの領域かを示します。

描画関数

以下の関数は描画処理をします。

void gc_set_color(HANDLE hwnd, const RGB *rgb)

引数

戻り値

説明

ウインドウに対する描画色を設定します。

void gc_get_color(HANDLE hwnd, RGB *rgb)

引数

戻り値

説明

ウインドウに対する描画色を取得します。

void gc_set_xor(HANDLE hwnd, int flg)

引数

戻り値

説明

ウインドウに対するXOR描画属性を設定します。

void gc_get_xor(HANDLE hwnd, int *flg)

引数

戻り値

説明

ウインドウに対するXOR描画属性を取得します。

void gc_draw_pixel(HANDLE hwnd, const POS *pos)

引数

戻り値

説明

ウインドウに点を描画します。

void gc_draw_lines(HANDLE hwnd, const POS *pos, unsigned long nof_pos)

引数

戻り値

説明

ウインドウに連続線分を描画します。

void gc_draw_rect(HANDLE hwnd, const RECT *rect)

引数

戻り値

説明

ウインドウに矩形を描画します。

void gc_fill_rect(HANDLE hwnd, const RECT *rect)

引数

戻り値

説明

ウインドウに中を塗りつぶした矩形を描画します。

int gc_copy_rect(HANDLE hwnd, const POS *pos, const RECT *src)

引数

戻り値

説明

ウインドウ状の矩形イメージを別な場所にコピーします。
コピー元、コピー先の両方の矩形がウインドウによりクリッピングされていない事が条件です。
部分的にでもクリッピングされている場合はコピーせずに処理が失敗します。

void gc_draw_text(HANDLE hwnd, const POS *pos, const char *s, const RECT *clip)

引数

戻り値

説明

ウインドウに文字列を描画します。
clip を指定した場合は clip 範囲外にはみ出した部分は描画しません。

HANDLE gc_img_create(unsigned long w, unsigned long h)

引数

戻り値

説明

イメージを作成します。
イメージはウインドウに描画するための画像データです。
描画用に最適化されているため関数を使って間接的に編集して使用します。

void gc_img_delete(HANDLE himg)

引数

戻り値

説明

イメージを削除します。

void gc_img_update(HANDLE himg, const POS *pos, const RGB_IMG *image, const RECT *rect)

引数

戻り値

説明

イメージの内容を設定します。

int gc_img_copy(HANDLE himg_dest, const POS *pos, const HANDLE himg_src, const RECT *rect)

引数

戻り値

説明

イメージからイメージへ内容をコピーします。

void gc_img_draw(HANDLE hwnd, const POS *pos, const HANDLE himg, const RECT *src)

引数

戻り値

説明

ウインドウにイメージを描画します。

void gc_raw_draw(HANDLE hwnd, const POS *pos, const RAW_BUF *raw_buf, const RECT *src)

引数

戻り値

説明

ウインドウにRAWイメージを描画します。
RAWイメージとはデバイスに依存したイメージデータの事です。
色データの変換処理が無い分高速ですがモードに応じたデータを渡す必要があります。
モードは gc_get_root_info() で取得できます。

入力制御関数

以下の関数は入力を制御します。

HANDLE gc_window_setfocus(HANDLE hwnd)

引数

戻り値

説明

ウインドウにフォーカスを設定します。

void gc_set_mouse_type(int type)

引数

戻り値

説明

マウスカーソルの形状を設定します。

void gc_get_mouse_type(int *type)

引数

戻り値

説明

マウスカーソルの形状を取得します。
type に付いてはgc_set_mouse_type()を参照してください。

void gc_set_mouse_pos(const POS *pos)

引数

戻り値

説明

マウスカーソルの位置を設定します。

void gc_get_mouse_pos(POS *pos)

引数

戻り値

説明

マウスカーソルの位置（スクリーン座標）を取得します。

int gc_grab_mouse(HANDLE hwnd)

引数

戻り値

説明

指定したウインドウにマウスイベントを占有させます。

void gc_free_mouse(HANDLE hwnd)

引数

戻り値

説明

マウスイベントの占有を止めます。

クリップボード関数

以下にクリップボードを操作する関数を記述します。

int gc_clip_set(int type, void *data, unsigned long size)

引数

戻り値

説明

指定データをクリップボードに貼り付けます。
元々有ったデータは新たなデータにより上書きされます。

type には以下の種類が有ります。

画像はRGB_IMG構造体に続けて実データを配置したひと固まりの形式です
ファイルパスは文字列と同じですが複数のパスを含む場合は各パスが空白で区切られます

unsigned long gc_clip_get(int *type, void *data, unsigned long size)

引数

戻り値

説明

クリップボードのデータを取り出します。
size が不足した場合は size 分だけとりだします。

void gc_clip_inf(int *type, unsigned long *size)

引数

戻り値

説明

クリップボードのデータ情報を取り出します。

ドラッグアンドドロップ関数

以下にドラッグアンドドロップの関数を記述します。

int gc_drag(int type, void *data, unsigned long size)

引数

戻り値

説明

指定データをドラッグ状態にします。
ドラッグしたデータは任意のウインドウでドロップできますが、適切な応答が得られるかはドロップしたウインドウしだいです。
データのタイプ等はクリップボードに準拠します。

その他

以下にその他の関数を記述します。

void gc_draw_reserve(void)

引数

戻り値

説明

イベント処理タスクと別タスクで描画処理をする場合に on_paint() イベントとの競合を避けます。
描画処理が終わったらgc_draw_release()を呼び出してロックを解除してください。

void gc_draw_release(void)

引数

戻り値

説明

on_paint() イベントに対する排他制御を解除します。

int gc_get_arg(int *argc, char **argv, long *x, long *y, long *w, long *h)

引数

戻り値

説明

guiアプリ共通のコマンドラインオプションを解析し、値を取得した後に argc/argv から削除します。
x, y, w, h のうち不要なものには NULL を指定できます。
またオプションが指定されていなかった場合は -1 の値が代入されます。

オプションは以下の通りです

指定されたコマンドラインオプションに不備が有った場合は失敗します。

int gc_cnv_arg(long x, long y, long w, long h, RECT *rect)

引数

戻り値

説明

x, y, w, h のパラメータからgc_window_openのパラメータを作成します。
x, y, w, h のうち指定しないものには -1 を指定する事でシステムにまかせられますが、組み合わせに制限があります。
制限に付いてはgc_window_openを参照してください。

int gc_calc_size(const RECT *rect, long *w, long *h)

引数

戻り値

説明

矩形の幅と高さを計算します。

const RECT *gc_calc_rect(long x, long y, long w, long h, RECT *rect)

引数

戻り値

説明

座標値等から矩形を計算します。

int gc_calc_fit(const RECT *target_rect, RECT *rect)

引数

戻り値

説明

rectの内容を縦横比を損なわずにtarget_rectいっぱいに合わせて書き換えます。
矩形の縦横比が異なる場合は全体がtarget_rect内に収まり、かつ中心に配置されます。

int gc_rgb_stretch(RGB_IMG *image_dest, const RECT *rect_dest, const RGB_IMG *image_src, const RECT *rect_src)

引数

戻り値

説明

RGB_IMG形式の画像データをリサイズします。
リサイズ比は縦横別々に指定可能です。

サンプル

以下はサンプルプログラムです。

#include <stdio.h>
#include <string.h>
#include <gui/gc.h>

int _on_window_close(HANDLE hwnd)
{
    /* GUI終了 */
    gc_exit();

    /* クローズ許可 */
    return 1;
}

void _on_window_paint(HANDLE hwnd, const RECT *rect)
{
    POS pos;
    RGB rgb ;

    /* 背景塗りつぶし */
    rgb.r=rgb.g=rgb.b=255;
    gc_set_color(hwnd, &rgb);
    gc_fill_rect(hwnd, rect);

    /* Hello world. の描画 */
    rgb.r=rgb.g=rgb.b=0;
    gc_set_color(hwnd, &rgb);
    pos.x=pos.y=0;
    gc_draw_text(hwnd, &pos, "Hello world.", NULL);
}

int main(int argc, char *argp[])
{
    WINDOW_FUNC func;
    RECT rect;
    int rc=0;

    /* GUI初期化 */
    if (!gc_init()) {
        fprintf(stderr, "can't init gui.\n");
        return rc;
    }

    /* ウインドウ作成 */
    memset(&func, 0, sizeof(func));
    func.on_window_close=_on_window_close;
    func.on_window_paint=_on_window_paint;
    rect.pos[0].x=rect.pos[0].y=100;
    rect.pos[1].x=rect.pos[1].y=200;
    if (gc_window_open(0, &func, &rect, WINDOW_TYPE_ALL)) {
        rc=1;

        /* GUI開始 */
        gc_main();
    }
    else {
        fprintf(stderr, "can't open window.\n");

        /* GUI後始末 */
        gc_exit();
    }

    /* 終了 */
    return rc;
}
	

索引