haiku.git

/*
 * Copyright 2006, Haiku.
 * Distributed under the terms of the MIT License.
 *
 * Authors:
 *		Stephan Aßmus <superstippi@gmx.de>
 */

/** gui class that loads an image from disk and shows it
    as clickable button */

// TODO: inherit from BControl?

// NOTE: this file is a duplicate of the version in Icon-O-Matic/generic
// it should be placed into a common folder for generic useful stuff

#ifndef ICON_BUTTON_H
#define ICON_BUTTON_H

#include <Invoker.h>
#include <String.h>
#include <View.h>

class BBitmap;
class BMimeType;

class IconButton : public BView, public BInvoker {
public:
								IconButton(const char* name,
										   uint32 id,
										   const char* label = NULL,
										   BMessage* message = NULL,
										   BHandler* target = NULL);
	virtual						~IconButton();

	// BView interface
	virtual	void				MessageReceived(BMessage* message);
	virtual	void				AttachedToWindow();
	virtual	void				Draw(BRect updateRect);
	virtual	void				MouseDown(BPoint where);
	virtual	void				MouseUp(BPoint where);
	virtual	void				MouseMoved(BPoint where, uint32 transit,
										   const BMessage* message);
	virtual	void				GetPreferredSize(float* width,
												 float* height);
	virtual	BSize				MinSize();
	virtual	BSize				MaxSize();


	// BInvoker interface
	virtual	status_t			Invoke(BMessage* message = NULL);

	// IconButton
			bool				IsValid() const;

	virtual	int32				Value() const;
	virtual	void				SetValue(int32 value);

			bool				IsEnabled() const;
			void				SetEnabled(bool enable);

			void				SetPressed(bool pressed);
			bool				IsPressed() const;
			uint32				ID() const
									{ return fID; }

			status_t			SetIcon(const char* pathToBitmap);
			status_t			SetIcon(const BBitmap* bitmap);
			status_t			SetIcon(const BMimeType* fileType,
										bool small = true);
			status_t			SetIcon(const unsigned char* bitsFromQuickRes,
										uint32 width, uint32 height,
										color_space format,
										bool convertToBW = false);
			void				ClearIcon();

			BBitmap*			Bitmap() const;
									// caller has to delete the returned bitmap

	virtual	bool				DrawBorder() const;
	virtual	void				DrawNormalBorder(BRect r,
												 rgb_color background,
												 rgb_color shadow,
												 rgb_color darkShadow,
												 rgb_color lightShadow,
												 rgb_color light);
	virtual	void				DrawPressedBorder(BRect r,
												  rgb_color background,
												  rgb_color shadow,
												  rgb_color darkShadow,
												  rgb_color lightShadow,
												  rgb_color light);

protected:
			enum {
				STATE_NONE			= 0x0000,
				STATE_TRACKING		= 0x0001,
				STATE_PRESSED		= 0x0002,
				STATE_ENABLED		= 0x0004,
				STATE_INSIDE		= 0x0008,
				STATE_FORCE_PRESSED	= 0x0010,
			};

			void				_AddFlags(uint32 flags);
			void				_ClearFlags(uint32 flags);
			bool				_HasFlags(uint32 flags) const;

			void				_DrawFrame(BRect frame,
										   rgb_color col1,
										   rgb_color col2,
										   rgb_color col3,
										   rgb_color col4);

// private:
			BBitmap*			_ConvertToRGB32(const BBitmap* bitmap) const;
			status_t			_MakeBitmaps(const BBitmap* bitmap);
			void				_DeleteBitmaps();
			void				_SendMessage() const;
			void				_Update();

			uint32				fButtonState;
			int32				fID;
			BBitmap*			fNormalBitmap;
			BBitmap*			fDisabledBitmap;
			BBitmap*			fClickedBitmap;
			BBitmap*			fDisabledClickedBitmap;
			BString				fLabel;

			BHandler*			fTargetCache;
};

#endif // ICON_BUTTON_H