/**********************************************************************

 *<

	FILE: custcont.h



	DESCRIPTION: Custom Controls for Jaguar



	CREATED BY: Rolf Berteig



	HISTORY: created 17 November, 1994



 *>	Copyright (c) 1994, All Rights Reserved.

 **********************************************************************/



#ifndef __CUSTCONT__

#define __CUSTCONT__



#include "winutil.h"



void CoreExport InitCustomControls( HINSTANCE hInst );







class ICustomControl {

	public:

		virtual HWND GetHwnd()=0;

		virtual void Enable()=0;

		virtual void Disable()=0;

		virtual BOOL IsEnabled()=0;

	};



// This is a bitmap brush where the bitmap is a gray and white checker board.

HBRUSH CoreExport GetLTGrayBrush();

HBRUSH CoreExport GetDKGrayBrush();



// The standard font...

HFONT CoreExport GetFixedFont();



// The hand cursor used for panning.

HCURSOR CoreExport GetPanCursor();



//---------------------------------------------------------------------------//

// Spinner control





#define SPINNERWINDOWCLASS	_T("SpinnerControl")





// LOWORD(wParam) = ctrlID, 

// HIWORD(wParam) = TRUE if user is dragging the spinner interactively.

// lParam = pointer to ISpinnerControl

#define CC_SPINNER_CHANGE  		WM_USER + 600	



// LOWORD(wParam) = ctrlID, 

// lParam = pointer to ISpinnerControl

#define CC_SPINNER_BUTTONDOWN	WM_USER + 601



// LOWORD(wParam) = ctrlID, 

// HIWORD(wParam) = FALSE if user cancelled - TRUE otherwise

// lParam = pointer to ISpinnerControl

#define CC_SPINNER_BUTTONUP		WM_USER + 602





enum EditSpinnerType {

	EDITTYPE_INT, 

	EDITTYPE_FLOAT, 

	EDITTYPE_UNIVERSE, 

	EDITTYPE_POS_INT, 

	EDITTYPE_POS_FLOAT, 

	EDITTYPE_POS_UNIVERSE,

	EDITTYPE_TIME

	};



class ISpinnerControl : public ICustomControl {

	public:

		virtual float GetFVal()=0;

		virtual int GetIVal()=0;

		virtual void SetAutoScale(BOOL on=TRUE)=0;

		virtual void SetScale( float s )=0;

		virtual void SetValue( float v, int notify )=0;

		virtual void SetValue( int v, int notify )=0;

		virtual void SetLimits( int min, int max, int limitCurValue = TRUE )=0;

		virtual void SetLimits( float min, float max, int limitCurValue = TRUE )=0;

		virtual void LinkToEdit( HWND hEdit, EditSpinnerType type )=0;

		virtual void SetIndeterminate(BOOL i=TRUE)=0;

		virtual BOOL IsIndeterminate()=0;

		virtual void SetResetValue(float v)=0;

		virtual void SetResetValue(int v)=0;

	};



ISpinnerControl CoreExport *GetISpinner( HWND hCtrl );

void CoreExport ReleaseISpinner( ISpinnerControl *isc );



CoreExport void SetSnapSpinner(BOOL b);

CoreExport BOOL GetSnapSpinner();

CoreExport void SetSnapSpinValue(float f);

CoreExport float GetSnapSpinValue();



CoreExport void SetSpinnerPrecision(int p);

CoreExport int GetSpinnerPrecision();





//---------------------------------------------------------------------------//

// Rollup window control



#define ROLLUPWINDOWCLASS _T("RollupWindow")



typedef void *RollupState;



// Flags passed to AppendRollup

#define APPENDROLL_CLOSED	(1<<0)	// Starts the page out rolled up.



class IRollupWindow : public ICustomControl {

	public:

		// Shows or hides all

		virtual void Show()=0;

		virtual void Hide()=0;



		// Shows or hides by index

		virtual void Show(int index)=0;

		virtual void Hide(int index)=0;



		virtual HWND GetPanelDlg(int index)=0;

		virtual int GetPanelIndex(HWND hWnd)=0;

		virtual void SetPanelTitle(int index,TCHAR *title)=0;



		// returns index of new panel

		virtual int AppendRollup( HINSTANCE hInst, TCHAR *dlgTemplate, 

				DLGPROC dlgProc, TCHAR *title, LPARAM param=0,DWORD flags=0 )=0;

