include/svl/ownlist.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 INCLUDED_SVL_OWNLIST_HXX
  21 #define INCLUDED_SVL_OWNLIST_HXX
  22
  23 #include <svl/svldllapi.h>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <vector>
  26
  27 namespace com { namespace sun { namespace star {
  28     namespace beans {
  29         struct PropertyValue;
  30     }
  31 }}}
  32
  33
  34 class SvCommand
  35 /*
  36     Contains a string that defines the command and another string for the
  37     command arguments. If such a command were given in the command line,
  38     it would look like this: command = argument
  39 */
  40 {
  41     OUString aCommand;
  42     OUString aArgument;
  43 public:
  44                     SvCommand() {}
  45     SvCommand( const OUString & rCommand, const OUString & rArg )
  46                     {
  47                         aCommand = rCommand;
  48                         aArgument = rArg;
  49                     }
  50     const OUString & GetCommand() const { return aCommand; }
  51     const OUString & GetArgument() const { return aArgument; }
  52 };
  53
  54 typedef ::std::vector< SvCommand > SvCommandList_impl;
  55
  56
  57 class SVL_DLLPUBLIC SvCommandList
  58 /*
  59   The list contains objects of type SvCommand.
  60   If an object is inserted, it is copied and inserted at the end
  61   of the list.
  62  */
  63 {
  64 private:
  65     SvCommandList_impl  aCommandList;
  66
  67 public:
  68     SvCommand&      Append( const OUString & rCommand, const OUString & rArg );
  69     bool        AppendCommands( const OUString & rCmd, sal_Int32 * pEaten );
  70
  71     bool FillFromSequence( const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >& );
  72     void FillSequence( com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >& );
  73
  74     size_t          size() const { return aCommandList.size(); }
  75
  76     SvCommand       operator[]( size_t i) {
  77                         return aCommandList[ i ];
  78                     }
  79
  80     void            clear() {
  81                         aCommandList.clear();
  82                     }
  83 };
  84
  85 #endif // INCLUDED_SVL_OWNLIST_HXX
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */