1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef BASCTL_DOCUMENTENUMERATION_HXX 25*b1cdbd2cSJim Jagielski #define BASCTL_DOCUMENTENUMERATION_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 28*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XModel.hpp> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XController.hpp> 30*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include <comphelper/componentcontext.hxx> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski #include <memory> 35*b1cdbd2cSJim Jagielski #include <vector> 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski //........................................................................ 38*b1cdbd2cSJim Jagielski namespace basctl { namespace docs { 39*b1cdbd2cSJim Jagielski //........................................................................ 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski typedef ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > Model; 42*b1cdbd2cSJim Jagielski typedef ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController > > Controllers; 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski struct DocumentDescriptor 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski Model xModel; 47*b1cdbd2cSJim Jagielski Controllers aControllers; 48*b1cdbd2cSJim Jagielski }; 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski typedef ::std::vector< DocumentDescriptor > Documents; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski //==================================================================== 53*b1cdbd2cSJim Jagielski //= IDocumentDescriptorFilter 54*b1cdbd2cSJim Jagielski //==================================================================== 55*b1cdbd2cSJim Jagielski /// allows pre-filtering when enumerating document descriptors 56*b1cdbd2cSJim Jagielski class SAL_NO_VTABLE IDocumentDescriptorFilter 57*b1cdbd2cSJim Jagielski { 58*b1cdbd2cSJim Jagielski public: 59*b1cdbd2cSJim Jagielski virtual bool includeDocument( const DocumentDescriptor& _rDocument ) const = 0; 60*b1cdbd2cSJim Jagielski }; 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski //==================================================================== 63*b1cdbd2cSJim Jagielski //= DocumentEnumeration 64*b1cdbd2cSJim Jagielski //==================================================================== 65*b1cdbd2cSJim Jagielski struct DocumentEnumeration_Data; 66*b1cdbd2cSJim Jagielski /** is a helper class for enumerating documents in OOo 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski If you need a list of all open documents in OOo, this is little bit of 69*b1cdbd2cSJim Jagielski a hassle: You need to iterate though all components at the desktop, which 70*b1cdbd2cSJim Jagielski might or might not be documents. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski Additionally, you need to examine the existing documents' frames 73*b1cdbd2cSJim Jagielski for sub frames, which might contain sub documents (e.g. embedded objects 74*b1cdbd2cSJim Jagielski edited out-place). 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski DocumentEnumeration relieves you from this hassle. 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski class DocumentEnumeration 79*b1cdbd2cSJim Jagielski { 80*b1cdbd2cSJim Jagielski public: 81*b1cdbd2cSJim Jagielski DocumentEnumeration( const ::comphelper::ComponentContext& _rContext, const IDocumentDescriptorFilter* _pFilter = NULL ); 82*b1cdbd2cSJim Jagielski ~DocumentEnumeration(); 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** retrieves a list of all currently known documents in the application 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param _out_rDocuments 87*b1cdbd2cSJim Jagielski output parameter taking the collected document information 88*b1cdbd2cSJim Jagielski @ 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski void getDocuments( 91*b1cdbd2cSJim Jagielski Documents& _out_rDocuments 92*b1cdbd2cSJim Jagielski ) const; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski private: 95*b1cdbd2cSJim Jagielski ::std::auto_ptr< DocumentEnumeration_Data > m_pData; 96*b1cdbd2cSJim Jagielski }; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski //........................................................................ 99*b1cdbd2cSJim Jagielski } } // namespace basctl::docs 100*b1cdbd2cSJim Jagielski //........................................................................ 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski #endif // BASCTL_DOCUMENTENUMERATION_HXX 103