diff options
author | Kurt Zenker <kz@openoffice.org> | 2007-10-09 14:23:41 +0000 |
---|---|---|
committer | Kurt Zenker <kz@openoffice.org> | 2007-10-09 14:23:41 +0000 |
commit | bec7491a736b788edcd7f88c01e496e855f73295 (patch) | |
tree | 417c38d273aeb0ad1913b1899ce272aaaf11c9ab /basctl | |
parent | 91966d75da43d4d9d51e3550d1f8c27e07710d4d (diff) |
INTEGRATION: CWS basmgr03 (1.1.2); FILE ADDED
2007/08/24 18:41:46 fs 1.1.2.2: removed wrong include
2007/08/23 20:08:38 fs 1.1.2.1: moved herein from module unotools: enumerate all documents in the running application
Diffstat (limited to 'basctl')
-rw-r--r-- | basctl/source/basicide/documentenumeration.hxx | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/basctl/source/basicide/documentenumeration.hxx b/basctl/source/basicide/documentenumeration.hxx new file mode 100644 index 000000000000..50ac1251701c --- /dev/null +++ b/basctl/source/basicide/documentenumeration.hxx @@ -0,0 +1,114 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: documentenumeration.hxx,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: kz $ $Date: 2007-10-09 15:23:41 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 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 + * + ************************************************************************/ + +#ifndef BASCTL_DOCUMENTENUMERATION_HXX +#define BASCTL_DOCUMENTENUMERATION_HXX + +/** === begin UNO includes === **/ +#include <com/sun/star/frame/XModel.hpp> +#include <com/sun/star/frame/XController.hpp> +/** === end UNO includes === **/ + +#include <comphelper/componentcontext.hxx> + +#include <memory> +#include <vector> + +//........................................................................ +namespace basctl { namespace docs { +//........................................................................ + + typedef ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > Model; + typedef ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController > > Controllers; + + struct DocumentDescriptor + { + Model xModel; + Controllers aControllers; + }; + + typedef ::std::vector< DocumentDescriptor > Documents; + + //==================================================================== + //= IDocumentDescriptorFilter + //==================================================================== + /// allows pre-filtering when enumerating document descriptors + class SAL_NO_VTABLE IDocumentDescriptorFilter + { + public: + virtual bool includeDocument( const DocumentDescriptor& _rDocument ) const = 0; + }; + + //==================================================================== + //= DocumentEnumeration + //==================================================================== + struct DocumentEnumeration_Data; + /** is a helper class for enumerating documents in OOo + + If you need a list of all open documents in OOo, this is little bit of + a hassle: You need to iterate though all components at the desktop, which + might or might not be documents. + + Additionally, you need to examine the existing documents' frames + for sub frames, which might contain sub documents (e.g. embedded objects + edited out-place). + + DocumentEnumeration relieves you from this hassle. + */ + class DocumentEnumeration + { + public: + DocumentEnumeration( const ::comphelper::ComponentContext& _rContext, const IDocumentDescriptorFilter* _pFilter = NULL ); + ~DocumentEnumeration(); + + /** retrieves a list of all currently known documents in the application + + @param _out_rDocuments + output parameter taking the collected document information + @ + */ + void getDocuments( + Documents& _out_rDocuments + ) const; + + private: + ::std::auto_ptr< DocumentEnumeration_Data > m_pData; + }; + +//........................................................................ +} } // namespace basctl::docs +//........................................................................ + +#endif // BASCTL_DOCUMENTENUMERATION_HXX |