/************************************************************************* * * $RCSfile: taskcreator.hxx,v $ * * $Revision: 1.5 $ * * last change: $Author: as $ $Date: 2001-05-21 06:11:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __FRAMEWORK_CLASSES_TASKCREATOR_HXX_ #define __FRAMEWORK_CLASSES_TASKCREATOR_HXX_ //_________________________________________________________________________________________________________________ // my own includes //_________________________________________________________________________________________________________________ #ifndef __FRAMEWORK_CLASSES_TARGETFINDER_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_DEBUG_HXX_ #include #endif #ifndef __FRAMEWORK_GENERAL_H_ #include #endif //_________________________________________________________________________________________________________________ // interface includes //_________________________________________________________________________________________________________________ #ifndef _COM_SUN_STAR_FRAME_XFRAME_HPP_ #include #endif #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_ #include #endif //_________________________________________________________________________________________________________________ // other includes //_________________________________________________________________________________________________________________ #ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_ #include #endif #ifndef _RTL_USTRING_ #include #endif //_________________________________________________________________________________________________________________ // namespace //_________________________________________________________________________________________________________________ namespace framework{ //_________________________________________________________________________________________________________________ // exported const //_________________________________________________________________________________________________________________ //_________________________________________________________________________________________________________________ // exported definitions //_________________________________________________________________________________________________________________ /*-************************************************************************************************************//** @short a helper to create new tasks or plugin frames for "_blank" or FrameSearchFlag::CREATE at desktop @descr There are different places to create new tasks/plugin frames. Its not easy to service this code! Thats the reason for this helper. These implementation is not thread safe! @implements - @base - @devstatus ready to use @threadsafe no *//*-*************************************************************************************************************/ class TaskCreator { //------------------------------------------------------------------------------------------------------------- // public methods //------------------------------------------------------------------------------------------------------------- public: //--------------------------------------------------------------------------------------------------------- // constructor / destructor //--------------------------------------------------------------------------------------------------------- /*-****************************************************************************************************//** @short standard constructor @descr Initialize some member. @seealso - @param - @return - @onerror - *//*-*****************************************************************************************************/ TaskCreator( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); /*-****************************************************************************************************//** @short standard destructor to delete instance @descr Clear all member. @seealso - @param - @return - @onerror - *//*-*****************************************************************************************************/ virtual ~TaskCreator(); /*-****************************************************************************************************//** @short create a new task/plugin frame @descr With these methods you can create a new empty system task or a new empty plugin frame in a browser window. @seealso - @param "sName", name of new task @return A reference to the new created task/plugin. (It's a frame too ... frame is the baseclass of a task!) @onerror We return a null-reference. *//*-*****************************************************************************************************/ css::uno::Reference< css::frame::XFrame > createNewSystemTask ( const ::rtl::OUString& sName ); css::uno::Reference< css::frame::XFrame > createNewBrowserTask( const ::rtl::OUString& sName ); //------------------------------------------------------------------------------------------------------------- // protected methods //------------------------------------------------------------------------------------------------------------- protected: //------------------------------------------------------------------------------------------------------------- // private methods //------------------------------------------------------------------------------------------------------------- private: ::rtl::OUString impl_filterNames( const ::rtl::OUString& sName ); //------------------------------------------------------------------------------------------------------------- // debug methods // (should be private everyway!) //------------------------------------------------------------------------------------------------------------- /*-****************************************************************************************************//** @short debug-method to check incoming parameter of some other mehods of this class @descr The following methods are used to check parameters for other methods of this class. The return value is used directly for an ASSERT(...). @seealso ASSERTs in implementation! @param references to checking variables @return sal_False on invalid parameter
sal_True otherway @onerror - *//*-*****************************************************************************************************/ #ifdef ENABLE_ASSERTIONS private: static sal_Bool impldbg_checkParameter_createNewSystemTask ( const ::rtl::OUString& sName ); static sal_Bool impldbg_checkParameter_createNewBrowserTask ( const ::rtl::OUString& sName ); #endif // #ifdef ENABLE_ASSERTIONS //------------------------------------------------------------------------------------------------------------- // private variables // (should be private everyway!) //------------------------------------------------------------------------------------------------------------- private: css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; }; // class TaskCreator } // namespace framework #endif // #ifndef __FRAMEWORK_CLASSES_TASKCREATOR_HXX_