Encapsulates structure LVTILEVIEWINFO, used to pass or retrieve tile view information in a TListViewCtrl. More...

#include <owl/listviewctrl.h>

Inheritance diagram for owl::TLvTileViewInfo:

Public Types
enum	TTileSize { FixedWidth = LVTVIF_FIXEDWIDTH , FixedHeight = LVTVIF_FIXEDHEIGHT , FixedSize = LVTVIF_FIXEDSIZE }
	TTileSize describes the sizing of tiles in a list view control. More...

Public Member Functions
Constructors
	TLvTileViewInfo ()
	Constructs an automatic-sized tile view.
	TLvTileViewInfo (int lines)
	Constructs an automatic-sized tile view specified with the maximum number of text lines in each item label.
	TLvTileViewInfo (const TRect &labelMargin)
	Constructs an automatic-sized tile view specified with the coordinates of the label margin.
	TLvTileViewInfo (int lines, const TRect &labelMargin)
	Constructs an automatic-sized tile view specified with the maximum number of text lines in each item label and the coordinates of the label margin.
	TLvTileViewInfo (const TSize &size, TTileSize fixedSize)
	Constructs an fixed-sized tile view.
	TLvTileViewInfo (const TSize &size, TTileSize fixedSize, int lines)
	Constructs an fixed-sized tile view specified with the maximum number of text lines in each item label.
	TLvTileViewInfo (const TSize &size, TTileSize fixedSize, const TRect &labelMargin)
	Constructs an fixed-sized tile view specified with the coordinates of the label margin.
	TLvTileViewInfo (const TSize &size, TTileSize fixedSize, int lines, const TRect &labelMargin)
	Constructs an fixed-sized tile view specified with the maximum number of text lines in each item label and the coordinates of the label margin.
Information changing operations
auto	SetTileSize (const TSize &size) -> void
	Sets the specified tile size.
auto	SetSizeAutomatic () -> void
	Sets the tile view size to automatic.
auto	SetSizeFixed (const TSize &size, TTileSize fixedSize) -> void
	Sets the tile view size to fixed-width and/or fixed-height.
auto	SetMaxTextLines (int lines) -> void
	Sets the specified maximum number of text lines in each item label.
auto	RemoveMaxTextLines () -> void
	Removes the specified maximum number of text lines in each item label.
auto	SetLabelMargin (const TRect &labelMargin) -> void
	Sets the specified coordinates of the label margin.
auto	RemoveLabelMargin () -> void
	Removes the specified coordinates of the label margin.
Query operations
auto	IsSizeAutomatic () const -> bool
	Checks if tile view size is automatic.
auto	IsSizeFixedWidth () const -> bool
	Checks if tile view size is fixed-width.
auto	IsSizeFixedHeight () const -> bool
	Checks if tile view size is fixed-height.
auto	IsSizeFixed () const -> bool
	Checks if tile view size is fixed-height and fixed-width.
Information retrieval operations
auto	GetLabelMargin () const -> TRect
	Retrieves the specified coordinates of the label margin.
auto	GetTileSize () const -> TSize
	Retrieves the specified tile size.
auto	GetMaxTextLines () const -> int
	Retrieves the specified maximum number of text lines in each item label.

Detailed Description

Encapsulates structure LVTILEVIEWINFO, used to pass or retrieve tile view information in a TListViewCtrl.

See also: http://msdn.microsoft.com/en-us/library/windows/desktop/bb774768.aspx

Definition at line 389 of file listviewctrl.h.

Member Enumeration Documentation

◆ TTileSize

enum owl::TLvTileViewInfo::TTileSize

TTileSize describes the sizing of tiles in a list view control.

Enumerator
FixedWidth	Applies a fixed width to the tiles.
FixedHeight	Applies a fixed height to the tiles.
FixedSize	Applies a fixed height and width to the tiles.

Definition at line 397 of file listviewctrl.h.

Constructor & Destructor Documentation

◆ TLvTileViewInfo() [1/8]