		virtual int ReplaceRollup( int index, HINSTANCE hInst, TCHAR *dlgTemplate, 

				DLGPROC dlgProc, TCHAR *title, LPARAM param=0,DWORD flags=0 )=0;

		virtual void DeleteRollup( int index, int count )=0;

		virtual void SetPageDlgHeight(int index,int height)=0;



		virtual void SaveState( RollupState *hState )=0;

		virtual void RestoreState( RollupState *hState )=0;



		// Passing WM_LBUTTONDOWN, WM_MOUSEMOVE, and WM_LBUTTONUP to

		// this function allows scrolling with unused areas in the dialog.

		virtual void DlgMouseMessage( HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam )=0;



		virtual int GetNumPanels()=0;

		virtual BOOL IsPanelOpen(int index) = 0;

		virtual void SetPanelOpen(int index, BOOL isOpen) =0;

		virtual int GetScrollPos()=0;

		virtual void SetScrollPos(int spos)=0;

	};



// This function returns TRUE if a particular rollup panel is open given

// a handle to the dialog window in the panel.

CoreExport BOOL IsRollupPanelOpen(HWND hDlg);



IRollupWindow CoreExport *GetIRollup( HWND hCtrl );

void CoreExport ReleaseIRollup( IRollupWindow *irw );



//----------------------------------------------------------------------------//

// CustEdit control



#define CUSTEDITWINDOWCLASS _T("CustEdit")



// Sent when the user hits the enter key in an edit control.

// wParam = cust edit ID

// lParam = HWND of cust edit control.

#define WM_CUSTEDIT_ENTER	(WM_USER+685)



class ICustEdit : public ICustomControl {

	public:

		virtual void GetText( TCHAR *text, int ct )=0;

		virtual void SetText( TCHAR *text )=0;	

		virtual void SetText( int i )=0;

		virtual void SetText( float f, int precision=3 )=0;

		virtual int GetInt(BOOL *valid=NULL)=0;

		virtual float GetFloat(BOOL *valid=NULL)=0;

		virtual void SetLeading(int lead)=0;

	};



ICustEdit CoreExport *GetICustEdit( HWND hCtrl );

void CoreExport ReleaseICustEdit( ICustEdit *ice );





//----------------------------------------------------------------------------//

// CustButton control



#define CUSTBUTTONWINDOWCLASS _T("CustButton")



#define CC_COMMAND  		WM_USER + 700

// send these with CC_COMMAND: wParam = CC_???

#define CC_CMD_SET_TYPE  		23		// lParam = CBT_PUSH, CBT_CHECK

#define CC_CMD_SET_STATE		24		// lParam = 0/1 for popped/pushed

#define CC_CMD_HILITE_COLOR		25		// lParam = RGB packed int



#define RED_WASH	RGB(255,192,192)

#define GREEN_WASH	RGB(192,255,192)

#define BLUE_WASH	RGB(192,192,255)



enum CustButType { CBT_PUSH, CBT_CHECK };



// If the button is set to notify on button down, it will send a WM_COMMAND

// with this notify code when the user touches the button.

#define BN_BUTTONDOWN 	8173

// It will also send this message when the mouse is released regardless

// if the mouse is released inside the toolbutton rectangle

#define BN_BUTTONUP		8174



// If a button is set to notify on right clicks,  it will send a WM_COMMAND

// with this notify code when the user right clicks on the button.

#define BN_RIGHTCLICK 	8183



// When the user chooses a new fly-off item, this notify code will be sent.

#define BN_FLYOFF		8187



// When the user presses a button a WM_MENUSELECT message is sent so that

// the client can display a status prompt describing the function of

// the tool. The fuFlags parameter is set to this value:

#define CMF_TOOLBUTTON	9274



class FlyOffData {

	public:

		int iOutEn;

		int iInEn;

		int iOutDis;

		int iInDis;		

	};



// Directions the fly off will go.

#define FLY_VARIABLE	1

#define FLY_UP			2

#define FLY_DOWN		3

#define FLY_HVARIABLE	4 // horizontal variable

#define FLY_LEFT		5

#define FLY_RIGHT		6



class ICustButton : public ICustomControl {

	public:

		virtual void GetText( TCHAR *text, int ct )=0;

		virtual void SetText( TCHAR *text )=0;			

		virtual void SetImage( HIMAGELIST hImage, 

			int iOutEn, int iInEn, int iOutDis, int iInDis, int w, int h )=0;

		virtual void SetType( CustButType type )=0;

		virtual void SetFlyOff(int count,FlyOffData *data,int timeOut,int init,int dir=FLY_VARIABLE)=0;

