xref: /aoo41x/main/dbaccess/source/ui/app/AppDetailPageHelper.hxx (revision 2e2212a7)

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

#include <vector>

#ifndef _RTL_USTRING_HXX_
#include <rtl/ustring.hxx>
#endif
#ifndef _COM_SUN_STAR_SDBC_XDATABASEMETADATA_HPP_
#include <com/sun/star/sdbc/XDatabaseMetaData.hpp>
#endif
#ifndef _COM_SUN_STAR_SDB_APPLICATION_NAMEDDATABASEOBJECT_HPP_
#include <com/sun/star/sdb/application/NamedDatabaseObject.hpp>
#endif
#ifndef _COM_SUN_STAR_UCB_XCONTENT_HPP_
#include <com/sun/star/ucb/XContent.hpp>
#endif
#ifndef DBAUI_APPELEMENTTYPE_HXX
#include "AppElementType.hxx"
#endif
#ifndef _SVTREEBOX_HXX
#include <svtools/svtreebx.hxx>
#endif
#ifndef SVTOOLS_DOCUMENTINFOPREVIEW_HXX
#include <svtools/DocumentInfoPreview.hxx>
#endif
#ifndef _SV_FIXED_HXX
#include <vcl/fixed.hxx>
#endif
#ifndef _SV_TOOLBOX_HXX
#include <vcl/toolbox.hxx>
#endif
#ifndef _SV_CVTGRF_HXX
#include <vcl/cvtgrf.hxx>
#endif
#ifndef _SV_GRAPH_HXX
#include <vcl/graph.hxx>
#endif
#ifndef _GRFMGR_HXX
#include <svtools/grfmgr.hxx>
#endif
#include "callbacks.hxx"
#include <memory>

namespace com{ namespace sun { namespace star { namespace awt   { class XWindow; } } } }
namespace com{ namespace sun { namespace star { namespace frame { class XFrame; } } } }
namespace com{ namespace sun { namespace star { namespace io    { class XPersist; } } } }

#define ELEMENT_COUNT   size_t(E_ELEMENT_TYPE_COUNT)

namespace dbaui
{
	class OAppBorderWindow;
	class DBTreeListBox;

	class OPreviewWindow : public Window
	{
		GraphicObject		m_aGraphicObj;
		Rectangle			m_aPreviewRect;

		/** gets the graphic cnter rect
			@param	rGraphic
				the graphic
			@param	rResultRect
				the resulting rectangle

			@return
				<TRUE/> when successfull
		*/
		sal_Bool ImplGetGraphicCenterRect( const Graphic& rGraphic, Rectangle& rResultRect ) const;
		void ImplInitSettings( sal_Bool bFont, sal_Bool bForeground, sal_Bool bBackground );
	protected:
		virtual void DataChanged(const DataChangedEvent& rDCEvt);
	public:
		OPreviewWindow(Window* _pParent);

		// window overloads
		virtual void Paint(const Rectangle& rRect);

		void setGraphic(const Graphic& _rGraphic ) { m_aGraphicObj.SetGraphic(_rGraphic); }
	};
	//==================================================================
	// A helper class for the controls in the detail page.
	// Combines general functionality.
	//==================================================================
	class OAppDetailPageHelper : public Window
	{
		DBTreeListBox*		m_pLists[ELEMENT_COUNT];
		OAppBorderWindow&	m_rBorderWin;
		FixedLine			m_aFL;
		ToolBox				m_aTBPreview;
		Window				m_aBorder;
		OPreviewWindow		m_aPreview;
		::svtools::ODocumentInfoPreview
							m_aDocumentInfo;
		Window*				m_pTablePreview;
		::std::auto_ptr<PopupMenu> m_aMenu;
		PreviewMode			m_ePreviewMode;
		::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >
							m_xFrame;
		::com::sun::star::uno::Reference < ::com::sun::star::io::XPersist >
							m_xDocInfo;
		::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >
							m_xWindow;

		/// returns the index of the visible control
		int getVisibleControlIndex() const;