owl::TLvTileViewInfo::TLvTileViewInfo ( )

Constructs an automatic-sized tile view.

Definition at line 872 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [2/8]

owl::TLvTileViewInfo::TLvTileViewInfo ( int lines )

Constructs an automatic-sized tile view specified with the maximum number of text lines in each item label.

Parameters

[in] lines the maximum number of text lines in each item label.

Definition at line 888 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [3/8]

owl::TLvTileViewInfo::TLvTileViewInfo ( const TRect & labelMargin )

Constructs an automatic-sized tile view specified with the coordinates of the label margin.

Parameters

[in] labelMargin the coordinates of the label margin.

Definition at line 904 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [4/8]

owl::TLvTileViewInfo::TLvTileViewInfo	(	int	lines,
		const TRect &	labelMargin )

Constructs an automatic-sized tile view specified with the maximum number of text lines in each item label and the coordinates of the label margin.

Parameters

[in]	lines	the maximum number of text lines in each item label.
[in]	labelMargin	the coordinates of the label margin.

Definition at line 923 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [5/8]

owl::TLvTileViewInfo::TLvTileViewInfo	(	const TSize &	size,
		TLvTileViewInfo::TTileSize	fixedSize )

Constructs an fixed-sized tile view.

Parameters

[in]	size	the tile size.
[in]	fixedSize	the fixed-size type.

Definition at line 939 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [6/8]

owl::TLvTileViewInfo::TLvTileViewInfo	(	const TSize &	size,
		TLvTileViewInfo::TTileSize	fixedSize,
		int	lines )

Constructs an fixed-sized tile view specified with the maximum number of text lines in each item label.

Parameters

[in]	size	the tile size.
[in]	fixedSize	the fixed-size type.
[in]	lines	the maximum number of text lines in each item label.

Definition at line 957 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [7/8]

owl::TLvTileViewInfo::TLvTileViewInfo	(	const TSize &	size,
		TLvTileViewInfo::TTileSize	fixedSize,
		const TRect &	labelMargin )

Constructs an fixed-sized tile view specified with the coordinates of the label margin.

Parameters

[in]	size	the tile size.
[in]	fixedSize	the fixed-size type.
[in]	labelMargin	the coordinates of the label margin.

Definition at line 975 of file listviewctrl.cpp.

◆ TLvTileViewInfo() [8/8]

owl::TLvTileViewInfo::TLvTileViewInfo	(	const TSize &	size,
		TLvTileViewInfo::TTileSize	fixedSize,
		int	lines,
		const TRect &	labelMargin )

Constructs an fixed-sized tile view specified with the maximum number of text lines in each item label and the coordinates of the label margin.

Parameters

[in]	size	the tile size.
[in]	fixedSize	the fixed-size type.
[in]	lines	the maximum number of text lines in each item label.
[in]	labelMargin	the coordinates of the label margin.

Definition at line 996 of file listviewctrl.cpp.

Member Function Documentation

◆ GetLabelMargin()

auto owl::TLvTileViewInfo::GetLabelMargin ( ) const -> TRect

inline

Retrieves the specified coordinates of the label margin.

Returns: the coordinates.

Definition at line 474 of file listviewctrl.h.

◆ GetMaxTextLines()

auto owl::TLvTileViewInfo::GetMaxTextLines ( ) const -> int

inline

Retrieves the specified maximum number of text lines in each item label.

Returns: the number of lines.

Definition at line 490 of file listviewctrl.h.

◆ GetTileSize()

auto owl::TLvTileViewInfo::GetTileSize ( ) const -> TSize

inline

Retrieves the specified tile size.

Returns: the tile size.

Definition at line 482 of file listviewctrl.h.

◆ IsSizeAutomatic()

auto owl::TLvTileViewInfo::IsSizeAutomatic ( ) const -> bool

inline

Checks if tile view size is automatic.

Returns: true if tile view size is automatic.

Definition at line 438 of file listviewctrl.h.

◆ IsSizeFixed()