		virtual void SetCurFlyOff(int f,BOOL notify=FALSE)=0;

		virtual int GetCurFlyOff()=0;

		virtual BOOL IsChecked()=0;

		virtual void SetCheck( BOOL checked )=0;

		virtual void SetCheckHighlight( BOOL highlight )=0;

		virtual void SetButtonDownNotify(BOOL notify)=0;

		virtual void SetRightClickNotify(BOOL notify)=0;

		virtual void SetHighlightColor(COLORREF clr)=0;

		virtual void SetTooltip(BOOL onOff, LPSTR text)=0;

	};



ICustButton CoreExport *GetICustButton( HWND hCtrl );

void CoreExport ReleaseICustButton( ICustButton *icb );





//---------------------------------------------------------------------------//

// CustStatus



#define CUSTSTATUSWINDOWCLASS _T("CustStatus")



enum StatusTextFormat {

	STATUSTEXT_LEFT,

	STATUSTEXT_CENTERED,

	STATUSTEXT_RIGHT };





class ICustStatus : public ICustomControl {

	public:

		virtual void SetText(TCHAR *text)=0;

		virtual void SetTextFormat(StatusTextFormat f)=0;

	};



ICustStatus CoreExport *GetICustStatus( HWND hCtrl );

void CoreExport ReleaseICustStatus( ICustStatus *ics );





//----------------------------------------------------------------------------//

// CustToolbar control



#define CUSTTOOLBARWINDOWCLASS _T("CustToolbar")



// Sent in a WM_COMMAND when the user right clicks in open space

// on a toolbar.

#define TB_RIGHTCLICK 	0x2861



enum ToolItemType { 

	CTB_PUSHBUTTON, 

	CTB_CHECKBUTTON, 

	CTB_SEPARATOR,

	CTB_STATUS,

	CTB_OTHER

	 };





class ToolItem {

	public: 

		ToolItemType type;

		int id;

		DWORD helpID;

		int w, h;

		virtual ~ToolItem() {}

	};



class ToolButtonItem : public ToolItem {

	public:		

		int iOutEn, iInEn;

		int iOutDis, iInDis;

		int iw;

		int ih;		

		ToolButtonItem(ToolItemType t,

			int iOE, int iIE, int iOD, int iID,

			int iW, int iH, int wd,int ht, int ID, DWORD hID=0)

			{ 

			type = t; 

			iOutEn = iOE; iInEn = iIE; iOutDis = iOD; iInDis = iID;

			iw = iW; ih = iH; w = wd; h = ht; id = ID; helpID = hID;

			}		

	};



class ToolSeparatorItem : public ToolItem {

	public:

		ToolSeparatorItem(int w) {

			type = CTB_SEPARATOR;

			id = 0;

			helpID = 0;

			this->w = w;

			h = 0;

			} 

	};



class ToolStatusItem : public ToolItem {

	public:

		BOOL fixed;

		ToolStatusItem(int w, int h,BOOL f,int id, DWORD hID=0) {

			type = CTB_STATUS;

			this->w = w;

			this->h = h;

			this->id = id;

			this->helpID = hID;

			fixed = f;

			}

	};



#define CENTER_TOOL_VERTICALLY	0xffffffff



class ToolOtherItem : public ToolItem {

	public:

		int	  y;

		DWORD style;

		TCHAR *className;

		TCHAR *windowText;

		ToolOtherItem(TCHAR *cls,int w,int h,int id,DWORD style=WS_CHILD|WS_VISIBLE,

					int y=CENTER_TOOL_VERTICALLY,TCHAR *wt=NULL,DWORD hID=0) {

			type = CTB_OTHER;

			this->y = y;

			this->w = w;

			this->h = h;

			this->id = id;

			this->helpID = hID;

			this->style = style;

			className = cls;

			windowText = wt;

			}		

	};





class ICustToolbar : public ICustomControl {

	public:

		virtual void SetImage( HIMAGELIST hImage )=0;

		virtual void AddTool( const ToolItem& entry, int pos=-1 )=0;

		virtual void DeleteTools( int start, int num=-1 )=0;  // num = -1 deletes 'start' through count-1 tools

		virtual void SetBottomBorder(BOOL on)=0;

		virtual void SetTopBorder(BOOL on)=0;

		virtual ICustButton *GetICustButton( int id )=0;

		virtual ICustStatus *GetICustStatus( int id )=0;		

		virtual HWND GetItemHwnd(int id)=0;

	};



