haiku/headers/libs/alm/Area.h

/*
 * Copyright 2006 - 2010, Haiku, Inc. All rights reserved.
 * Distributed under the terms of the MIT License.
 */
#ifndef	AREA_H
#define	AREA_H


#include <vector>

#include <Alignment.h>
#include <List.h>
#include <Size.h>
#include <SupportDefs.h>
#include <View.h>

#include "Column.h"
#include "LinearSpec.h"
#include "Row.h"
#include "Tab.h"


#define USE_SCALE_VARIABLE 0


class Constraint;


namespace BALM {


class GroupItem {
public:
								GroupItem(BLayoutItem* item);
								GroupItem(BView* view);

			BLayoutItem*		LayoutItem();
			BView*				View();

	const	std::vector<GroupItem>&	GroupItems();
			enum orientation	Orientation();

			GroupItem& 			operator|(const GroupItem& right);
			GroupItem& 			operator/(const GroupItem& bottom);
private:
								GroupItem();

			void				_Init(BLayoutItem* item, BView* view,
									  enum orientation orien = B_HORIZONTAL);
			GroupItem& 			_AddItem(const GroupItem& item,
									enum orientation orien);

			BLayoutItem*		fLayoutItem;
			BView*				fView;

			std::vector<GroupItem>	fGroupItems;
			enum orientation	fOrientation;
};


/**
 * Rectangular area in the GUI, defined by a tab on each side.
 */
class Area {
public:
								~Area();

			BView*				View();

			XTab*				Left() const;
			XTab*				Right() const;
			YTab*				Top() const;
			YTab*				Bottom() const;
			void				SetLeft(XTab* left);
			void				SetRight(XTab* right);
			void				SetTop(YTab* top);
			void				SetBottom(YTab* bottom);

			Row*				GetRow() const;
			Column*				GetColumn() const;
			void				SetRow(Row* row);
			void				SetColumn(Column* column);

			double				ContentAspectRatio() const;
			void				SetContentAspectRatio(double ratio);

			BSize				ShrinkPenalties() const;
			BSize				GrowPenalties() const;
			void				SetShrinkPenalties(BSize shrink);
			void				SetGrowPenalties(BSize grow);

			float				LeftInset() const;
			float				TopInset() const;
			float				RightInset() const;
			float				BottomInset() const;
			void				SetLeftInset(float left);
			void				SetTopInset(float top);
			void				SetRightInset(float right);
			void				SetBottomInset(float bottom);

								operator BString() const;
			void				GetString(BString& string) const;

			Constraint*			SetWidthAs(Area* area, float factor = 1.0f);
			Constraint*			SetHeightAs(Area* area, float factor = 1.0f);

			void				InvalidateSizeConstraints();

private:
								Area(BLayoutItem* item);

#if USE_SCALE_VARIABLE
			void				_Init(LinearSpec* ls, XTab* left, YTab* top,
									XTab* right, YTab* bottom,
									Variable* scaleWidth,
									Variable* scaleHeight);
			void				_Init(LinearSpec* ls, Row* row, Column* column,
									Variable* scaleWidth,
									Variable* scaleHeight);
#else
			void				_Init(LinearSpec* ls, XTab* left, YTab* top,
									XTab* right, YTab* bottom);
			void				_Init(LinearSpec* ls, Row* row, Column* column);
#endif

			void				_DoLayout();

			void				_UpdateMinSizeConstraint(BSize min);
			void				_UpdateMaxSizeConstraint(BSize max);
			void				_UpdatePreferredWidthConstraint(
									BSize& preferred);
			void				_UpdatePreferredHeightConstraint(
									BSize& preferred);
			void				_SetupPreferredConstraints();
private:
			BLayoutItem*		fLayoutItem;

			LinearSpec*			fLS;

			XTab*				fLeft;
			XTab*				fRight;
			YTab*				fTop;
			YTab*				fBottom;

			Row*				fRow;
			Column*				fColumn;
			
			BSize				fShrinkPenalties;
			BSize				fGrowPenalties;

			BSize				fTopLeftInset;
			BSize				fRightBottomInset;

			BList				fConstraints;
			Constraint*			fMinContentWidth;
			Constraint*			fMaxContentWidth;
			Constraint*			fMinContentHeight;
			Constraint*			fMaxContentHeight;
			Constraint*			fPreferredContentWidth;
			Constraint*			fPreferredContentHeight;
			double				fContentAspectRatio;
			Constraint*			fContentAspectRatioC;

#if USE_SCALE_VARIABLE
			Variable*			fScaleWidth;
			Variable*			fScaleHeight;
#endif
public:
	friend class		BALMLayout;

};

}	// namespace BALM

using BALM::Area;
using BALM::GroupItem;

#endif	// AREA_H