		/** sorts the entries in the tree list box.
			@param	_nPos
				Which list should be sorted.
			@param	_eSortMode
				How should be sorted.
		*/
		void sort(int _nPos,SvSortMode _eSortMode );

        /** retrieves the resource ids of the images representing elements of the given type
        */
        void getElementIcons( ElementType _eType, sal_uInt16& _rImageId, sal_uInt16& _rHighContrastImageId );

		/** fills the names in the listbox
			@param	_xContainer
				This can either be the queries, forms or report names.
			@param	_eType
				the type of elements which are being filled
            @param _nImageId
                the resource id of the image to use for non-container entries
            @param _nHighContrastImageId
                the resource id of the high contrast image to use for non-container entries
			@param	_pParent
				The parent of the entries to be inserted.
		*/
		void fillNames( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _xContainer,
						const ElementType _eType,
						const sal_uInt16 _nImageId,
						const sal_uInt16 _nHighContrastImageId,
						SvLBoxEntry* _pParent );

		/** sets the detail page
			@param	_pWindow
				The control which should be visible.
		*/
		void setDetailPage(Window* _pWindow);

		/** sets all HandleCallbacks
			@param	_pTreeView
				The newly created DBTreeListBox
			@param	_rImage
				the resource id of the default icon
			@param	_rImageHC
				the resource id of the default icon (HC version)
			@return
				The new tree.
		*/
        DBTreeListBox* createTree( DBTreeListBox* _pTreeView, const Image& _rImage, const Image& _rImageHC );

		/** creates the tree and sets all HandleCallbacks
			@param	_nHelpId
				The help id of the control
			@param	_nCollapsedBitmap
				The image to use for tree entries.
			@param	_rImageHC
				The image to use in high contrast mode.
			@return
				The new tree.
		*/
		DBTreeListBox* createSimpleTree( const rtl::OString& _sHelpId, const Image& _rImage, const Image& _rImageHC );

		DECL_LINK( OnEntryDoubleClick,			SvTreeListBox* );
		DECL_LINK( OnEntrySelChange,			void* );

		DECL_LINK( OnCutEntry,					void* );
		DECL_LINK( OnCopyEntry, 				void* );
		DECL_LINK( OnPasteEntry,				void* );
		DECL_LINK( OnDeleteEntry,				void* );

		DECL_LINK(PreviewChangeHdl, void*);
		// click a TB slot
		DECL_LINK(OnDropdownClickHdl, ToolBox*);

		inline OAppBorderWindow& getBorderWin() const { return m_rBorderWin; }
		void ImplInitSettings();

    public:
		OAppDetailPageHelper(Window* _pParent,OAppBorderWindow& _rBorderWin,PreviewMode _ePreviewMode);
		virtual ~OAppDetailPageHelper();

		// window overloads
		virtual void Resize();
		virtual void KeyInput( const KeyEvent& rKEvt );

        sal_Bool isCutAllowed();
		sal_Bool isCopyAllowed();
		sal_Bool isPasteAllowed();
		void copy();
		void cut();
		void paste();

		/** creates the tables page
			@param	_xConnection
				The connection to get the table names
		*/
		void createTablesPage(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection);

		/** creates the page for the specific type.
			@param	_eType
				The type which should be created. E_TABLE isn't allowed.
			@param	_xContainer
				The container of the elements to be inserted.
		*/
		void createPage(ElementType _eType,const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _xContainer);

		/** returns the current visible tree list box
		*/
		inline DBTreeListBox* getCurrentView() const
		{
			ElementType eType = getElementType();
			return (eType != E_NONE ) ? m_pLists[static_cast<sal_Int32>(eType)] : NULL;
		}

		/// select all entries in the visible control
		void selectAll();

		/// returns <TRUE/> if it sorts ascending
		sal_Bool isSortUp() const;

		/// sorts all entries ascending
		void sortDown();

		/// sorts all entries descending
		void sortUp();

		/** returns the element names which are selected
			@param	_rNames
				The list will be filled.
		*/
		void getSelectionElementNames( ::std::vector< ::rtl::OUString>& _rNames ) const;

