haiku-beta6/src/kits/interface/TabView.cpp

//------------------------------------------------------------------------------
//	Copyright (c) 2001-2002, OpenBeOS
//
//	Permission is hereby granted, free of charge, to any person obtaining a
//	copy of this software and associated documentation files (the "Software"),
//	to deal in the Software without restriction, including without limitation
//	the rights to use, copy, modify, merge, publish, distribute, sublicense,
//	and/or sell copies of the Software, and to permit persons to whom the
//	Software is furnished to do so, subject to the following conditions:
//
//	The above copyright notice and this permission notice shall be included in
//	all copies or substantial portions of the Software.
//
//	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//	DEALINGS IN THE SOFTWARE.
//
//	File Name:		TabView.cpp
//	Author:			Marc Flerackers ([email protected])
//	Description:	BTab creates individual "tabs" that can be assigned
//                  to specific views.
//                  BTabView provides the framework for containing and
//                  managing groups of BTab objects.
//------------------------------------------------------------------------------

// Standard Includes -----------------------------------------------------------

// System Includes -------------------------------------------------------------
#include <TabView.h>
#include <Message.h>
#include <List.h>
#include <Rect.h>
#include <Errors.h>

// Project Includes ------------------------------------------------------------

// Local Includes --------------------------------------------------------------

// Local Defines ---------------------------------------------------------------

// Globals ---------------------------------------------------------------------

//------------------------------------------------------------------------------
BTab::BTab(BView *tabView)
	:	fEnabled(true),
		fSelected(false),
		fFocus(false),
		fView(tabView)
{
}
//------------------------------------------------------------------------------
BTab::~BTab()
{
	if (!fView)
		return;

	if (fSelected)
		fView->RemoveSelf();

	delete fView;
}
//------------------------------------------------------------------------------
BTab::BTab(BMessage *archive)
	:	fSelected(false),
		fFocus(false),
		fView(NULL)
{
	bool disable;

	if (archive->FindBool("_disable", &disable) != B_OK)
		SetEnabled(true);
	else
		SetEnabled(!disable);
}
//------------------------------------------------------------------------------
BArchivable *BTab::Instantiate(BMessage *archive)
{
	if (validate_instantiation(archive, "BTab"))
		return new BTab(archive);
	else
		return NULL;
}
//------------------------------------------------------------------------------
status_t BTab::Archive(BMessage *archive, bool deep) const
{
	status_t err = BArchivable::Archive(archive, deep);

	if (err != B_OK)
		return err;

	if (!fEnabled)
		err = archive->AddBool("_disable", false);

	return err;
}
//------------------------------------------------------------------------------
status_t BTab::Perform(uint32 d, void *arg)
{
	return BArchivable::Perform(d, arg);
}
//------------------------------------------------------------------------------
const char *BTab::Label() const
{
	if (fView)
		return fView->Name();
	else
		return NULL;
}
//------------------------------------------------------------------------------
void BTab::SetLabel(const char *label)
{
	if (!label)
		return;

	if (!fView)
		return;

	fView->SetName(label);
}
//------------------------------------------------------------------------------
bool BTab::IsSelected() const
{
	return fSelected;
}
//------------------------------------------------------------------------------
void BTab::Select(BView *owner)
{	
	if (!owner)
		return;

	if (!View())
		return;

	if (!owner->Window())
		return;

	owner->AddChild(fView);
	//fView->Show();

	fSelected = true;
}
//------------------------------------------------------------------------------
void BTab::Deselect()
{
	if (View())
		View()->RemoveSelf();

	fSelected = false;
}
//------------------------------------------------------------------------------
void BTab::SetEnabled(bool enabled)
{
	fEnabled = enabled;
}
//------------------------------------------------------------------------------
bool BTab::IsEnabled() const
{
	return fEnabled;
}
//------------------------------------------------------------------------------
void BTab::MakeFocus(bool inFocus)
{
	fFocus = inFocus;
}
//------------------------------------------------------------------------------
bool BTab::IsFocus() const
{
	return fFocus;
}
//------------------------------------------------------------------------------
void BTab::SetView(BView *view)
{
	if (!view)
		return;

	if (fView == view)
		return;

	if (fView == NULL)
		fView = view;
	else
	{
		fView->RemoveSelf();
		delete fView;
		fView = view;
	}
}
//------------------------------------------------------------------------------
BView *BTab::View() const
{
	return fView;
}
//------------------------------------------------------------------------------
void BTab::DrawFocusMark(BView *owner, BRect frame)
{
	float width = owner->StringWidth(Label());

	owner->SetHighColor(ui_color(B_KEYBOARD_NAVIGATION_COLOR));
	owner->StrokeLine(BPoint(frame.left + frame.Width() * 0.5f - width * 0.5f, frame.bottom),
		BPoint(frame.left + frame.Width() * 0.5f + width * 0.5f, frame.bottom));
}
//------------------------------------------------------------------------------
void BTab::DrawLabel(BView *owner, BRect frame)
{
	const char *label = Label();

	if (label)
	{
		owner->SetHighColor(0, 0, 0);
		owner->DrawString(label, BPoint(frame.left + frame.Width() * 0.5f -
			owner->StringWidth(label) * 0.5f, frame.bottom - 4.0f - 2.0f));
	}
}
//------------------------------------------------------------------------------
void BTab::DrawTab(BView *owner, BRect frame, tab_position position, bool full)
{
	rgb_color no_tint = ui_color(B_PANEL_BACKGROUND_COLOR),
		lightenmax = tint_color(no_tint, B_LIGHTEN_MAX_TINT),
		darken4 = tint_color(no_tint, B_DARKEN_4_TINT),
		darkenmax = tint_color(no_tint, B_DARKEN_MAX_TINT);

	owner->SetHighColor(darkenmax);
	owner->SetLowColor(no_tint);
	DrawLabel(owner, frame);

	owner->BeginLineArray(12);

	if (position != B_TAB_ANY)
	{
		owner->AddLine(BPoint(frame.left - 2.0f, frame.bottom),
			BPoint(frame.left - 1.0f, frame.bottom - 1.0f), lightenmax);
		owner->AddLine(BPoint(frame.left, frame.bottom - 2.0f),
			BPoint(frame.left, frame.bottom - 3.0f), lightenmax);
	}

	owner->AddLine(BPoint(frame.left + 1.0f, frame.bottom - 4.0f),
		BPoint(frame.left + 1.0f, frame.top + 5.0f), lightenmax);
	owner->AddLine(BPoint(frame.left + 1.0f, frame.top + 4.0f),
		BPoint(frame.left + 2.0f, frame.top + 2.0f), lightenmax);
	owner->AddLine(BPoint(frame.left + 3.0f, frame.top + 1.0f),
		BPoint(frame.left + 4.0f, frame.top + 1.0f), lightenmax);
	owner->AddLine(BPoint(frame.left + 5.0f, frame.top),
		BPoint(frame.right - 5.0f, frame.top), lightenmax);

	owner->AddLine(BPoint(frame.right - 4.0f, frame.top + 1.0f),
		BPoint(frame.right - 3.0f, frame.top + 1.0f), lightenmax);

	owner->AddLine(BPoint(frame.right - 2.0f, frame.top + 2.0f),
		BPoint(frame.right - 2.0f, frame.top + 3.0f), darken4);
	owner->AddLine(BPoint(frame.right - 1.0f, frame.top + 4.0f),
		BPoint(frame.right - 1.0f, frame.bottom - 4.0f), darken4);

	if (full)
	{ 
		owner->AddLine(BPoint(frame.right, frame.bottom - 3.0f),
			BPoint(frame.right, frame.bottom - 2.0f), darken4);
		owner->AddLine(BPoint(frame.right + 1.0f, frame.bottom - 1.0f),
			BPoint(frame.right + 2.0f, frame.bottom), darken4);
	}

	owner->EndLineArray();
}
//------------------------------------------------------------------------------
void BTab::_ReservedTab1() {}
void BTab::_ReservedTab2() {}
void BTab::_ReservedTab3() {}
void BTab::_ReservedTab4() {}
void BTab::_ReservedTab5() {}
void BTab::_ReservedTab6() {}
void BTab::_ReservedTab7() {}
void BTab::_ReservedTab8() {}
void BTab::_ReservedTab9() {}
void BTab::_ReservedTab10() {}
void BTab::_ReservedTab11() {}
void BTab::_ReservedTab12() {}
//------------------------------------------------------------------------------
BTab &BTab::operator=(const BTab &)
{
	return *this;
}
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
BTabView::BTabView(BRect frame, const char *name, button_width width, 
		uint32 resizingMode, uint32 flags)
	:	BView(frame, name, resizingMode, flags)
{
	_InitObject();

	fTabWidthSetting = width;
}
//------------------------------------------------------------------------------
BTabView::~BTabView()
{
	for (int32 i = 0; i < CountTabs(); i++)
	{
		if (TabAt(i))
			delete TabAt(i);
	}

	delete fTabList;
}
//------------------------------------------------------------------------------
BTabView::BTabView(BMessage *archive)
	:	BView(archive),
		fFocus(-1)
{
	fContainerView = NULL;
	fTabList = new BList;

	int16 width;

	if (archive->FindInt16("_but_width", &width) == B_OK)
		fTabWidthSetting = (button_width)width;
	else
		fTabWidthSetting = B_WIDTH_AS_USUAL;

	if (archive->FindFloat("_high", &fTabHeight) != B_OK)
	{
		font_height fh;
		GetFontHeight(&fh);
		fTabHeight = fh.ascent + fh.descent + fh.leading + 8.0f;
	}
	
	fFocus = -1;
		
	if (archive->FindInt32("_sel", &fSelection) != B_OK)
		fSelection = 0;

	if (fContainerView == NULL)
		fContainerView = ChildAt(0);

	int32 i = 0;
	BMessage tabMsg;

	while (archive->FindMessage("_l_items", i, &tabMsg) == B_OK)
	{
		BArchivable *archivedTab = instantiate_object(&tabMsg);

		if (archivedTab)
		{
			BTab *tab = dynamic_cast<BTab*>(archivedTab);

			BMessage viewMsg;

			if (archive->FindMessage("_view_list", i, &viewMsg) == B_OK)
			{
				BArchivable *archivedView = instantiate_object(&viewMsg);

				if (archivedView)
				{
					BView *view = dynamic_cast<BView*>(archivedView);

					AddTab(view, tab);
				}
			}
		}

		tabMsg.MakeEmpty();
		i++;
	}
}
//------------------------------------------------------------------------------
BArchivable *BTabView::Instantiate(BMessage *archive)
{
	if ( validate_instantiation(archive, "BTabView"))
		return new BTabView(archive);
	else
		return NULL;
}
//------------------------------------------------------------------------------
status_t BTabView::Archive(BMessage *archive, bool deep) const
{
	if(CountTabs() > 0)
		TabAt(Selection())->View()->RemoveSelf();

	BView::Archive(archive, deep);

	archive->AddInt16("_but_width", fTabWidthSetting);
	archive->AddFloat("_high", fTabHeight);
	archive->AddInt32("_sel", fSelection);
		
	if (deep)
	{
		for (int32 i = 0; i < CountTabs(); i++)
		{
			BMessage tabArchive;
			BTab *tab = TabAt(i);
			
			if (!tab)
				continue;

			if (tab->Archive(&tabArchive, true) == B_OK)
				archive->AddMessage("_l_items", &tabArchive);

			if (!tab->View())
				continue;

			BMessage viewArchive;

			if (tab->View()->Archive(&viewArchive, true) == B_OK)
				archive->AddMessage("_view_list", &viewArchive);
		}
	}

	if(CountTabs() > 0)
	{
		if (TabAt(Selection())->View() && ContainerView())
			TabAt(Selection())->Select(ContainerView());
	}

	return B_OK;
}
//------------------------------------------------------------------------------
status_t BTabView::Perform(perform_code d, void *arg)
{
	return BView::Perform(d, arg);
}
//------------------------------------------------------------------------------
void BTabView::WindowActivated(bool active)
{
	BView::WindowActivated(active);

	DrawTabs();
}
//------------------------------------------------------------------------------
void BTabView::AttachedToWindow()
{
	BView::AttachedToWindow();

	Select(fSelection);
}
//------------------------------------------------------------------------------
void BTabView::AllAttached()
{
	BView::AllAttached();
}
//------------------------------------------------------------------------------
void BTabView::AllDetached()
{
	BView::AllDetached();
}
//------------------------------------------------------------------------------
void BTabView::DetachedFromWindow()
{
	BView::DetachedFromWindow();
}
//------------------------------------------------------------------------------
void BTabView::MessageReceived(BMessage *message)
{
	BView::MessageReceived(message);
}
//------------------------------------------------------------------------------
void BTabView::FrameMoved(BPoint newLocation)
{
	BView::FrameMoved(newLocation);
}
//------------------------------------------------------------------------------
void BTabView::FrameResized(float width,float height)
{
	BView::FrameResized(width, height);
}
//------------------------------------------------------------------------------
void BTabView::KeyDown(const char *bytes, int32 numBytes)
{
	if (IsHidden())
		return;

	switch (bytes[0])
	{
		case B_DOWN_ARROW:
		case B_LEFT_ARROW:
		{
			SetFocusTab((fFocus - 1) % CountTabs(), true);
			break;
		}
		case B_UP_ARROW:
		case B_RIGHT_ARROW:
		{
			SetFocusTab((fFocus + 1) % CountTabs(), true);
			break;
		}
		case B_RETURN:
		case B_SPACE:
		{
			Select(FocusTab());
			break;
		}
		default:
			BView::KeyDown(bytes, numBytes);
	}
}
//------------------------------------------------------------------------------
void BTabView::MouseDown(BPoint point)
{
	if (point.y <= fTabHeight)
	{
		for (int32 i = 0; i < CountTabs(); i++)
		{
			if (TabFrame(i).Contains(point))
			{
				if (i != Selection())
				{
					Select(i);
					return;
				}
			}
		}
	}

	BView::MouseDown(point);
}
//------------------------------------------------------------------------------
void BTabView::MouseUp(BPoint point)
{
	BView::MouseUp(point);
}
//------------------------------------------------------------------------------
void BTabView::MouseMoved(BPoint point, uint32 transit, const BMessage *message)
{
	BView::MouseMoved(point, transit, message);
}
//------------------------------------------------------------------------------
void BTabView::Pulse()
{
	BView::Pulse();
}
//------------------------------------------------------------------------------
void BTabView::Select(int32 index)
{
	if (index < 0 || index >= CountTabs())
		index = Selection();

	BTab *tab = TabAt(Selection());

	if (tab)
		tab->Deselect();

	tab = TabAt(index);

	if (tab && ContainerView())
	{
		tab->Select(ContainerView());
		fSelection = index;
	}

	//Draw(Bounds());
	Invalidate();
}
//------------------------------------------------------------------------------
int32 BTabView::Selection() const
{
	return fSelection;
}
//------------------------------------------------------------------------------
void BTabView::MakeFocus(bool focused)
{
	BView::MakeFocus(focused);

	SetFocusTab(Selection(), focused);
}
//------------------------------------------------------------------------------
void BTabView::SetFocusTab(int32 tab, bool focused)
{
	if (tab >= CountTabs())
		return;

	if (focused)
	{
		if (tab == fFocus)
			return;

		if (fFocus != -1)
			TabAt (fFocus)->MakeFocus(false);

		TabAt(tab)->MakeFocus(true);
		fFocus = tab;
	}
	else if (fFocus != -1)
	{
		TabAt (fFocus)->MakeFocus(false);
		fFocus = -1;
	}

	Invalidate();
}
//------------------------------------------------------------------------------
int32 BTabView::FocusTab() const
{
	return fFocus;
}
//------------------------------------------------------------------------------
void BTabView::Draw(BRect updateRect)
{
	DrawBox(DrawTabs());

	if (IsFocus() && fFocus != -1)
		TabAt(fFocus)->DrawFocusMark(this, TabFrame(fFocus));
}
//------------------------------------------------------------------------------
BRect BTabView::DrawTabs()
{
	for(int32 i = 0; i < CountTabs(); i++)
		TabAt(i)->DrawTab(this, TabFrame(i),
			(i == fSelection) ? B_TAB_FRONT : (i == 0) ? B_TAB_FIRST : B_TAB_ANY,
			(i + 1 != fSelection));

	if (fSelection < CountTabs())
		return TabFrame(fSelection);
	else
		return BRect();
}
//------------------------------------------------------------------------------
void BTabView::DrawBox(BRect selTabRect)
{
	BRect rect = Bounds();

	SetHighColor(tint_color(ui_color(B_PANEL_BACKGROUND_COLOR),
		B_LIGHTEN_MAX_TINT));

	StrokeLine(BPoint(0.0f, rect.bottom), BPoint(0.0f, selTabRect.bottom));
	StrokeLine(BPoint(selTabRect.left - 3.0f, selTabRect.bottom));
	StrokeLine(BPoint(selTabRect.right + 3.0f, selTabRect.bottom),
		BPoint(rect.right - 1.0f, selTabRect.bottom));

	SetHighColor(tint_color(ui_color(B_PANEL_BACKGROUND_COLOR),
		B_DARKEN_4_TINT));

	StrokeLine(BPoint(rect.right, selTabRect.bottom + 1.0f),
		BPoint(rect.right, rect.bottom));
	StrokeLine(BPoint(rect.left + 1.0f, rect.bottom));
}
//------------------------------------------------------------------------------
BRect BTabView::TabFrame(int32 tab_index) const
{
	switch (fTabWidthSetting)
	{
		case B_WIDTH_FROM_LABEL:
		{
			float x = 6.0f;

			for (int32 i = 0; i < tab_index; i++)
				x += StringWidth(TabAt(i)->Label()) + 20.0f;

			return BRect(x, 0.0f,
				x + StringWidth(TabAt(tab_index)->Label()) + 20.0f, fTabHeight);
			break;
		}
		case B_WIDTH_FROM_WIDEST:
		{
			float width = 0.0f;

			for (int32 i = 0; i < CountTabs(); i++)
			{
				float tabWidth = StringWidth(TabAt(i)->Label()) + 20.0f;
				
				if (tabWidth > width)
					width = tabWidth;
			}

			return BRect((6.0f + tab_index * width), 0.0f,
				(6.0f + tab_index * width + width), fTabHeight);
			break;
		}
		case B_WIDTH_AS_USUAL:
		default:
		{
			return BRect((6.0f + tab_index * 100.0f), 0.0f,
				(6.0f + tab_index * 100.0f + 100.0f), fTabHeight);
			break;
		}
	}
}
//------------------------------------------------------------------------------
void BTabView::SetFlags(uint32 flags)
{
	BView::SetFlags(flags);
}
//------------------------------------------------------------------------------
void BTabView::SetResizingMode(uint32 mode)
{
	BView::SetResizingMode(mode);
}
//------------------------------------------------------------------------------
void BTabView::GetPreferredSize(float *width, float *height)
{
	BView::GetPreferredSize(width, height);
}
//------------------------------------------------------------------------------
void BTabView::ResizeToPreferred()
{
	BView::ResizeToPreferred();
}
//------------------------------------------------------------------------------
BHandler *BTabView::ResolveSpecifier(BMessage *message, int32 index,
							BMessage *specifier, int32 what, const char *property)
{
	return BView::ResolveSpecifier(message, index, specifier, what, property);
}
//------------------------------------------------------------------------------
status_t BTabView::GetSupportedSuites(BMessage *message)
{
	return BView::GetSupportedSuites(message);
}
//------------------------------------------------------------------------------
void BTabView::AddTab(BView *target, BTab *tab)
{
	if (tab == NULL)
		tab = new BTab(target);
	else
		tab->SetView(target);

	fTabList->AddItem(tab);
}
//------------------------------------------------------------------------------
BTab *BTabView::RemoveTab(int32 tab_index)
{
	if (tab_index < 0 || tab_index >= CountTabs())
		return NULL;

	BTab *tab = (BTab*)fTabList->RemoveItem(tab_index);

	tab->Deselect();

	if (tab_index <= fSelection && fSelection != 0)
		fSelection--;

	Select(fSelection);
	
	if (fFocus == CountTabs() - 1)
		SetFocusTab(fFocus, false);
	else
		SetFocusTab(fFocus, true);

	return tab;
}
//------------------------------------------------------------------------------
BTab *BTabView::TabAt(int32 tab_index) const
{
	return (BTab*)fTabList->ItemAt(tab_index);
}
//------------------------------------------------------------------------------
void BTabView::SetTabWidth(button_width width)
{
	fTabWidthSetting = width;

	Invalidate();
}
//------------------------------------------------------------------------------
button_width BTabView::TabWidth() const
{
	return fTabWidthSetting;
}
//------------------------------------------------------------------------------
void BTabView::SetTabHeight(float height)
{
	if (fTabHeight == height)
		return;

	fContainerView->MoveBy(0.0f, height - fTabHeight);
	fContainerView->ResizeBy(0.0f, height - fTabHeight);

	fTabHeight = height;

	Invalidate();
}
//------------------------------------------------------------------------------
float BTabView::TabHeight() const
{
	return fTabHeight;
}
//------------------------------------------------------------------------------
BView *BTabView::ContainerView() const
{
	return fContainerView;
}
//------------------------------------------------------------------------------
int32 BTabView::CountTabs() const
{
	return fTabList->CountItems();
}
//------------------------------------------------------------------------------
BView *BTabView::ViewForTab(int32 tabIndex) const
{
	BTab *tab = TabAt(tabIndex);

	if (tab)
		return tab->View();
	else
		return NULL;
}
//------------------------------------------------------------------------------
void BTabView::_InitObject()
{
	fTabList = new BList;

	fTabWidthSetting = B_WIDTH_AS_USUAL;
	fSelection = 0;
	fFocus = -1;

	rgb_color color = ui_color(B_PANEL_BACKGROUND_COLOR);

	SetViewColor(color);
	SetLowColor(color);

	font_height fh;
	GetFontHeight(&fh);
	fTabHeight = fh.ascent + fh.descent + fh.leading + 8.0f;

	BRect bounds = Bounds();

	bounds.top += 1.0f + TabHeight();
	bounds.InsetBy(2.0f, 2.0f);

	fContainerView = new BView(bounds, "view container", B_FOLLOW_ALL,
		B_WILL_DRAW);

	fContainerView->SetViewColor(color);
	fContainerView->SetLowColor(color);

	AddChild(fContainerView);
}
//------------------------------------------------------------------------------
void BTabView::_ReservedTabView1() {}
void BTabView::_ReservedTabView2() {}
void BTabView::_ReservedTabView3() {}
void BTabView::_ReservedTabView4() {}
void BTabView::_ReservedTabView5() {}
void BTabView::_ReservedTabView6() {}
void BTabView::_ReservedTabView7() {}
void BTabView::_ReservedTabView8() {}
void BTabView::_ReservedTabView9() {}
void BTabView::_ReservedTabView10() {}
void BTabView::_ReservedTabView11() {}
void BTabView::_ReservedTabView12() {}
//------------------------------------------------------------------------------
BTabView::BTabView(const BTabView &tabView)
	:	BView(tabView)
{
}
//------------------------------------------------------------------------------
BTabView &BTabView::operator=(const BTabView &)
{
	return *this;
}
//------------------------------------------------------------------------------

/*
 * $Log $
 *
 * $Id  $
 *
 */