RmControlPlacementContainer Class Reference

Control arrangment helper class. More...

#include <RmUtilControlPlacement.h>

List of all members.

Public Types
enum	RmControlLocationType {   LocationLeft = 0, LocationRight, LocationTop, LocationBottom,   LocationLeftRightLerp, LocationTopBottomLerp, LocationVisibility }
	Definitions for location type. More...
Public Member Functions
virtual	~RmControlPlacementContainer ()
	Destructor.
void	EmptyControlPlacementContainer ()
void	ProcessControlPlacementContainer ()
void	Attach (RmControlPlacementContainer *pRmControlPlacementContainer)
void	Bind (HWND hDestinationWnd, RmControlLocationType rmDestinationControlLocationType, HWND hSourceWnd, RmControlLocationType rmSourceControlLocationType, int nOffset=0, float fInterpolationValue=0.0f, bool bVisible=true)
void	BindControlRelativeLeft (HWND hControlWnd, int nOffset=0)
void	BindControlRelativeRight (HWND hControlWnd, int nOffset=0)
void	BindControlRelativeTop (HWND hControlWnd, int nOffset=0)
void	BindControlRelativeBottom (HWND hControlWnd, int nOffset=0)
void	BindControlLeft (HWND hControlWnd, int nOffset=0)
void	BindControlRight (HWND hControlWnd, int nOffset=0)
void	BindControlTop (HWND hControlWnd, int nOffset=0)
void	BindControlBottom (HWND hControlWnd, int nOffset=0)
void	BindControlLeftOf (HWND hControlWnd, HWND hSourceWnd, int nOffset=0)
void	BindControlRightOf (HWND hControlWnd, HWND hSourceWnd, int nOffset=0)
void	BindControlTopOf (HWND hControlWnd, HWND hSourceWnd, int nOffset=0)
void	BindControlBottomOf (HWND hControlWnd, HWND hSourceWnd, int nOffset=0)
void	BindControlRelativeTo (HWND hControlWnd, HWND hSourceWnd)
void	BindControlVisibility (HWND hControlWnd, bool bVisible)
Protected Types
typedef RmLinkedList< RmHwndRectInfo * >	RmHwndRectInfoList
typedef RmHwndRectInfoList::iterator	RmHwndRectInfoListIterator
typedef RmHwndRectInfoList::const_iterator	RmHwndRectInfoListConstIterator
typedef RmLinkedList< RmControlLocationPlacementInfo * >	RmControlLocationPlacementInfoList
typedef RmControlLocationPlacementInfoList::iterator	RmControlLocationPlacementInfoIterator
typedef RmControlLocationPlacementInfoList::const_iterator	RmControlLocationPlacementInfoConstIterator
Protected Member Functions
LONG *	GetRectLocationValuePtr (RECT *pRect, RmControlLocationType rmControlLocationType)
LONG	GetRectLocationValue (RECT *pRect, RmControlLocationType rmControlLocationType, float fInterpolationValue)
RECT *	GetHwndRect (HWND hWnd)
Protected Attributes
RmControlLocationPlacementInfoList	m_rmControlLocationPlacementInfoList
	List of placement info.
RmHwndRectInfoList	m_rmHwndRectInfoList
	List of rectangle info.

---

Detailed Description

Control arrangment helper class.

Contains control offset information for dynamic positioning and sizing

---

Member Enumeration Documentation

enum RmControlPlacementContainer::RmControlLocationType

Definitions for location type. Enumeration values: LocationLeft  Left location. LocationRight  Right location. LocationTop  Top location. LocationBottom  Bottom location. LocationLeftRightLerp  Left to right interpolated location. LocationTopBottomLerp  Top to bottom interpolated location. LocationVisibility  Control Visibility.

---

Member Function Documentation

void RmControlPlacementContainer::Attach (  RmControlPlacementContainer *  pRmControlPlacementContainer  )

Attaches an external container to this container Parameters: pRmControlPlacementContainer  Placement container See also: pRmControlPlacementContainer Returns: None

void RmControlPlacementContainer::Bind (  HWND  hDestinationWnd, RmControlLocationType  rmDestinationControlLocationType, HWND  hSourceWnd, RmControlLocationType  rmSourceControlLocationType, int  nOffset = 0, float  fInterpolationValue = 0.0f, bool  bVisible = true )

Adds binding placement info into the container Parameters: hDestinationWnd  Destination window rmDestinationControlLocationType  Location type See also: RmControlLocationType Parameters: hSourceWnd  Source window rmSourceControlLocationType  Location type See also: RmControlLocationType Parameters: offset  Offset fInterpolationValue  Interpolated value Returns: None

void RmControlPlacementContainer::BindControlBottom (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to bottom Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlBottomOf (  HWND  hControlWnd, HWND  hSourceWnd, int  nOffset = 0 )

Relative Border Binding bottom Parameters: hControlWnd  Window hSourceWnd  Source window nOffset  Offset Returns: None

void RmControlPlacementContainer::BindControlLeft (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to left Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlLeftOf (  HWND  hControlWnd, HWND  hSourceWnd, int  nOffset = 0 )

Relative Border Binding left Parameters: hControlWnd  Window hSourceWnd  Source window nOffset  Offset Returns: None

void RmControlPlacementContainer::BindControlRelativeBottom (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to bottom Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlRelativeLeft (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to left Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlRelativeRight (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to right Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlRelativeTo (  HWND  hControlWnd, HWND  hSourceWnd )

Relative Binding Utility Parameters: hControlWnd  Window hSourceWnd  Source window Returns: None

void RmControlPlacementContainer::BindControlRelativeTop (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to top Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlRight (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to right Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlRightOf (  HWND  hControlWnd, HWND  hSourceWnd, int  nOffset = 0 )

Relative Border Binding right Parameters: hControlWnd  Window hSourceWnd  Source window nOffset  Offset Returns: None

void RmControlPlacementContainer::BindControlTop (  HWND  hControlWnd, int  nOffset = 0 )

Parent Border Binding to top Parameters: hControlWnd  Window Returns: None

void RmControlPlacementContainer::BindControlTopOf (  HWND  hControlWnd, HWND  hSourceWnd, int  nOffset = 0 )

Relative Border Binding top Parameters: hControlWnd  Window hSourceWnd  Source window nOffset  Offset Returns: None

void RmControlPlacementContainer::BindControlVisibility (  HWND  hControlWnd, bool  bVisible )

Visibility Binding Utility Parameters: hControlWnd  Window bVisible  Visibility flag Returns: None

void RmControlPlacementContainer::EmptyControlPlacementContainer (   )

Empties the control placement container Returns: None

RECT* RmControlPlacementContainer::GetHwndRect (  HWND  hWnd  )  [protected]

Returns the rect associated with the hWnd Parameters: hWnd  Window Returns: Pointer to rectangle

LONG RmControlPlacementContainer::GetRectLocationValue (  RECT *  pRect, RmControlLocationType  rmControlLocationType, float  fInterpolationValue )  [protected]

Returns the value as determined by rmControlLocationType and fInterpolationValue (if required) Parameters: pRect  Rectangle rmControlLocationType  Location type fInterpolationValue  Interpolated value

LONG* RmControlPlacementContainer::GetRectLocationValuePtr (  RECT *  pRect, RmControlLocationType  rmControlLocationType )  [protected]

Returns a pointer to the rect member as determined by rmControlLocationType Parameters: pRect  Rectangle rmControlLocationType  Location type Returns: Pointer to rectangle

void RmControlPlacementContainer::ProcessControlPlacementContainer (   )

Processes the control placement container Returns: None

---

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

• RmUtilControlPlacement.h

---