第９回 dragしたいお年頃

えー、というわけで、今回はdrugならぬdrag & dropです。
実はBeOS標準のsample-codeにDropWorldというのがありまして、
今回のサンプルはそれとあまり変わらなくなってしまったのですが、
次回に繋げるためのサンプルですので、ご了承ください。

あと、今回はBStringViewとBFontという二つのクラスを紹介します。
BStringViewはビューに描く文字列のクラスです。
BView::Drawをオーバーライドしていちいち書き直す必要がないのが特徴です。
BFontはその名の通りフォントを示すクラスです。
今回はBFontを使用して、表示する文字列の長さに応じて、BStringViewの大きさを変更しています。

さて今回のソース全体です。

// sample07.cpp

#include <Application.h>        // BApplicationを使うために必要
#include <Window.h>             // BWindowを使うために必要
#include <View.h>               // BViewを使うために必要
#include <Alert.h>			// BAlertを使うために必要
#include <StringView.h>		// BStringViewを使うために必要
#include <Font.h>			// BFontを使うために必要
#include <Entry.h>			// entry_ref構造体を使うために必要

// クラスの前方宣言
class MyApp;
class MyWindow;
class MyView;

class MyApp : public BApplication
{
public:
	MyApp();
private:
	MyWindow* m_win;
};

class MyWindow : public BWindow
{
public:
	MyWindow(BRect frame,const char* title,window_type type,uint32 flags);
	virtual bool QuitRequested();	// 終了が要求されたときに呼ばれる関数
private:
	MyView* m_view;
};
 
class MyView : public BView
{
public:
	MyView(BRect frame,const char *name,uint32 resizingMode,uint32 flags);
	~MyView();
	virtual void MessageReceived(BMessage* message);
private:
	void AutoFitStringView(const char* string);  // BStringViewを適切にリサイズする
	BStringView* m_string_view; // 表示する文字列
};

MyApp::MyApp()
      :BApplication("application/x-vnd.big56-MyApp")
{
	m_win = new MyWindow(BRect(100,100,300,150),"ドラッグ&ドロップ",B_TITLED_WINDOW,0);
	m_win->Show();
}

MyWindow::MyWindow(BRect frame,const char* title,window_type type,uint32 flags)
		:BWindow(frame,title,type,flags)
{
	frame.OffsetTo(0,0);  // 与えられたBRectの左上が(0,0)になるようにする

	m_view = new MyView(frame,"theView",B_FOLLOW_ALL_SIDES,B_WILL_DRAW);
	AddChild(m_view);	
}

bool MyWindow::QuitRequested()
{
// アプリケーションを終了する
	be_app->Quit();
	return true;
}

MyView::MyView(BRect frame,const char* title,uint32 resizingMode,uint32 flags)
	  :BView(frame,title,resizingMode,flags)
{
	m_string_view = new BStringView(BRect(10,10,150,30),"thStringView","ファイルをドロップしてください");
	AutoFitStringView("ファイルをドロップしてください");
	
	AddChild(m_string_view);
}

MyView::~MyView()
{
}

void MyView::MessageReceived(BMessage* message)
{
	entry_ref ref; // ファイルを表す構造体
	
	switch(message->what)
	{
	// ファイルがドラッグされたときに、ビューはB_SIMPLE_DATAというメッセージを受け取る
	// その時、"refs"というキーで、ファイルを示すentry_refという構造体がメッセージに含まれる
	// entry_refのnameというフィールドにファイル名(フルパスではない)が入っている
	case B_SIMPLE_DATA:
		// entry_ref構造体が正常に取得できたら処理を開始
		if (message->FindRef("refs",&ref) == B_OK)		
		{
			AutoFitStringView(ref.name);
			m_string_view->SetText(ref.name);
		}
		break;
	default: 
		BView::MessageReceived(message);
		break;
	}
}

// 与えられた文字列に対して、m_string_viewを適切な長さに設定する
void MyView::AutoFitStringView(const char* string)
{
	BFont font(be_plain_font);	// be_plain_fontはユーザーがシステム設定しているフォント
	font_height f_height;

	float width,height; // 文字の幅と高さ

	// StringWidthで文字列の幅の長さを取得出来る
	width = font.StringWidth(string);  

	// 文字の高さはまずfont_height構造体を取得する必要がある
	font.GetHeight(&f_height);   

	// アセントどデセントを足した値がフォントの高さ	
	height = f_height.ascent + f_height.descent;  

	m_string_view->ResizeTo(width,height);
}

int main(int argc,char** argv)
{
 	MyApp app;
	app.Run();
	return 0;
}

今回の実行結果です。

最初はこのような画面が表示されますが、ウィンドウ内にファイルをドラッグすると次の様になります。

といった感じに、ファイル名が表示されます。

まず最初に、表示する文字列に関する部分、BStringViewに関する場所を見てみましょう。

	m_string_view = new BStringView(BRect(10,10,150,30),"thStringView","ファイルをドロップしてください");
	AutoFitStringView("ファイルをドロップしてください");

BStringViewはビューに表示する文字列を扱うクラスです。
第４回でBView::DrawString()関数というもので、文字列を描画しましたが、
このBStringViewはそれに変わるものとして考えてもらって構いません。
これは、Windowsのコントロールの名前を借りていうならば、ラベルに当たるものです。

BStringViewのコンストラクタの引数並びは次の様になっております。

BStringView(BRect frame, const char *name, const char *text, 		uint32 resizingMode = B_FOLLOW_LEFT | B_FOLLOW_TOP, 
	    uint32 flags = B_WILL_DRAW)

• BStringViewの矩形の大きさ(frame)
• ビューの名前(name)
• ビューに描く文字列(text)
• リサイズ時の動作(resizingMode) 第４回参照
• その他のフラグ(flags) 第４回参照

コンストラクタでは、resizingModeとflagsが=(イコール)で結ばれていますが、
これは引数を指定しないと、デフォルトでその値になることを示しています。

BStringViewのコンストラクタではBMessageを指定していませんが、
BStringViewはメッセージを送信することはありません。ただ画面に表示されるのみです。
コンストラクタの引数では特に目新しいものを指定していないので、そこまで難しくないと思います。

さて、BStringViewを構築はしましたが、今回のサンプルでは文字列の長さに合わせて
適切な大きさにサイズ変更しています。
これをしないと、文字列が途中で切れたりすることになります。

「え〜それだったら、BView::DrawString()関数の方が大きさを考えなくてすむので楽じゃん」
と思われる方もいると思いますが、たいていのアプリケーションでは、
コンストラクタ時に表示する文字列を決めたらその後変わることがほとんどないのと、
サンプルではBFontの使い方の一例を示すために、わざとサイズ変更をやっています。
多分こんなコーディングはまれだと思います。

さて、BStringViewのサイズ変更をする関数、AutoFitStringView()関数を見てみましょう。
これは、MessageReceived()関数などのBeOSのシステムで定義されている関数ではなく、
自分で勝手に定義した関数です。

// 与えられた文字列に対して、m_string_viewを適切な長さに設定する
void MyView::AutoFitStringView(const char* string)
{
	BFont font(be_plain_font);	// be_plain_fontはユーザーがシステム設定しているフォント
	font_height f_height;

	float width,height; // 文字の幅と高さ

	// StringWidthで文字列の幅の長さを取得出来る
	width = font.StringWidth(string);  

	// 文字の高さはまずfont_height構造体を取得する必要がある
	font.GetHeight(&f_height);   

	// アセントどデセントを足した値がフォントの高さ	
	height = f_height.ascent + f_height.descent;  

	m_string_view->ResizeTo(width,height);
}

BFontは文字のフォントを代表するクラスです。
BFontの機能としては、次の表に示すものがあります。

• 文を書く方向(左から右か、右から左か) (Direction()関数)
• 文字の大きさに関する情報(GetHeight() StringWidth()関数など)
• 文字列の切り詰め(GetTruncatedStrings()関数 )
• その他、フォントの大きさや、フォントのタイプ設定の時に使用 ( SetFamilyAndStyle()関数)

ここにあげたのはほんの一例で、特に文字の印刷や描画の際の大きさの設定に関しては
非常に多くの機能を持っています。

BFontのコンストラクタではbe_plain_fontを指定しています。
これは[Preference] - [Fonts]でユーザーが設定したフォントです。

他に、Bold Fontを指定したい場合はbe_bold_fontを、
Fixed fontを指定したい場合は、be_fixed_fontを
それぞれコンストラクタに指定します。
これらは、BFont* 型で、グローバルポインタとしてBFont.hのファイル内で宣言されています。

float StringWidth(const char *string) const;
void GetHeight(font_height *height) const;

StringWidthでは、文字列を与えると、それに応じた幅の大きさがfloat型で返ってきます。
この値は同じ文字列でも、フォントの種類や大きさによって当然変わってきます。

GetHeight関数は、font_height構造体を通して、文字列の高さを取得します。
font_height構造体には次の３つのfloat型のフィールドがあります。

最後にBView::ResizeTo()関数で、BStringViewの大きさをリサイズします。
BStringViewもビューの一種なのでBViewからの派生クラスなわけですが、
BViewで定義されているResizeTo()関数によって、どの種類のビューでもサイズ変更が可能になっています。

	void ResizeTo(float width, float height)

ResizeTo()関数では、横の長さ(width)と高さ(height)を指定します。
そうすると、ビューの左上の点はそのままですが、大きさが変わります。

さて、やっと今回のメイン、ドロップされたファイルに対する処理を見てみましょう。

	entry_ref ref; // ファイルを表す構造体
	
	switch(message->what)
	{
	// ファイルがドラッグされたときに、ビューはB_SIMPLE_DATAというメッセージを受け取る
	// その時、"refs"というキーで、ファイルを示すentry_refという構造体がメッセージに含まれる
	// entry_refのnameというフィールドにファイル名(フルパスではない)が入っている
	case B_SIMPLE_DATA:
		// entry_ref構造体が正常に取得できたら処理を開始
		if (message->FindRef("refs",&ref) == B_OK)		
		{
			AutoFitStringView(ref.name);
			m_string_view->SetText(ref.name);
		}
		break;

ファイルがドロップされた時は、B_SIMPLE_DATAというメッセージを受け取ります。
その時に、"refs"にドロップされたファイルの情報が入っているので、
ファイル名取得のためにそれを使用します。

第７回でBMessageのFindRef()関数は、entry_ref構造体を見つけだすために使用すると書きましたが
entry_ref構造体とは、ファイルを表す構造体であり、イメージとしてはC言語のFILE* や、
UNIXのファイルディスクリプタ(こっちの方が近いかも)にあたります。
entry_refはBEntryやBFile、BDirectoryといったクラスを通して使うことがほとんどですが、
ファイル名の取得だけならば、char* 型のnameフィールドにアクセスすればいいです。

このサンプルでは、
FindRefでentry_refを取得→BStringViewのサイズ変更→BStringViewの文字列変更
という流れになっています。
BStringViewのSetTexi()関数は今回初めて出てきましたが、引数に変更する文字列を指定するだけです。
サンプルを見ればわかると思います。

今回はBStringViewとBFontとB_SIMPLE_DATAという３部作でお送りしましたがいかがでしたでしょうか？
最近は１回ごとにやる内容が多くなっているような気がします。
なるべくわかりやすくをモットーに書いていますが、疑問点などあったらメールください。
適宜補完して書いていきたいと思いますので。

さて次回はこのアプリを元に簡易音楽ファイル再生プレイヤーを作ってみたいと思います。

低金利でお得なローン探し 生命保険の切り替えはココ そろそろ結婚適齢期？？？