| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _FILTER_CONTAINER_HXX_ |
| #define _FILTER_CONTAINER_HXX_ |
| |
| #include <sal/types.h> |
| #include <rtl/ustring.hxx> |
| |
| #include <vector> |
| |
| //------------------------------------------------------ |
| // helper class, only useable by OFilterContainer |
| //------------------------------------------------------ |
| |
| class CFilterContainer |
| { |
| public: |
| // defines a filter entry which is made of a name and a filter value |
| // e.g. 'Text *.txt' |
| typedef std::pair< rtl::OUString, rtl::OUString > FILTER_ENTRY_T; |
| |
| public: |
| explicit CFilterContainer( sal_Int32 initSize = 0 ); |
| |
| // add a new filter |
| // returns true if the filter was successfully added |
| // returns false if duplicates are not allowed and |
| // the filter is already in the container |
| sal_Bool SAL_CALL addFilter( |
| const ::rtl::OUString& aName, |
| const ::rtl::OUString& aFilter, |
| sal_Bool bAllowDuplicates = sal_False ); |
| |
| // delete the specified filter returns true on |
| // success and false if the filter was not found |
| sal_Bool SAL_CALL delFilter( const ::rtl::OUString& aName ); |
| |
| // the number of filter already added |
| sal_Int32 SAL_CALL numFilter( ); |
| |
| // clear all entries |
| void SAL_CALL empty( ); |
| |
| // retrieve a filter from the container both methods |
| // return true on success and false if the specified |
| // filter was not found |
| sal_Bool SAL_CALL getFilter( const ::rtl::OUString& aName, ::rtl::OUString& theFilter ) const; |
| sal_Bool SAL_CALL getFilter( sal_Int32 aIndex, ::rtl::OUString& theFilter ) const; |
| |
| // returns the position of the specified filter or -1 |
| // if the filter was not found |
| sal_Int32 SAL_CALL getFilterPos( const ::rtl::OUString& aName ) const; |
| |
| // starts enumerating the filter in the container |
| void SAL_CALL beginEnumFilter( ); |
| |
| // returns true if another filter has been retrieved |
| sal_Bool SAL_CALL getNextFilter( FILTER_ENTRY_T& nextFilterEntry ); |
| |
| // cache current filter |
| void SAL_CALL setCurrentFilter( const ::rtl::OUString& aName ); |
| |
| // returns cached current filter |
| ::rtl::OUString SAL_CALL getCurrentFilter() const; |
| |
| protected: |
| typedef std::vector< FILTER_ENTRY_T > FILTER_VECTOR_T; |
| |
| private: |
| // prevent copy and assignment |
| CFilterContainer( const CFilterContainer& ); |
| CFilterContainer& SAL_CALL operator=( const CFilterContainer& ); |
| |
| sal_Int32 SAL_CALL getFilterTagPos( const ::rtl::OUString& aName ) const; |
| |
| private: |
| FILTER_VECTOR_T m_vFilters; |
| FILTER_VECTOR_T::const_iterator m_iter; |
| sal_Bool m_bIterInitialized; |
| ::rtl::OUString m_sCurrentFilter; |
| }; |
| |
| //---------------------------------------------------------------- |
| // a helper function to create a filter buffer in the format |
| // the Win32 API requires, e.g. "Text\0*.txt\0Doc\0*.doc;*xls\0\0" |
| //---------------------------------------------------------------- |
| |
| rtl::OUString SAL_CALL makeWinFilterBuffer( CFilterContainer& aFilterContainer ); |
| |
| #endif |