CFlowLayout クラス

フローレイアウトアイテムクラス. [詳解]

#include <TnbFlowLayout.h>

CFlowLayout の継承関係図

公開型
enum	ELocation {   DEFAULT , TOP , CENTER , BOTTOM ,   ADJUST , LEFT = TOP , RIGHT = BOTTOM }
	レイアウトアイテム配置方法. [詳解]
typedef CPointerHandleT< ILayout >	Ptr
	ポインタハンドル型宣言 [詳解]

公開メンバ関数
CFlowLayout &	Add (const ILayout &layout, ELocation vloc=DEFAULT)
	[設定] アイテム追加. [詳解]
	CFlowLayout (void)
	コンストラクタ [詳解]
virtual ILayout *	Clone (void) const
	[作成] クローン作成. [詳解]
virtual void	Decide (int x, int y, WPARAM wParam, LPARAM lParam)
	[処理] 決定. [詳解]
int	GetMinimumHeight (size_t width) const
	[取得] 最小高さサイズ取得. [詳解]
virtual bool	GetMinimumSize (SIZE &_size) const
	[取得] 最小サイズ取得. [詳解]
virtual bool	GetSize (SIZE &_size) const
	[取得] サイズ取得. [詳解]
virtual bool	Resize (const SIZE &size)
	[設定] サイズ設定. [詳解]
void	SetGapSize (const SIZE &size)
	[設定] 各アイテム間のギャップ設定 [詳解]
void	SetGapSize (int size)
	[設定] 各アイテム間のギャップ設定 [詳解]
void	SetLineLocation (ELocation hloc=LEFT)
	[設定] 配置設定. [詳解]
void	SetMargnSize (const RECT &rc)
	[設定] 外周マージン設定 [詳解]
void	SetMargnSize (int mg)
	[設定] 外周マージン設定 [詳解]

限定公開メンバ関数
void	AddChinkSize (SIZE &_size, size_t cx, size_t cy) const
	[加算] 隙間サイズ加算. [詳解]
void	AddMargnSize (SIZE &_size) const
	[加算] マージンサイズ加算. [詳解]
void	GetMargnSize (SIZE &_size) const
	[取得] マージンサイズ取得. [詳解]
void	HorizontalItemDecide (ILayout *pLayout, INT_PTR x, INT_PTR xx, INT_PTR width, ELocation loc, WPARAM wParam, LPARAM lParam)
	[設定] 水平方向アイテム決定. [詳解]
void	VerticalItemDecide (ILayout *pLayout, INT_PTR y, INT_PTR yy, INT_PTR height, ELocation loc, WPARAM wParam, LPARAM lParam)
	[設定] 垂直方向アイテム決定. [詳解]

限定公開変数類
SIZE	m_gapSize
	各アイテム間のギャップ（縦、横） [詳解]
bool	m_isValidLayoutSize
	レイアウト全体サイズの設定の有効フラグ [詳解]
SIZE	m_layoutSize
	レイアウト全体サイズ（縦、横） [詳解]
RECT	m_margn
	外周のマージン [詳解]

詳解

フローレイアウトアイテムクラス.

レイアウトアイテムを左から右へ順に配置します。一列に配置しきれなくなったら、改行して配置します。

\code
┌−−−−−−−−−−−−−−−−┐
ｌ┏━━┳━━━┳━━━━┳━━┓ｌ
ｌ┃１　┃　２　┃　３　　┃４　┃ｌ
ｌ┣━━┻┳━━┻┳━━┳┻━━┛ｌ
ｌ┃　５　┃６　　┃７　┃　　　　ｌ
ｌ┣━━━┻━━━┻┳━┛　　　　ｌ
ｌ┃　８　　　　　　┃　　　　　　ｌ
ｌ┗━━━━━━━━┛　　　　　　ｌ
ｌ　　　　　　　　　　　　　　　　ｌ
└−−−−−−−−−−−−−−−−┘
┌−−−−−−−−−−−−−−−−−−−−┐
ｌ┏━━┳━━━┳━━━━┳━━┳━━━┓ｌ
ｌ┃１　┃　２　┃　３　　┃４　┃　５　┃ｌ
ｌ┣━━┻┳━━╋━━━━┻━━┻┳━━┛ｌ
ｌ┃６　　┃７　┃　８　　　　　　┃　　　ｌ
ｌ┗━━━┻━━┻━━━━━━━━┛　　　ｌ
ｌ　　　　　　　　　　　　　　　　　　　　ｌ
ｌ　　　　　　　　　　　　　　　　　　　　ｌ
ｌ　　　　　　　　　　　　　　　　　　　　ｌ
└−−−−−−−−−−−−−−−−−−−−┘
※各レイアウトアイテムの幅は固定です(登録時の大きさのまま)。
※各レイアウトアイテムの高さはその列の一番高いものになります。
\endcode

各レイアウトアイテムはリサイズせずに使用するので、 Add() の前に、あらかじめ大きさを設定しておきます。

覚え書き

各行の配置は SetLineLocation() によって指定できます。

ex) SetLineLocation(RIGHT) の場合
┌−−−−−−−−−−−−−−−−┐
ｌ┏━━┳━━━┳━━━━┳━━┓ｌ
ｌ┃１　┃　２　┃　３　　┃４　┃ｌ
ｌ┗━━┻┳━━┻┳━━━╋━━┫ｌ
ｌ　　　　┃　５　┃６　　┃７　┃ｌ
ｌ　　　　┗━┳━┻━━━┻━━┫ｌ
ｌ　　　　　　┃　８　　　　　　┃ｌ
ｌ　　　　　　┗━━━━━━━━┛ｌ
ｌ　　　　　　　　　　　　　　　　ｌ
└−−−−−−−−−−−−−−−−┘

必要ファイル

TnbFlowLayout.h

日付

08/07/24 新規作成

TnbFlowLayout.h の 74 行目に定義があります。

型定義メンバ詳解

Ptr

typedef CPointerHandleT<ILayout> Ptr

inherited

ポインタハンドル型宣言

TnbLayout.h の 83 行目に定義があります。

列挙型メンバ詳解

ELocation

enum ELocation

inherited

レイアウトアイテム配置方法.

覚え書き

配置する場所の大きさと、レイアウトアイテムの大きさが異なるケースが発生します。 その際、どのようにレイアウトアイテムを置くかを定義しています。

列挙値
DEFAULT	横方向は左寄せ、縦方向は中央
TOP	上寄せ（縦方向用）
CENTER	中央
BOTTOM	下寄せ（縦方向用）
ADJUST	調整（Resize出来ない場合中央）
LEFT	左寄せ（横方向用）
RIGHT	右寄せ（横方向用）

TnbLayout.h の 203 行目に定義があります。

構築子と解体子

CFlowLayout()

CFlowLayout

(

void

)

コンストラクタ

TnbFlowLayout.h の 80 行目に定義があります。

関数詳解

Add()

CFlowLayout & Add	(	const ILayout &	layout,
		ELocation	vloc = DEFAULT
	)

[設定] アイテム追加.

引数

layout	レイアウトアイテム.
vloc	垂直配置種. TOP , CENTER , BOTTOM のいずれかを指定できます。

戻り値

自分の参照.

TnbFlowLayout.h の 101 行目に定義があります。

AddChinkSize()

void AddChinkSize ( SIZE &  _size, size_t  cx, size_t  cy  ) const

protectedinherited

[加算] 隙間サイズ加算.

覚え書き

マージン、ギャップの合計を加算

引数

[in,out]	_size	隙間サイズ
[in]	cx	横のアイテム数
[in]	cy	縦のアイテム数

TnbLayout.h の 438 行目に定義があります。

AddMargnSize()

void AddMargnSize ( SIZE &  _size ) const

protectedinherited

[加算] マージンサイズ加算.

覚え書き

マージンを加算

引数

[in,out]

_size

マージンサイズ

TnbLayout.h の 425 行目に定義があります。

Clone()

virtual ILayout * Clone ( void  ) const

virtual

[作成] クローン作成.

自分と同じ処理を行うクラスを作成します。

戻り値

ポインタ。使用後は delete する必要があります。

ILayoutを実装しています。

TnbFlowLayout.h の 112 行目に定義があります。

Decide()

virtual void Decide ( int  x, int  y, WPARAM  wParam, LPARAM  lParam  )

virtual

[処理] 決定.

覚え書き

オブジェクトが管理しているサイズと指定のサイズにレイアウトします。

引数

x	X座標。-1なら指定なし。
y	Y座標。-1なら指定なし。
wParam	W パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。
lParam	L パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。

ILayoutを実装しています。

TnbFlowLayout.h の 172 行目に定義があります。

GetMargnSize()

void GetMargnSize ( SIZE &  _size ) const

protectedinherited

[取得] マージンサイズ取得.

引数

[out]

_size

マージンサイズ

