fpicker/source/aqua/FilterHelper.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_FPICKER_SOURCE_AQUA_FILTERHELPER_HXX
  21 #define INCLUDED_FPICKER_SOURCE_AQUA_FILTERHELPER_HXX
  22
  23 #include <com/sun/star/beans/StringPair.hpp>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  27
  28 #include <com/sun/star/uno/RuntimeException.hpp>
  29
  30 #include <list>
  31 #include <vector>
  32
  33 #include <premac.h>
  34 #include <Cocoa/Cocoa.h>
  35 #include <postmac.h>
  36
  37 typedef css::beans::StringPair UnoFilterEntry;
  38 typedef css::uno::Sequence< UnoFilterEntry >   UnoFilterList;  // can be transported more effectively
  39 typedef ::std::list<NSString *> NSStringList;
  40 typedef ::std::list<OUString> OUStringList;
  41
  42 struct FilterEntry
  43 {
  44 protected:
  45     OUString            m_sTitle;
  46     OUStringList        m_sFilterSuffixList;
  47     UnoFilterList       m_aSubFilters;
  48
  49 public:
  50     FilterEntry( const OUString& _rTitle, const OUStringList _rFilter )
  51     : m_sTitle( _rTitle )
  52     , m_sFilterSuffixList( _rFilter )
  53     {
  54     }
  55
  56     FilterEntry( const OUString& _rTitle, const UnoFilterList& _rSubFilters );
  57
  58     OUString const & getTitle() const { return m_sTitle; }
  59     OUStringList const & getFilterSuffixList() const { return m_sFilterSuffixList; }
  60
  61     /// determines if the filter has sub filter (i.e., the filter is a filter group in real)
  62     bool        hasSubFilters( ) const;
  63
  64     /** retrieves the filters belonging to the entry
  65         @return
  66         the number of sub filters
  67         */
  68     sal_Int32       getSubFilters( UnoFilterList& _rSubFilterList );
  69
  70     // helpers for iterating the sub filters
  71     const UnoFilterEntry*   beginSubFilters() const { return m_aSubFilters.getConstArray(); }
  72     const UnoFilterEntry*   endSubFilters() const { return m_aSubFilters.getConstArray() + m_aSubFilters.getLength(); }
  73 };
  74
  75 typedef ::std::vector < FilterEntry >       FilterList;
  76
  77 class FilterHelper {
  78
  79 public:
  80     FilterHelper();
  81     virtual ~FilterHelper();
  82
  83     //XFilterManager delegates
  84     /// @throws css::lang::IllegalArgumentException
  85     /// @throws css::uno::RuntimeException
  86     void appendFilter( const OUString& aTitle, const OUString& aFilter );
  87
  88     /// @throws css::lang::IllegalArgumentException
  89     /// @throws css::uno::RuntimeException
  90     void setCurrentFilter( const OUString& aTitle );
  91
  92     /// @throws css::uno::RuntimeException
  93     OUString getCurrentFilter(  );
  94
  95     //XFilterGroupManager delegates
  96     /// @throws css::lang::IllegalArgumentException
  97     /// @throws css::uno::RuntimeException
  98     void appendFilterGroup( const OUString& sGroupTitle, const css::uno::Sequence< css::beans::StringPair >& aFilters );
  99
 100
 101     //accessor
 102     FilterList* getFilterList();
 103     NSStringList* getFilterNames();
 104
 105     //misc
 106     void SetCurFilter( const OUString& rFilter );
 107     void SetFilterAtIndex(unsigned index);
 108     OUStringList getCurrentFilterSuffixList();
 109     int getCurrentFilterIndex();
 110     void SetFilters();
 111     bool filenameMatchesFilter(NSString * sFilename);
 112
 113 private:
 114     FilterList *m_pFilterList;
 115     OUString m_aCurrentFilter;
 116     NSStringList *m_pFilterNames;
 117
 118     bool FilterNameExists( const OUString& rTitle );
 119     bool FilterNameExists( const UnoFilterList& _rGroupedFilters );
 120
 121     void ensureFilterList( const OUString& _rInitialCurrentFilter );
 122 };
 123
 124 #endif // INCLUDED_FPICKER_SOURCE_AQUA_FILTERHELPER_HXX
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */