TNB Library
公開型 | 公開メンバ関数 | 限定公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
CRatioLayout クラス

比率レイアウトアイテムクラス. [詳解]

#include <TnbRatioLayout.h>

+ CRatioLayout の継承関係図

公開型

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

公開メンバ関数

CRatioLayoutAdd (bool isFirst, const ILayout &layout, ELocation hloc=DEFAULT, ELocation vloc=DEFAULT)
 [設定] アイテム追加. [詳解]
 
virtual ILayoutClone (void) const
 [作成] クローン作成. [詳解]
 
 CRatioLayout (bool isHorizental=true, DWORD parsent=50)
 コンストラクタ [詳解]
 
virtual void Decide (int x, int y, WPARAM wParam, LPARAM lParam)
 [処理] 決定. [詳解]
 
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 SetMargnSize (const RECT &rc)
 [設定] 外周マージン設定 [詳解]
 
void SetMargnSize (int mg)
 [設定] 外周マージン設定 [詳解]
 
void SetParameter (bool isHorizental=true, DWORD parsent=50)
 [設定] パラメータ設定. [詳解]
 

限定公開メンバ関数

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
 外周のマージン [詳解]
 

詳解

比率レイアウトアイテムクラス.

2つのレイアウトアイテム縦か横に配置するレイアウトアイテムです。
左側の幅、あるいは、上側の高さを比率(パーセント)で指定できます。
\code
ex) 横並びの場合
┌−−−−−−−−−┐
l┏───┳───┓l
l│ 1 │ 2 │l
l┗───┻───┛l
└−−−−−−−−−┘
※各レイアウトの幅は、全体の幅から、比率指定できます。
※各レイアウトの高さは、全体の高さになります。
\endcode
\code
ex) 縦並びの場合
┌−−−−−┐
l┏───┓l
l│ 1 │l
l┣───┫l
l│ 2 │l
l┗───┛l
└−−−−−┘
※各レイアウトの高さは、全体の高さから、比率指定できます。
※各レイアウトの幅は、全体の高さになります。
\endcode
必要ファイル
TnbRatioLayout.h
日付
09/09/24 新規作成

TnbRatioLayout.h54 行目に定義があります。

型定義メンバ詳解

◆ Ptr

typedef CPointerHandleT<ILayout> Ptr
inherited

ポインタハンドル型宣言

TnbLayout.h83 行目に定義があります。

列挙型メンバ詳解

◆ ELocation

enum ELocation
inherited

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

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

横方向は左寄せ、縦方向は中央

TOP 

上寄せ(縦方向用)

CENTER 

中央

BOTTOM 

下寄せ(縦方向用)

ADJUST 

調整(Resize出来ない場合中央)

LEFT 

左寄せ(横方向用)

RIGHT 

右寄せ(横方向用)

TnbLayout.h203 行目に定義があります。

構築子と解体子

◆ CRatioLayout()

CRatioLayout ( bool  isHorizental = true,
DWORD  parsent = 50 
)

コンストラクタ

引数
isHorizentaltrue なら横並び、 false なら縦並びします。
parsent上か左のレイアウトのパーセント。デフォルトは 50% です。

TnbRatioLayout.h64 行目に定義があります。

関数詳解

◆ Add()

CRatioLayout & Add ( bool  isFirst,
const ILayout layout,
ELocation  hloc = DEFAULT,
ELocation  vloc = DEFAULT 
)

[設定] アイテム追加.

覚え書き
既に設定されている場合、それは破棄されます。
引数
isFirsttrue なら 1st(上か左) 、 false なら 2nd(下か右) のアイテム設定.
layoutレイアウトアイテム.
hloc水平配置種.
vloc垂直配置種.
戻り値
自分の参照.

TnbRatioLayout.h88 行目に定義があります。

◆ AddChinkSize()

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

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

覚え書き
マージン、ギャップの合計を加算
引数
[in,out]_size隙間サイズ
[in]cx横のアイテム数
[in]cy縦のアイテム数

TnbLayout.h438 行目に定義があります。

◆ AddMargnSize()

void AddMargnSize ( SIZE &  _size) const
protectedinherited

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

覚え書き
マージンを加算
引数
[in,out]_sizeマージンサイズ

TnbLayout.h425 行目に定義があります。

◆ Clone()

virtual ILayout * Clone ( void  ) const
virtual

[作成] クローン作成.

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

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

ILayoutを実装しています。

CWideLayoutで再実装されています。

TnbRatioLayout.h99 行目に定義があります。

◆ Decide()

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

[処理] 決定.

覚え書き
オブジェクトが管理しているサイズと指定のサイズにレイアウトします。
引数
xX座標。-1なら指定なし。
yY座標。-1なら指定なし。
wParamW パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。
lParamL パラメータ。本クラスでは使用しません。 本クラスに登録したレイアウトによっては使用される可能性があります。

ILayoutを実装しています。

CWideLayoutで再実装されています。

TnbRatioLayout.h160 行目に定義があります。

◆ GetMargnSize()

void GetMargnSize ( SIZE &  _size) const
protectedinherited

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

引数
[out]_sizeマージンサイズ

TnbLayout.h414 行目に定義があります。

◆ GetMinimumSize()

virtual bool GetMinimumSize ( SIZE &  _size) const
virtual

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

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

引数
[out]_sizeサイズ取得。
戻り値
trueサイズ取得成功。
falseデータがない。

ILayoutを実装しています。

CWideLayoutで再実装されています。

TnbRatioLayout.h113 行目に定義があります。

◆ GetSize()

virtual bool GetSize ( SIZE &  _size) const
virtualinherited

[取得] サイズ取得.

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

引数
[out]_sizeサイズ取得。
戻り値
trueサイズ取得成功。
falseデータがない。

ILayoutを実装しています。

TnbLayout.h276 行目に定義があります。

◆ HorizontalItemDecide()

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

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

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

TnbLayout.h338 行目に定義があります。

◆ Resize()

virtual bool Resize ( const SIZE &  size)
virtualinherited

[設定] サイズ設定.

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

引数
sizeサイズ。
戻り値
trueサイズ変更成功。
false失敗。

ILayoutを実装しています。

TnbLayout.h297 行目に定義があります。

◆ SetGapSize() [1/2]

void SetGapSize ( const SIZE &  size)
inherited

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

引数
sizeギャップ

TnbLayout.h253 行目に定義があります。

◆ SetGapSize() [2/2]

void SetGapSize ( int  size)
inherited

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

引数
sizeギャップ

TnbLayout.h263 行目に定義があります。

◆ SetMargnSize() [1/2]

void SetMargnSize ( const RECT &  rc)
inherited

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

引数
rcマージン

TnbLayout.h233 行目に定義があります。

◆ SetMargnSize() [2/2]

void SetMargnSize ( int  mg)
inherited

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

引数
mgマージン

TnbLayout.h243 行目に定義があります。

◆ SetParameter()

void SetParameter ( bool  isHorizental = true,
DWORD  parsent = 50 
)

[設定] パラメータ設定.

引数
isHorizentaltrue なら横並び、 false なら縦並びします。
parsent上か左のレイアウトのパーセント。デフォルトは 50% です。

TnbRatioLayout.h73 行目に定義があります。

◆ VerticalItemDecide()

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

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

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

TnbLayout.h379 行目に定義があります。

メンバ詳解

◆ m_gapSize

SIZE m_gapSize
protectedinherited

各アイテム間のギャップ(縦、横)

TnbLayout.h326 行目に定義があります。

◆ m_isValidLayoutSize

bool m_isValidLayoutSize
mutableprotectedinherited

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

TnbLayout.h323 行目に定義があります。

◆ m_layoutSize

SIZE m_layoutSize
mutableprotectedinherited

レイアウト全体サイズ(縦、横)

TnbLayout.h324 行目に定義があります。

◆ m_margn

RECT m_margn
protectedinherited

外周のマージン

TnbLayout.h325 行目に定義があります。