xref: /aoo41x/main/vcl/inc/vcl/floatwin.hxx (revision e1beba7d)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef _SV_FLOATWIN_HXX
#define _SV_FLOATWIN_HXX

#include <vcl/sv.h>
#include <vcl/dllapi.h>
#include <vcl/syswin.hxx>

class ToolBox;
class PopupModeEvent;

// ------------------------
// - FloatingWindow-Types -
// ------------------------

#define FLOATWIN_POPUPMODE_ALLOWTEAROFF 		((sal_uLong)0x00000001)
#define FLOATWIN_POPUPMODE_ANIMATIONSLIDE		((sal_uLong)0x00000002)
#define FLOATWIN_POPUPMODE_NOAUTOARRANGE		((sal_uLong)0x00000004)
#define FLOATWIN_POPUPMODE_NOANIMATION			((sal_uLong)0x00000008)
#define FLOATWIN_POPUPMODE_DOWN 				((sal_uLong)0x00000010)
#define FLOATWIN_POPUPMODE_UP					((sal_uLong)0x00000020)
#define FLOATWIN_POPUPMODE_LEFT 				((sal_uLong)0x00000040)
#define FLOATWIN_POPUPMODE_RIGHT				((sal_uLong)0x00000080)
#define FLOATWIN_POPUPMODE_NOFOCUSCLOSE 		((sal_uLong)0x00000100)
#define FLOATWIN_POPUPMODE_NOKEYCLOSE			((sal_uLong)0x00000200)
#define FLOATWIN_POPUPMODE_NOMOUSECLOSE 		((sal_uLong)0x00000400)
#define FLOATWIN_POPUPMODE_NOMOUSERECTCLOSE 	((sal_uLong)0x00000800)
#define FLOATWIN_POPUPMODE_ALLMOUSEBUTTONCLOSE	((sal_uLong)0x00001000)
#define FLOATWIN_POPUPMODE_NOAPPFOCUSCLOSE		((sal_uLong)0x00002000)
#define FLOATWIN_POPUPMODE_PATHMOUSECANCELCLICK ((sal_uLong)0x00004000)
#define FLOATWIN_POPUPMODE_NEWLEVEL 			((sal_uLong)0x00008000)
#define FLOATWIN_POPUPMODE_NOMOUSEUPCLOSE		((sal_uLong)0x00010000)
#define FLOATWIN_POPUPMODE_GRABFOCUS        	((sal_uLong)0x00020000)

#define FLOATWIN_POPUPMODEEND_CANCEL			((sal_uInt16)0x0001)
#define FLOATWIN_POPUPMODEEND_TEAROFF			((sal_uInt16)0x0002)
#define FLOATWIN_POPUPMODEEND_DONTCALLHDL		((sal_uInt16)0x0004)
#define FLOATWIN_POPUPMODEEND_CLOSEALL			((sal_uInt16)0x0008)

#define FLOATWIN_TITLE_NORMAL					((sal_uInt16)0x0001)
#define FLOATWIN_TITLE_TEAROFF					((sal_uInt16)0x0002)
#define FLOATWIN_TITLE_NONE 					((sal_uInt16)0x0004)

// ------------------
// - FloatingWindow -
// ------------------

class VCL_DLLPUBLIC FloatingWindow : public SystemWindow
{
    class   ImplData;
private:
	FloatingWindow* mpNextFloat;
	Window* 		mpFirstPopupModeWin;
    ImplData*       mpImplData;
	Rectangle		maFloatRect;
	sal_uLong			mnPostId;
	sal_uLong			mnPopupModeFlags;
	sal_uInt16			mnTitle;
	sal_uInt16			mnOldTitle;
	sal_Bool			mbInPopupMode;
	sal_Bool			mbPopupMode;
	sal_Bool			mbPopupModeCanceled;
	sal_Bool			mbPopupModeTearOff;
	sal_Bool			mbMouseDown;
	sal_Bool			mbOldSaveBackMode;
	sal_Bool			mbGrabFocus;    // act as key input window, although focus is not set
	sal_Bool			mbInCleanUp;
	Link			maPopupModeEndHdl;

//#if 0 // _SOLAR__PRIVATE
	SAL_DLLPRIVATE void    ImplCallPopupModeEnd();
	DECL_DLLPRIVATE_LINK(  ImplEndPopupModeHdl, void* );