ICustToolbar CoreExport *GetICustToolbar( HWND hCtrl );

void CoreExport ReleaseICustToolbar( ICustToolbar *ict );





//---------------------------------------------------------------------------//

// CustImage





#define CUSTIMAGEWINDOWCLASS _T("CustImage")



class ICustImage : public ICustomControl {

	public:

		virtual void SetImage( HIMAGELIST hImage,int index, int w, int h )=0;		

	};



ICustImage CoreExport *GetICustImage( HWND hCtrl );

void CoreExport ReleaseICustImage( ICustImage *ici );





//------------------------------------------------------------------------

// Off Screen Buffer



class IOffScreenBuf {

	public:

		virtual HDC GetDC()=0;

		virtual void Erase(Rect *rct=NULL)=0;

		virtual void Blit(Rect *rct=NULL)=0;

		virtual void Resize()=0;

		virtual void SetBkColor(COLORREF color)=0;

		virtual COLORREF GetBkColor()=0;

	};



CoreExport IOffScreenBuf *CreateIOffScreenBuf(HWND hWnd);

CoreExport void DestroyIOffScreenBuf(IOffScreenBuf *iBuf);





//------------------------------------------------------------------------

// Color swatch control

// Puts up the ColorPicker when user right clicks on it.

//



// This message is sent as the color is being adjusted in the 

// ColorPicker.

// LOWORD(wParam) = ctrlID, 

// HIWORD(wParam) = 1 if button UP 

//                = 0 if mouse drag.

// lParam = pointer to ColorSwatchControl

#define CC_COLOR_CHANGE			WM_USER + 603



// LOWORD(wParam) = ctrlID, 

// lParam = pointer to ColorSwatchControl

#define CC_COLOR_BUTTONDOWN		WM_USER + 606



// LOWORD(wParam) = ctrlID, 

// HIWORD(wParam) = FALSE if user cancelled - TRUE otherwise

// lParam = pointer to ColorSwatchControl

#define CC_COLOR_BUTTONUP		WM_USER + 607



// This message is sent if the color has been clicked on, before 

// bringing up the color picker.

// LOWORD(wParam) = ctrlID, 

// HIWORD(wParam) = 0 

// lParam = pointer to ColorSwatchControl

#define CC_COLOR_SEL			WM_USER + 604





// This message is sent if another color swatch has been dragged and dropped

// on this swatch. 

// LOWORD(wParam) = toCtrlID, 

// HIWORD(wParam) = 0

// lParam = pointer to ColorSwatchControl

#define CC_COLOR_DROP			WM_USER + 605







#define COLORSWATCHWINDOWCLASS _T("ColorSwatch")



class IColorSwatch: public ICustomControl {

	public:

		// sets only the varying color of the color picker if showing

		virtual COLORREF SetColor(COLORREF c, int notify=FALSE)=0;  // returns old color



		// sets both the varying color and the "reset"color of the color picker

		virtual COLORREF InitColor(COLORREF c, int notify=FALSE)=0;  // returns old color



		virtual COLORREF GetColor()=0;

		virtual void ForceDitherMode(BOOL onOff)=0;

		virtual void SetModal()=0;

		virtual void Activate(int onOff)=0;

		virtual void EditThis(BOOL startNew=TRUE)=0;

	};



IColorSwatch CoreExport *GetIColorSwatch( HWND hCtrl, COLORREF col, TCHAR *name);

void CoreExport ReleaseIColorSwatch( IColorSwatch *ics );



//------------------------------------------------------------------------

// Window thumb tack



// This function installs a thumb tack in the title bar of a window

// which allows the user to make it an always on top window.

// NOTE: The window class for the window should have 4 extra bytes in 

// the window structure for SetWindowLong().

CoreExport void InstallThumbTack(HWND hwnd);

CoreExport void RemoveThumbTack(HWND hwnd);



// Handy routines for setting up Spinners.

CoreExport ISpinnerControl *SetupIntSpinner(HWND hwnd, int idSpin, int idEdit,  int min, int max, int val);

CoreExport ISpinnerControl *SetupFloatSpinner(HWND hwnd, int idSpin, int idEdit,  float min, float max, float val, float scale = 0.1f);



//---------------------------------------------------------------------------

//



CoreExport void DisableAccelerators();

CoreExport void EnableAccelerators();

CoreExport BOOL AcceleratorsEnabled();



CoreExport void SetSaveRequired(int b=TRUE);

CoreExport BOOL GetSaveRequired();





#endif // __CUSTCONT__