auto owl::TLvTileViewInfo::IsSizeFixed ( ) const -> bool

inline

Checks if tile view size is fixed-height and fixed-width.

Returns: true if tile view size is fixed-height and fixed-width.

Definition at line 462 of file listviewctrl.h.

References FixedSize.

◆ IsSizeFixedHeight()

auto owl::TLvTileViewInfo::IsSizeFixedHeight ( ) const -> bool

inline

Checks if tile view size is fixed-height.

Returns: true if tile view size is fixed-height.

Definition at line 454 of file listviewctrl.h.

References FixedHeight.

◆ IsSizeFixedWidth()

auto owl::TLvTileViewInfo::IsSizeFixedWidth ( ) const -> bool

inline

Checks if tile view size is fixed-width.

Returns: true if tile view size is fixed-width.

Definition at line 446 of file listviewctrl.h.

References FixedWidth.

◆ RemoveLabelMargin()

auto owl::TLvTileViewInfo::RemoveLabelMargin ( ) -> void

Removes the specified coordinates of the label margin.

Returns: none.

Definition at line 1080 of file listviewctrl.cpp.

◆ RemoveMaxTextLines()

auto owl::TLvTileViewInfo::RemoveMaxTextLines ( ) -> void

Removes the specified maximum number of text lines in each item label.

Returns: none.

Definition at line 1054 of file listviewctrl.cpp.

◆ SetLabelMargin()

auto owl::TLvTileViewInfo::SetLabelMargin ( const TRect & labelMargin ) -> void

Sets the specified coordinates of the label margin.

Parameters

[in] labelMargin the coordinates of the label margin.

Returns: none.

Definition at line 1068 of file listviewctrl.cpp.

◆ SetMaxTextLines()

auto owl::TLvTileViewInfo::SetMaxTextLines ( int lines ) -> void

Sets the specified maximum number of text lines in each item label.

Parameters

[in] lines the maximum number of text lines in each item label.

Returns: none.

Definition at line 1042 of file listviewctrl.cpp.

◆ SetSizeAutomatic()

auto owl::TLvTileViewInfo::SetSizeAutomatic ( ) -> void

Sets the tile view size to automatic.

Returns: none.

Definition at line 1012 of file listviewctrl.cpp.

◆ SetSizeFixed()

auto owl::TLvTileViewInfo::SetSizeFixed	(	const TSize &	size,
		TLvTileViewInfo::TTileSize	fixedSize ) -> void

Sets the tile view size to fixed-width and/or fixed-height.

Parameters

[in]	size	the tile size.
[in]	fixedSize	the fixed-size type.

Returns: none.

Definition at line 1027 of file listviewctrl.cpp.

◆ SetTileSize()

auto owl::TLvTileViewInfo::SetTileSize ( const TSize & size ) -> void

Sets the specified tile size.

Parameters

[in] size the tile size.

Returns: none.

Definition at line 1094 of file listviewctrl.cpp.

The documentation for this class was generated from the following files:

include/owl/listviewctrl.h
source/owlcore/listviewctrl.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TTileSize

Constructor & Destructor Documentation

◆ TLvTileViewInfo() [1/8]

◆ TLvTileViewInfo() [2/8]

◆ TLvTileViewInfo() [3/8]

◆ TLvTileViewInfo() [4/8]

◆ TLvTileViewInfo() [5/8]

◆ TLvTileViewInfo() [6/8]

◆ TLvTileViewInfo() [7/8]

◆ TLvTileViewInfo() [8/8]

Member Function Documentation

◆ GetLabelMargin()

◆ GetMaxTextLines()

◆ GetTileSize()

◆ IsSizeAutomatic()

◆ IsSizeFixed()

◆ IsSizeFixedHeight()

◆ IsSizeFixedWidth()

◆ RemoveLabelMargin()

◆ RemoveMaxTextLines()

◆ SetLabelMargin()

◆ SetMaxTextLines()

◆ SetSizeAutomatic()

◆ SetSizeFixed()

◆ SetTileSize()