haiku-beta6/src/kits/interface/Button.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:		Button.cpp
//	Author:			Marc Flerackers ([email protected])
//	Description:	BButton displays and controls a button in a window.
//------------------------------------------------------------------------------

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

// System Includes -------------------------------------------------------------
#include <Button.h>
#include <Font.h>
#include <String.h>
#include <Window.h>

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

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

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

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

//------------------------------------------------------------------------------
BButton::BButton(BRect frame, const char *name, const char *label, BMessage *message,
				  uint32 resizingMode, uint32 flags)
	:	BControl(frame, name, label, message, resizingMode, flags |= B_WILL_DRAW),
		fDrawAsDefault(false)
{
	// Resize to minimum height if needed
	font_height fh;
	GetFontHeight(&fh);
	float minHeight = 12.0f + (float)ceil(fh.ascent + fh.descent);
	if (Bounds().Height() < minHeight)
		ResizeTo(Bounds().Width(), minHeight);
}
//------------------------------------------------------------------------------
BButton::~BButton()
{
}
//------------------------------------------------------------------------------
BButton::BButton(BMessage *archive)
	:	BControl (archive)
{
	if (archive->FindBool("_default", &fDrawAsDefault) != B_OK)
		fDrawAsDefault = false;
}
//------------------------------------------------------------------------------
BArchivable *BButton::Instantiate(BMessage *archive)
{
	if (validate_instantiation(archive, "BButton"))
		return new BButton(archive);
	else
		return NULL;
}
//------------------------------------------------------------------------------
status_t BButton::Archive(BMessage* archive, bool deep) const
{
	status_t err = BControl::Archive(archive, deep);

	if (err != B_OK)
		return err;
	
	if (IsDefault())
		err = archive->AddBool("_default", true);

	return err;
}
//------------------------------------------------------------------------------
void BButton::Draw(BRect updateRect)
{
	font_height fh;
	GetFontHeight(&fh);
	
	const BRect bounds = Bounds();
	BRect rect = bounds;
	
	const bool enabled = IsEnabled();
	const bool pushed = Value() == B_CONTROL_ON;

	// Default indicator
	if (IsDefault())
		rect = DrawDefault(rect,enabled);
	else 
		rect.InsetBy(1.0f,1.0f);

	BRect fillArea = rect;
	fillArea.InsetBy(3.0f,3.0f);

	BString text = Label();
	
#if 1
	// Label truncation	
	BFont font;
	GetFont(&font);
	font.TruncateString(&text, B_TRUNCATE_END, fillArea.Width());
#endif

	// Label position
	const float stringWidth = StringWidth(text.String()); 	
	const float x = (bounds.right - stringWidth) / 2.0f;
	const float labelY = bounds.top  
		+ ((bounds.Height() - fh.ascent - fh.descent) / 2.0f) 
		+ fh.ascent +  1.0f;	
	const float focusLineY = labelY + fh.descent;

	/* speed trick:
	   if the focus changes but the button is not pressed then we can
	   redraw only the focus line, 
	   if the focus changes and the button is pressed invert the internal rect	
	   this block takes care of all the focus changes 	
	*/
	if (IsFocusChanging()) {	
		if (pushed) {
			rect.InsetBy(2.0,2.0);
			InvertRect(rect);
		} else 
			DrawFocusLine(x, focusLineY, stringWidth, IsFocus() && Window()->IsActive());
		
		return;
	}

	// Colors	
	const rgb_color panelBgColor = ui_color(B_PANEL_BACKGROUND_COLOR);
	const rgb_color buttonBgColor=tint_color(panelBgColor, B_LIGHTEN_1_TINT);	
	const rgb_color maxLightColor=tint_color(panelBgColor, B_LIGHTEN_MAX_TINT);	
	const rgb_color maxShadowColor=tint_color(panelBgColor, B_DARKEN_MAX_TINT);	
	const rgb_color darkBorderColor = tint_color(panelBgColor, 
		enabled ? B_DARKEN_4_TINT : B_DARKEN_2_TINT);
	const rgb_color firstBevelColor = enabled ? tint_color(panelBgColor, B_DARKEN_2_TINT) 
		: panelBgColor;
	const rgb_color cornerColor = IsDefault() ? firstBevelColor : panelBgColor;
	
	// Fill the button area
	SetHighColor(buttonBgColor);
	FillRect(fillArea);

	// external border
	SetHighColor(darkBorderColor);
	StrokeRect(rect);
		
	BeginLineArray(14);

	// Corners
	AddLine(rect.LeftTop(), rect.LeftTop(), cornerColor);
	AddLine(rect.LeftBottom(), rect.LeftBottom(), cornerColor);
	AddLine(rect.RightTop(), rect.RightTop(), cornerColor);
	AddLine(rect.RightBottom(), rect.RightBottom(), cornerColor);

	rect.InsetBy(1.0f,1.0f);
	
	// Shadow
	AddLine(rect.LeftBottom(), rect.RightBottom(), firstBevelColor);
	AddLine(rect.RightBottom(), rect.RightTop(), firstBevelColor);
	// Light
	AddLine(rect.LeftTop(), rect.LeftBottom(),buttonBgColor);
	AddLine(rect.LeftTop(), rect.RightTop(), buttonBgColor);	
	
	rect.InsetBy(1.0f, 1.0f);
	
	// Shadow
	AddLine(rect.LeftBottom(), rect.RightBottom(), panelBgColor);
	AddLine(rect.RightBottom(), rect.RightTop(), panelBgColor);
	// Light
	AddLine(rect.LeftTop(), rect.LeftBottom(),maxLightColor);
	AddLine(rect.LeftTop(), rect.RightTop(), maxLightColor);	
	
	rect.InsetBy(1.0f,1.0f);
	
	// Light
	AddLine(rect.LeftTop(), rect.LeftBottom(),maxLightColor);
	AddLine(rect.LeftTop(), rect.RightTop(), maxLightColor);	
		
	EndLineArray();	

	// Invert if clicked
	if (enabled && pushed) {
		rect.InsetBy(-2.0f,-2.0f);
		InvertRect(rect);
	}

	// Label color
	if (enabled) {
		if (pushed) {
			SetHighColor(maxLightColor);
			SetLowColor(maxShadowColor);
		} else {
			SetHighColor(maxShadowColor);	
			SetLowColor(tint_color(panelBgColor, B_LIGHTEN_2_TINT));
		}
	} else {
		SetHighColor(tint_color(panelBgColor, B_DISABLED_LABEL_TINT));
		SetLowColor(tint_color(panelBgColor, B_LIGHTEN_2_TINT));	
	}

	// Draw the label
	DrawString(text.String(), BPoint(x, labelY));

	// Focus line
	if (enabled && IsFocus() && Window()->IsActive() && !pushed)
		DrawFocusLine(x,focusLineY,stringWidth,true);
	
}