        /** describes the current selection for the given control
        */
        void    describeCurrentSelectionForControl(
                    const Control& _rControl,
                    ::com::sun::star::uno::Sequence< ::com::sun::star::sdb::application::NamedDatabaseObject >& _out_rSelectedObjects
                );

        /** describes the current selection for the given ElementType
        */
        void    describeCurrentSelectionForType(
                    const ElementType _eType,
                    ::com::sun::star::uno::Sequence< ::com::sun::star::sdb::application::NamedDatabaseObject >& _out_rSelectedObjects
                );

        /** select all names on the currently selected container. Non existence names where ignored.
        *
        * \param _aNames the element names
        */
        void selectElements(const ::com::sun::star::uno::Sequence< ::rtl::OUString>& _aNames);

		/** return the qualified name.
			@param	_pEntry
				The entry of a table, or query, form, report to get the qualified name.
				If the entry is <NULL/>, the first selected is chosen.
			@return
				the qualified name
		*/
		::rtl::OUString getQualifiedName( SvLBoxEntry* _pEntry ) const;

		/// return the element of currently select entry
		ElementType getElementType() const;

		/// returns the count of selected entries
		sal_Int32 getSelectionCount();

		/// returns the count of entries
		sal_Int32 getElementCount();

		/** returns if an entry is a leaf
			@param _pEntry
				The entry to check
			@return
				<TRUE/> if the entry is a leaf, otherwise <FALSE/>
		*/
		bool    isLeaf(SvLBoxEntry* _pEntry) const;

		/** returns if one of the selected entries is a leaf
			@return
				<TRUE/> if the entry is a leaf, otherwise <FALSE/>
		*/
		sal_Bool isALeafSelected() const;

		SvLBoxEntry* getEntry( const Point& _aPosPixel ) const;

		/// clears the detail pages
		void clearPages();

		/// returns <TRUE/> when a detail page was filled
		sal_Bool isFilled() const;

		/** adds a new object to the detail page.
			@param	_eType
				The type where the entry shold be appended.
			@param	_rName
				The name of the object to be inserted
			@param	_rObject
				The object to add.
			@param	_rxConn
				If we insert a table, the connection must be set.
		*/
		SvLBoxEntry*  elementAdded(ElementType eType
						,const ::rtl::OUString& _rName
						,const ::com::sun::star::uno::Any& _rObject );

		/** replaces a objects name with a new one
			@param	_eType
				The type where the entry shold be appended.
			@param	_rOldName
				The old name of the object to be replaced
			@param	_rNewName
				The new name of the object to be replaced
			@param	_rxConn
				If we insert a table, the connection must be set.
		*/
		void elementReplaced(ElementType eType
						,const ::rtl::OUString& _rOldName
						,const ::rtl::OUString& _rNewName );

		/** removes an element from the detail page.
			@param	_eType
				The type where the entry shold be appended.
			@param	_rName
				The name of the element to be removed.
			@param	_rxConn
				If we remove a table, the connection must be set.
		*/
		void elementRemoved(ElementType _eType
							,const ::rtl::OUString& _rName );


		/// returns the preview mode
		PreviewMode getPreviewMode();

		/// <TRUE/> if the preview is enabled
		sal_Bool isPreviewEnabled();

		/** switches to the given preview mode
			@param	_eMode
				the mode to set for the preview
			@param	_bForce
				Force the preview to be resetted
		*/
		void switchPreview(PreviewMode _eMode,sal_Bool _bForce = sal_False);

		/** shows the Preview of the content when it is enabled.
			@param	_xContent
				The content which must support the "preview" command.
		*/
		void showPreview(const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContent >& _xContent);

		/** shows the Preview of a table or query
			@param	_sDataSourceName
				the name of the data source
			@param	_sName
				the name of table or query
			@param	_bTable
				<TRUE/> if it is a table, otherwise <FALSE/>
			@return	void
		*/
		void showPreview(	const ::rtl::OUString& _sDataSourceName,
							const ::rtl::OUString& _sName,
							sal_Bool _bTable);

    protected:
        void DataChanged( const DataChangedEvent& rDCEvt );
	};
}
#endif // DBAUI_APPDETAILPAGEHELPER_HXX