    // Copy assignment is forbidden and not implemented.
	SAL_DLLPRIVATE         FloatingWindow (const FloatingWindow &);
	SAL_DLLPRIVATE         FloatingWindow & operator= (const FloatingWindow &);

protected:
    using Window::ImplInit;
	SAL_DLLPRIVATE void    ImplInit( Window* pParent, WinBits nStyle );
	SAL_DLLPRIVATE void    ImplInitSettings();
	SAL_DLLPRIVATE void    ImplLoadRes( const ResId& rResId );

public:
#define IMPL_FLOATWIN_HITTEST_OUTSIDE		((sal_uInt16)0x0001)
#define IMPL_FLOATWIN_HITTEST_WINDOW		((sal_uInt16)0x0002)
#define IMPL_FLOATWIN_HITTEST_RECT			((sal_uInt16)0x0004)
	SAL_DLLPRIVATE FloatingWindow*  ImplFloatHitTest( Window* pReference, const Point& rPos, sal_uInt16& rHitTest );
	SAL_DLLPRIVATE FloatingWindow*  ImplFindLastLevelFloat();
	SAL_DLLPRIVATE sal_Bool			    ImplIsFloatPopupModeWindow( const Window* pWindow );
	SAL_DLLPRIVATE void			    ImplSetMouseDown() { mbMouseDown = sal_True; }
	SAL_DLLPRIVATE sal_Bool    			ImplIsMouseDown() const  { return mbMouseDown; }
	SAL_DLLPRIVATE static Point    	ImplCalcPos( Window* pWindow,
                                                 const Rectangle& rRect, sal_uLong nFlags,
                                                 sal_uInt16& rArrangeIndex );
	SAL_DLLPRIVATE void			    ImplEndPopupMode( sal_uInt16 nFlags = 0, sal_uLong nFocusId = 0 );
    SAL_DLLPRIVATE Rectangle&       ImplGetItemEdgeClipRect();
    SAL_DLLPRIVATE sal_Bool             ImplIsInPrivatePopupMode() const { return mbInPopupMode; }
//#endif

public:
	explicit		FloatingWindow( Window* pParent, WinBits nStyle = WB_STDFLOATWIN );
	explicit		FloatingWindow( Window* pParent, const ResId& );
	virtual			~FloatingWindow();

	virtual long	Notify( NotifyEvent& rNEvt );
	virtual void	StateChanged( StateChangedType nType );
	virtual void	DataChanged( const DataChangedEvent& rDCEvt );

	virtual void	PopupModeEnd();

	void			SetTitleType( sal_uInt16 nTitle );
	sal_uInt16			GetTitleType() const { return mnTitle; }

	void			StartPopupMode( const Rectangle& rRect, sal_uLong nFlags = 0 );
	void			StartPopupMode( ToolBox* pBox, sal_uLong nFlags = 0  );
	void			EndPopupMode( sal_uInt16 nFlags = 0 );
	void			AddPopupModeWindow( Window* pWindow );
	void			RemovePopupModeWindow( Window* pWindow );
	sal_uLong			GetPopupModeFlags() const { return mnPopupModeFlags; }
    void			SetPopupModeFlags( sal_uLong nFlags ) { mnPopupModeFlags = nFlags; }
	sal_Bool			IsInPopupMode() const { return mbPopupMode; }
	sal_Bool			IsInCleanUp() const { return mbInCleanUp; }
	sal_Bool			IsPopupModeCanceled() const { return mbPopupModeCanceled; }
	sal_Bool			IsPopupModeTearOff() const { return mbPopupModeTearOff; }

	void			SetPopupModeEndHdl( const Link& rLink ) { maPopupModeEndHdl = rLink; }
	const Link& 	GetPopupModeEndHdl() const	{ return maPopupModeEndHdl; }

    sal_Bool            GrabsFocus() const { return mbGrabFocus; }

	static Point    CalcFloatingPosition( Window* pWindow, const Rectangle& rRect, sal_uLong nFlags, sal_uInt16& rArrangeIndex );
};

#endif // _SV_FLOATWIN_HXX