1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef BASCTL_DOCUMENTENUMERATION_HXX 29*cdf0e10cSrcweir #define BASCTL_DOCUMENTENUMERATION_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir /** === begin UNO includes === **/ 32*cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp> 33*cdf0e10cSrcweir #include <com/sun/star/frame/XController.hpp> 34*cdf0e10cSrcweir /** === end UNO includes === **/ 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir #include <comphelper/componentcontext.hxx> 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir #include <memory> 39*cdf0e10cSrcweir #include <vector> 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir //........................................................................ 42*cdf0e10cSrcweir namespace basctl { namespace docs { 43*cdf0e10cSrcweir //........................................................................ 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir typedef ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > Model; 46*cdf0e10cSrcweir typedef ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController > > Controllers; 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir struct DocumentDescriptor 49*cdf0e10cSrcweir { 50*cdf0e10cSrcweir Model xModel; 51*cdf0e10cSrcweir Controllers aControllers; 52*cdf0e10cSrcweir }; 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir typedef ::std::vector< DocumentDescriptor > Documents; 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir //==================================================================== 57*cdf0e10cSrcweir //= IDocumentDescriptorFilter 58*cdf0e10cSrcweir //==================================================================== 59*cdf0e10cSrcweir /// allows pre-filtering when enumerating document descriptors 60*cdf0e10cSrcweir class SAL_NO_VTABLE IDocumentDescriptorFilter 61*cdf0e10cSrcweir { 62*cdf0e10cSrcweir public: 63*cdf0e10cSrcweir virtual bool includeDocument( const DocumentDescriptor& _rDocument ) const = 0; 64*cdf0e10cSrcweir }; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir //==================================================================== 67*cdf0e10cSrcweir //= DocumentEnumeration 68*cdf0e10cSrcweir //==================================================================== 69*cdf0e10cSrcweir struct DocumentEnumeration_Data; 70*cdf0e10cSrcweir /** is a helper class for enumerating documents in OOo 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir If you need a list of all open documents in OOo, this is little bit of 73*cdf0e10cSrcweir a hassle: You need to iterate though all components at the desktop, which 74*cdf0e10cSrcweir might or might not be documents. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir Additionally, you need to examine the existing documents' frames 77*cdf0e10cSrcweir for sub frames, which might contain sub documents (e.g. embedded objects 78*cdf0e10cSrcweir edited out-place). 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir DocumentEnumeration relieves you from this hassle. 81*cdf0e10cSrcweir */ 82*cdf0e10cSrcweir class DocumentEnumeration 83*cdf0e10cSrcweir { 84*cdf0e10cSrcweir public: 85*cdf0e10cSrcweir DocumentEnumeration( const ::comphelper::ComponentContext& _rContext, const IDocumentDescriptorFilter* _pFilter = NULL ); 86*cdf0e10cSrcweir ~DocumentEnumeration(); 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir /** retrieves a list of all currently known documents in the application 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir @param _out_rDocuments 91*cdf0e10cSrcweir output parameter taking the collected document information 92*cdf0e10cSrcweir @ 93*cdf0e10cSrcweir */ 94*cdf0e10cSrcweir void getDocuments( 95*cdf0e10cSrcweir Documents& _out_rDocuments 96*cdf0e10cSrcweir ) const; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir private: 99*cdf0e10cSrcweir ::std::auto_ptr< DocumentEnumeration_Data > m_pData; 100*cdf0e10cSrcweir }; 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir //........................................................................ 103*cdf0e10cSrcweir } } // namespace basctl::docs 104*cdf0e10cSrcweir //........................................................................ 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir #endif // BASCTL_DOCUMENTENUMERATION_HXX 107