shell/inc/systemshell.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: systemshell.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SYSTEMSHELL_HXX_
  32 #define _SYSTEMSHELL_HXX_
  33
  34 #include <rtl/ustring.hxx>
  35
  36 namespace SystemShell
  37 {
  38     /** Add a file to the system shells recent document list if there is any.
  39           This function may have no effect under Unix because there is no
  40           standard API among the different desktop managers.
  41
  42           @param aFileUrl
  43                     The file url of the document.
  44
  45           @param aMimeType
  46           The mime content type of the document specified by aFileUrl.
  47           If an empty string will be provided "application/octet-stream"
  48           will be used.
  49     */
  50     void AddToRecentDocumentList(const rtl::OUString& aFileUrl, const rtl::OUString& aMimeType);
  51 }
  52
  53 #endif