INTEGRATION: CWS visibility03 (1.1.2); FILE ADDED

2005/03/24 16:44:07 mhu 1.1.2.1: #i45006# Factored out and moved from svtools/source/filepicker/

1 files changed, 236 insertions, 0 deletions

diff --git a/fpicker/source/office/fpsmartcontent.hxx b/fpicker/source/office/fpsmartcontent.hxx
new file mode 100644
index 000000000000..19e5dc2bbe83
--- /dev/null
+++ b/fpicker/source/office/fpsmartcontent.hxx
@@ -0,0 +1,236 @@
+/*************************************************************************
+ *
+ *  $RCSfile: fpsmartcontent.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2005-04-13 08:53:46 $
+ *
+ *  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 SVTOOLS_SOURCE_FILEPICKER_FPSMARTCONTENT_HXX
+#define SVTOOLS_SOURCE_FILEPICKER_FPSMARTCONTENT_HXX
+
+#ifndef SVTOOLS_FILEPICKER_INTERACTION_HXX
+#include "fpinteraction.hxx"
+#endif
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_UCB_XCOMMANDENVIRONMENT_HPP_
+#include <com/sun/star/ucb/XCommandEnvironment.hpp>
+#endif
+#ifndef _COM_SUN_STAR_TASK_XINTERACTIONHANDLER_HPP_
+#include <com/sun/star/task/XInteractionHandler.hpp>
+#endif
+/** === end UNO includes === **/
+
+#ifndef _UCBHELPER_CONTENT_HXX
+#include <ucbhelper/content.hxx>
+#endif
+
+//........................................................................
+namespace svt
+{
+//........................................................................
+
+    //====================================================================
+    //= SmartContent
+    //====================================================================
+    /** a "smart content" which basically wraps an UCB content, but caches some informations
+        so that repeatedly recreating it may be faster
+    */
+    class SmartContent
+    {
+    public:
+        enum State
+        {
+            NOT_BOUND,  // never bound
+            UNKNOWN,    // bound, but validity is unknown
+            VALID,      // bound to an URL, and valid
+            INVALID     // bound to an URL, and invalid
+        };
+
+    private:
+        ::rtl::OUString                                                                  m_sURL;
+        ::ucb::Content*                                                                  m_pContent;
+        State                                                                            m_eState;
+        ::com::sun::star::uno::Reference < ::com::sun::star::ucb::XCommandEnvironment >  m_xCmdEnv;
+        ::com::sun::star::uno::Reference < ::com::sun::star::task::XInteractionHandler > m_xOwnInteraction;
+        ::svt::OFilePickerInteractionHandler*                                            m_pOwnInteraction;
+
+    private:
+        enum Type { Folder, Document };
+        /// checks if the currently bound content is a folder or document
+        sal_Bool implIs( const ::rtl::OUString& _rURL, Type _eType );
+
+        SmartContent( const SmartContent& _rSource );               // never implemented
+        SmartContent& operator=( const SmartContent& _rSource );    // never implemented
+
+    public:
+        SmartContent();
+        SmartContent( const ::rtl::OUString& _rInitialURL );
+        ~SmartContent();
+
+    public:
+
+        /** create and set a specialized interaction handler at the internal used command environment.
+
+            @param eInterceptions
+                    will be directly forwarded to OFilePickerInteractionHandler::enableInterceptions()
+        */
+        void enableOwnInteractionHandler(::svt::OFilePickerInteractionHandler::EInterceptedInteractions eInterceptions);
+
+        /** disable the specialized interaction handler and use the global UI interaction handler only.
+        */
+        void enableDefaultInteractionHandler();
+
+        /** return the internal used interaction handler object ...
+            Because this pointer will be valid only, if the uno object is hold
+            alive by it's uno reference (and this reference is set on the
+            command environment) we must return NULL, in case this environment does
+            not exist!
+        */
+        ::svt::OFilePickerInteractionHandler* getOwnInteractionHandler() const;
+
+        /** returns the current state of the content
+
+            @seealso State
+        */
+        inline  State       getState( ) const { return m_eState; }
+
+        /** checks if the content is valid
+            <p>Note that "not (is valid)" is not the same as "is invalid"</p>
+        */
+        inline  sal_Bool    isValid( ) const { return VALID == getState(); }
+
+        /** checks if the content is valid
+            <p>Note that "not (is invalid)" is not the same as "is valid"</p>
+        */
+        inline  sal_Bool    isInvalid( ) const { return INVALID == getState(); }
+
+        /** checks if the content is bound
+        */
+        inline  sal_Bool    isBound( ) const { return NOT_BOUND != getState(); }
+
+        /** returns the URL of the content
+        */
+        inline ::rtl::OUString  getURL() const { return m_pContent ? m_pContent->getURL() : m_sURL; }
+
+        /** (re)creates the content for the given URL
+
+            <p>Note that getState will return either UNKNOWN or INVALID after the call returns,
+            but never VALID. The reason is that there are content providers which allow to construct
+            content objects, even if the respective contents are not accessible. They tell about this
+            only upon working with the content object (e.g. when asking for the IsFolder).</p>
+
+            @postcond
+                <member>getState</member> does not return NOT_BOUND after the call returns
+        */
+        void    bindTo( const ::rtl::OUString& _rURL );
+
+        /** retrieves the title of the content
+            @precond
+                the content is bound and not invalid
+        */
+        void    getTitle( ::rtl::OUString& /* [out] */ _rTitle );
+
+        /** checks if the content has a parent folder
+            @precond
+                the content is bound and not invalid
+        */
+        sal_Bool    hasParentFolder( );
+
+        /** checks if sub folders below the content can be created
+            @precond
+                the content is bound and not invalid
+        */
+        sal_Bool    canCreateFolder( );
+
+        /** binds to the given URL, checks whether or not it refers to a folder
+
+            @postcond
+                the content is not in the state UNKNOWN
+        */
+        inline  sal_Bool    isFolder( const ::rtl::OUString& _rURL )
+        {
+            return implIs( _rURL, Folder );
+        }
+
+        /** binds to the given URL, checks whether or not it refers to a document
+
+            @postcond
+                the content is not in the state UNKNOWN
+        */
+        inline  sal_Bool    isDocument(  const ::rtl::OUString& _rURL )
+        {
+            return implIs( _rURL, Document );
+        }
+
+        /** checks if the content is existent (it is if and only if it is a document or a folder)
+        */
+        inline  sal_Bool    is( const ::rtl::OUString& _rURL )
+        {
+            return  implIs( _rURL, Folder ) || implIs( _rURL, Document );
+        }
+
+        inline  sal_Bool    isFolder( )     { return isFolder( getURL() ); }
+        inline  sal_Bool    isDocument( )   { return isDocument( getURL() ); }
+        inline  sal_Bool    is( )           { return is( getURL() ); }
+    };
+
+//........................................................................
+} // namespace svt
+//........................................................................
+
+#endif // SVTOOLS_SOURCE_FILEPICKER_FPSMARTCONTENT_HXX