//------------------------------------------------------------------------------
void BButton::MouseDown(BPoint point)
{
	if (!IsEnabled())
		return;

	SetValue(B_CONTROL_ON);

	if (Window()->Flags() & B_ASYNCHRONOUS_CONTROLS)
	{
 		SetTracking(true);
 		SetMouseEventMask(B_POINTER_EVENTS, B_LOCK_WINDOW_FOCUS);
 	}
 	else
 	{
		BRect bounds = Bounds();
		uint32 buttons;

		do
		{
			Window()->UpdateIfNeeded();
			
			snooze(40000);

			GetMouse(&point, &buttons, true);

 			bool inside = bounds.Contains(point);

			if ((Value() == B_CONTROL_ON) != inside)
				SetValue(inside ? B_CONTROL_ON : B_CONTROL_OFF);
		} while (buttons != 0);

		if (Value() == B_CONTROL_ON)
			Invoke();
	}
}
//------------------------------------------------------------------------------
void BButton::AttachedToWindow()
{
	BControl::AttachedToWindow();

	if (IsDefault())
		Window()->SetDefaultButton(this);
}
//------------------------------------------------------------------------------
void BButton::KeyDown(const char *bytes, int32 numBytes)
{
	if (*bytes == B_ENTER || *bytes == B_SPACE)
	{
		if (!IsEnabled())
			return;

		SetValue(B_CONTROL_ON);
		Invoke();
	}
	else
		BControl::KeyDown(bytes, numBytes);
}
//------------------------------------------------------------------------------
void BButton::MakeDefault(bool flag)
{
	BButton *oldDefault = NULL;
	BWindow *window = Window();
	
	if (window)
		oldDefault = window->DefaultButton();

	if (flag)
	{
		if (fDrawAsDefault && oldDefault == this)
			return;

		fDrawAsDefault = true;

		ResizeBy(6.0f, 6.0f);
		MoveBy(-3.0f, -3.0f);

		if (window && oldDefault != this)
			window->SetDefaultButton(this);
	}
	else
	{
		if (!fDrawAsDefault)
			return;

		fDrawAsDefault = false;

		ResizeBy(-6.0f, -6.0f);
		MoveBy(3.0f, 3.0f);

		if (window && oldDefault == this)
			window->SetDefaultButton(NULL);
	}
}
//------------------------------------------------------------------------------
void BButton::SetLabel(const char *string)
{
	BControl::SetLabel(string);
}
//------------------------------------------------------------------------------
bool BButton::IsDefault() const
{
	return fDrawAsDefault;
}
//------------------------------------------------------------------------------
void BButton::MessageReceived(BMessage *message)
{
	BControl::MessageReceived(message);
}
//------------------------------------------------------------------------------
void BButton::WindowActivated(bool active)
{
	BControl::WindowActivated(active);
}
//------------------------------------------------------------------------------
void BButton::MouseMoved(BPoint point, uint32 transit, const BMessage *message)
{
	if (!IsTracking())
		return;

	bool inside = Bounds().Contains(point);

	if ((Value() == B_CONTROL_ON) != inside)
		SetValue(inside ? B_CONTROL_ON : B_CONTROL_OFF);
}
//------------------------------------------------------------------------------
void BButton::MouseUp(BPoint point)
{
	if (!IsTracking())
		return;

	if (Bounds().Contains(point))
		Invoke();
	
	SetTracking(false);
}
//------------------------------------------------------------------------------
void BButton::DetachedFromWindow()
{
	BControl::DetachedFromWindow();
}
//------------------------------------------------------------------------------
void BButton::SetValue(int32 value)
{
	if (value != Value()) {
		BControl::SetValue(value);
		Invalidate();
	}
}
//------------------------------------------------------------------------------
void BButton::GetPreferredSize(float *width, float *height)
{
	font_height fh;
	GetFontHeight(&fh);

	*height = 12.0f + (float)ceil(fh.ascent + fh.descent);
	*width = 20.0f + (float)ceil(StringWidth(Label()));
	
	if (*width < 75.0f)
		*width = 75.0f;

	if (fDrawAsDefault)
	{
		*width += 6.0f;
		*height += 6.0f;
	}
}
//------------------------------------------------------------------------------
void BButton::ResizeToPreferred()
{
	 BControl::ResizeToPreferred();
}
//------------------------------------------------------------------------------
status_t BButton::Invoke(BMessage *message)
{
	Sync();
	snooze(50000);
	
	status_t err = BControl::Invoke(message);

	SetValue(B_CONTROL_OFF);

	return err;
}
//------------------------------------------------------------------------------
void BButton::FrameMoved(BPoint newLocation)
{
	BControl::FrameMoved(newLocation);
}
//------------------------------------------------------------------------------
void BButton::FrameResized(float width, float height)
{
	BControl::FrameResized(width, height);
}
//------------------------------------------------------------------------------
void BButton::MakeFocus(bool focused)
{
	BControl::MakeFocus(focused);
}
//------------------------------------------------------------------------------
void BButton::AllAttached()
{
	BControl::AllAttached();
}
//------------------------------------------------------------------------------
void BButton::AllDetached()
{
	BControl::AllDetached();
}
//------------------------------------------------------------------------------
BHandler *BButton::ResolveSpecifier(BMessage *message, int32 index,
									BMessage *specifier, int32 what,
									const char *property)
{
	return BControl::ResolveSpecifier(message, index, specifier, what, property);
}
//------------------------------------------------------------------------------
status_t BButton::GetSupportedSuites(BMessage *message)
{
	return BControl::GetSupportedSuites(message);
}
//------------------------------------------------------------------------------
status_t BButton::Perform(perform_code d, void *arg)
{
	return BControl::Perform(d, arg);
}
//------------------------------------------------------------------------------
void BButton::_ReservedButton1() {}
void BButton::_ReservedButton2() {}
void BButton::_ReservedButton3() {}
//------------------------------------------------------------------------------
BButton &BButton::operator=(const BButton &)
{
	return *this;
}
//------------------------------------------------------------------------------
BRect BButton::DrawDefault(BRect bounds, bool enabled)
{
	rgb_color no_tint = ui_color(B_PANEL_BACKGROUND_COLOR),
	lighten1 = tint_color(no_tint, B_LIGHTEN_1_TINT),
	darken1 = tint_color(no_tint, B_DARKEN_1_TINT);
	
	rgb_color borderColor;
	if (enabled)
		borderColor = tint_color(no_tint, B_DARKEN_4_TINT);
	else
		borderColor = darken1;

	// Dark border
	BeginLineArray(4);
	AddLine(BPoint(bounds.left, bounds.bottom - 1.0f),
		BPoint(bounds.left, bounds.top + 1.0f), borderColor);
	AddLine(BPoint(bounds.left + 1.0f, bounds.top),
		BPoint(bounds.right - 1.0f, bounds.top), borderColor);
	AddLine(BPoint(bounds.right, bounds.top + 1.0f),
		BPoint(bounds.right, bounds.bottom - 1.0f), borderColor);
	AddLine(BPoint(bounds.left + 1.0f, bounds.bottom),
		BPoint(bounds.right - 1.0f, bounds.bottom), borderColor);
	EndLineArray();

	if (enabled)
	{
		// Bevel
		bounds.InsetBy(1.0f, 1.0f);
		SetHighColor(darken1);
		StrokeRect(bounds);
	}

	bounds.InsetBy(1.0f, 1.0f);

	// Filling
	float inset = enabled? 2.0f : 3.0f;
	SetHighColor(lighten1);

	FillRect(BRect(bounds.left, bounds.top, 
		bounds.right, bounds.top+inset-1.0f));
	FillRect(BRect(bounds.left, bounds.bottom-inset+1.0f, 
		bounds.right, bounds.bottom));
	FillRect(BRect(bounds.left, bounds.top+inset-1.0f,
		bounds.left+inset-1.0f, bounds.bottom-inset+1.0f));
	FillRect(BRect(bounds.right-inset+1.0f, bounds.top+inset-1.0f,
		bounds.right, bounds.bottom-inset+1.0f));

	bounds.InsetBy(inset,inset);

	return bounds;
}
//------------------------------------------------------------------------------
status_t BButton::Execute()
{
	if (!IsEnabled())
		return B_ERROR;

	SetValue(B_CONTROL_ON);
	return Invoke();
}
//------------------------------------------------------------------------------
void BButton::DrawFocusLine(float x, float y, float width, bool visible)
{
	if (visible)
		SetHighColor(ui_color(B_KEYBOARD_NAVIGATION_COLOR));
	else
		SetHighColor(tint_color(ui_color(B_PANEL_BACKGROUND_COLOR),
			B_LIGHTEN_1_TINT));
	// Blue Line
	StrokeLine(BPoint(x, y), BPoint(x + width, y));

	if (visible)		
		SetHighColor(255, 255, 255);
	// White Line
	StrokeLine(BPoint(x, y + 1.0f), BPoint(x + width, y + 1.0f));
}
//------------------------------------------------------------------------------
/*
 * $Log $
 *
 * $Id  $
 *
 */