include/comphelper/documentinfo.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef COMPHELPER_DOCUMENTINFO_HXX
  21 #define COMPHELPER_DOCUMENTINFO_HXX
  22
  23 #include "comphelper/comphelperdllapi.h"
  24
  25 #include <com/sun/star/frame/XModel.hpp>
  26
  27 //........................................................................
  28 namespace comphelper {
  29 //........................................................................
  30
  31     //====================================================================
  32     //= DocumentInfo
  33     //====================================================================
  34     class COMPHELPER_DLLPUBLIC DocumentInfo
  35     {
  36     public:
  37         /** retrieves the UI title of the given document
  38         */
  39         static OUString  getDocumentTitle( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument );
  40
  41     private:
  42         DocumentInfo(); // never implemented
  43     };
  44
  45 //........................................................................
  46 }   // namespace comphelper
  47 //........................................................................
  48
  49 #endif // COMPHELPER_DOCUMENTINFO_HXX
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */