AOO410/main/cui/source/inc/selector.hxx

/**************************************************************
 * 
 * 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 _SVXSELECTOR_HXX
#define _SVXSELECTOR_HXX

#include <vcl/lstbox.hxx>
#include <vcl/fixed.hxx>
#include <vcl/group.hxx>
#include <vcl/menubtn.hxx>
#include <svtools/svtreebx.hxx>

#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/script/browse/XBrowseNode.hpp>

#define _SVSTDARR_USHORTS
#define _SVSTDARR_STRINGSDTOR
#include <svl/svstdarr.hxx>		// SvUShorts
#include <sfx2/minarray.hxx>

#define SVX_CFGGROUP_FUNCTION 1
#define SVX_CFGFUNCTION_SLOT  2
#define SVX_CFGGROUP_SCRIPTCONTAINER  3
#define SVX_CFGFUNCTION_SCRIPT 4

struct SvxGroupInfo_Impl
{
	sal_uInt16 		    nKind;
	sal_uInt16 		    nOrd;
    ::com::sun::star::uno::Reference< ::com::sun::star::script::browse::XBrowseNode >
                    xBrowseNode;
    ::rtl::OUString sURL;
    ::rtl::OUString sHelpText;
	sal_Bool		    bWasOpened;

	SvxGroupInfo_Impl( sal_uInt16 n, sal_uInt16 nr )
        :nKind( n )
        ,nOrd( nr )
        ,xBrowseNode()
        ,sURL()
        ,sHelpText()
        ,bWasOpened(sal_False)
    {
    }

	SvxGroupInfo_Impl( sal_uInt16 n, sal_uInt16 nr, const ::com::sun::star::uno::Reference< ::com::sun::star::script::browse::XBrowseNode >& _rxNode )
        :nKind( n )
        ,nOrd( nr )
        ,xBrowseNode( _rxNode )
        ,sURL()
        ,sHelpText()
        ,bWasOpened(sal_False)
    {
    }

    SvxGroupInfo_Impl( sal_uInt16 n, sal_uInt16 nr, const ::rtl::OUString& _rURL, const ::rtl::OUString& _rHelpText )
        :nKind( n )
        ,nOrd( nr )
        ,xBrowseNode()
        ,sURL( _rURL )
        ,sHelpText( _rHelpText )
        ,bWasOpened(sal_False)
    {
    }
};

typedef SvxGroupInfo_Impl* SvxGroupInfoPtr;
SV_DECL_PTRARR_DEL(SvxGroupInfoArr_Impl, SvxGroupInfoPtr, 5, 5)

class ImageProvider
{
public:
    virtual ~ImageProvider() {}

	virtual Image GetImage( const rtl::OUString& rCommandURL ) = 0;
};

class SvxConfigFunctionListBox_Impl : public SvTreeListBox
{
friend class SvxConfigGroupListBox_Impl;
	Timer							aTimer;
	SvLBoxEntry*					pCurEntry;
	SvxGroupInfoArr_Impl			aArr;
	SvLBoxEntry*					m_pDraggingEntry;

	DECL_LINK(						TimerHdl, Timer* );
	virtual void 					MouseMove( const MouseEvent& rMEvt );

public:
									SvxConfigFunctionListBox_Impl( Window*, const ResId& );
									~SvxConfigFunctionListBox_Impl();
	void							ClearAll();
	String							GetHelpText( SvLBoxEntry *pEntry );
	using Window::GetHelpText;
	SvLBoxEntry*					GetLastSelectedEntry();
	void							FunctionSelected();

	// drag n drop methods
	virtual sal_Int8	AcceptDrop( const AcceptDropEvent& rEvt );

	virtual DragDropMode	NotifyStartDrag(
		TransferDataContainer&, SvLBoxEntry* );

	virtual void		DragFinished( sal_Int8 );
};

class SvxConfigGroupListBox_Impl : public SvTreeListBox
{
	SvxGroupInfoArr_Impl			aArr;
    bool                            m_bShowSlots;

	SvxConfigFunctionListBox_Impl*	pFunctionListBox;
	ImageProvider*					m_pImageProvider;

	::com::sun::star::uno::Reference
		< ::com::sun::star::frame::XFrame > m_xFrame;

	::com::sun::star::uno::Reference
		< ::com::sun::star::container::XNameAccess > m_xModuleCommands;

    Image m_hdImage;
    Image m_hdImage_hc;
    Image m_libImage;
    Image m_libImage_hc;
    Image m_macImage;
    Image m_macImage_hc;
    Image m_docImage;
    Image m_docImage_hc;
    ::rtl::OUString m_sMyMacros;
    ::rtl::OUString m_sProdMacros;
    Image GetImage( ::com::sun::star::uno::Reference< ::com::sun::star::script::browse::XBrowseNode > node, ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > xCtx, bool bIsRootNode, bool bHighContrast );
    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface  > getDocumentModel( ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& xCtx, ::rtl::OUString& docName );

private:
    void    fillScriptList(
        const ::com::sun::star::uno::Reference< ::com::sun::star::script::browse::XBrowseNode >& _rxRootNode,
        SvLBoxEntry* _pParentEntry,
        bool _bCheapChildsOnDemand
    );

protected:
	virtual void	RequestingChilds( SvLBoxEntry *pEntry);
	virtual sal_Bool	Expand( SvLBoxEntry* pParent );
	using SvListView::Expand;

public:
			SvxConfigGroupListBox_Impl (
				Window* pParent, const ResId&,
				bool _bShowSlots,
				const ::com::sun::star::uno::Reference
					< ::com::sun::star::frame::XFrame >& xFrame
			);

			~SvxConfigGroupListBox_Impl();

	void	Init();
	void	Open( SvLBoxEntry*, sal_Bool );
	void	ClearAll();
	void	GroupSelected();

	void 	SetFunctionListBox( SvxConfigFunctionListBox_Impl *pBox )
		{ pFunctionListBox = pBox; }

	void	SetImageProvider( ImageProvider* provider )
		{ m_pImageProvider = provider; }
};

class SvxScriptSelectorDialog : public ModelessDialog
{
	FixedText						aDialogDescription;
	FixedText						aGroupText;
	SvxConfigGroupListBox_Impl 		aCategories;
	FixedText						aFunctionText;
	SvxConfigFunctionListBox_Impl	aCommands;
	OKButton						aOKButton;
	CancelButton					aCancelButton;
	HelpButton						aHelpButton;
	FixedLine						aDescription;
	FixedText						aDescriptionText;

	sal_Bool							m_bShowSlots;
	Link							m_aAddHdl;

	DECL_LINK( ClickHdl, Button * );
	DECL_LINK( SelectHdl, Control* );
	DECL_LINK( FunctionDoubleClickHdl, Control* );

	void								UpdateUI();
	void								ResizeControls();

public:

	SvxScriptSelectorDialog (
		Window* pParent = NULL,
		sal_Bool bShowSlots = sal_False,
		const ::com::sun::star::uno::Reference
			< ::com::sun::star::frame::XFrame >& xFrame = 0
	);

	~SvxScriptSelectorDialog ( );

	void		SetAddHdl( const Link& rLink ) { m_aAddHdl = rLink; }
	const Link&	GetAddHdl() const { return m_aAddHdl; }

	void		SetImageProvider( ImageProvider* provider )
		{ aCategories.SetImageProvider( provider ); }

	String		GetScriptURL() const;
	String		GetSelectedDisplayName();
	String		GetSelectedHelpText();
	void		SetRunLabel();
	void		SetDialogDescription(const String& rDescription);
};

#endif