TnbLayout.h の 414 行目に定義があります。

GetMinimumHeight()

int GetMinimumHeight

(

size_t

width

)

const

[取得] 最小高さサイズ取得.

指定幅の場合の最小高さを得ることが出来ます。

引数

width

幅。

戻り値

マイナス	エラー。
0以上	最小高さ。

TnbFlowLayout.h の 152 行目に定義があります。

GetMinimumSize()

virtual bool GetMinimumSize ( SIZE &  _size ) const

virtual

[取得] 最小サイズ取得.

最小のサイズを得ることが出来ます。

覚え書き

このレイアウトでは高さ＝０、幅＝レイアウトアイテムの最大幅、になります。

引数

[out]

_size

サイズ取得。

戻り値

true	サイズ取得成功。
false	データがない。

ILayoutを実装しています。

TnbFlowLayout.h の 127 行目に定義があります。

GetSize()

virtual bool GetSize ( SIZE &  _size ) const

virtualinherited

[取得] サイズ取得.

現在のサイズを得ることが出来ます。

引数

[out]

_size

サイズ取得。

戻り値

true	サイズ取得成功。
false	データがない。

ILayoutを実装しています。

TnbLayout.h の 276 行目に定義があります。

HorizontalItemDecide()

void HorizontalItemDecide ( ILayout *  pLayout, INT_PTR  x, INT_PTR  xx, INT_PTR  width, ELocation  loc, WPARAM  wParam, LPARAM  lParam  )

protectedinherited

[設定] 水平方向アイテム決定.

引数

pLayout	レイアウト
x	X 位置。 Decide()の x を渡します。
xx	X 位置オフセット
width	幅
loc	配置
wParam	W パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。
lParam	L パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。

TnbLayout.h の 338 行目に定義があります。

Resize()

virtual bool Resize ( const SIZE &  size )

virtualinherited

[設定] サイズ設定.

現在のサイズを変更することが出来ます。

引数

size

サイズ。

戻り値

true	サイズ変更成功。
false	失敗。

ILayoutを実装しています。

TnbLayout.h の 297 行目に定義があります。

SetGapSize() [1/2]

void SetGapSize ( const SIZE &  size )

inherited

[設定] 各アイテム間のギャップ設定

引数

size

ギャップ

TnbLayout.h の 253 行目に定義があります。

SetGapSize() [2/2]

void SetGapSize ( int  size )

inherited

[設定] 各アイテム間のギャップ設定

引数

size

ギャップ

TnbLayout.h の 263 行目に定義があります。

SetLineLocation()

void SetLineLocation

(

ELocation

hloc = LEFT

)

[設定] 配置設定.

列の配置を設定します。デフォルトでは LEFT になっています。

引数

hloc	配置。 CENTER , LEFT , RIGHT のいずれかを指定できます。

TnbFlowLayout.h の 90 行目に定義があります。

SetMargnSize() [1/2]

void SetMargnSize ( const RECT &  rc )

inherited

[設定] 外周マージン設定

引数

rc

マージン

TnbLayout.h の 233 行目に定義があります。

SetMargnSize() [2/2]

void SetMargnSize ( int  mg )

inherited

[設定] 外周マージン設定

引数

mg

マージン

TnbLayout.h の 243 行目に定義があります。

VerticalItemDecide()

void VerticalItemDecide ( ILayout *  pLayout, INT_PTR  y, INT_PTR  yy, INT_PTR  height, ELocation  loc, WPARAM  wParam, LPARAM  lParam  )

protectedinherited

[設定] 垂直方向アイテム決定.

引数

pLayout	レイアウト
y	Y 位置。 Decide()の y を渡します。
yy	Y 位置オフセット
height	高さ
loc	配置
wParam	W パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。
lParam	L パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。

TnbLayout.h の 379 行目に定義があります。

メンバ詳解

m_gapSize

SIZE m_gapSize

protectedinherited

各アイテム間のギャップ（縦、横）

TnbLayout.h の 326 行目に定義があります。

m_isValidLayoutSize

bool m_isValidLayoutSize

mutableprotectedinherited

レイアウト全体サイズの設定の有効フラグ

TnbLayout.h の 323 行目に定義があります。

m_layoutSize

SIZE m_layoutSize

mutableprotectedinherited

レイアウト全体サイズ（縦、横）

TnbLayout.h の 324 行目に定義があります。

m_margn

RECT m_margn

protectedinherited

外周のマージン

TnbLayout.h の 325 行目に定義があります。