fpicker/source/aqua/ControlHelper.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_CONTROLHELPER_HXX
  21 #define INCLUDED_FPICKER_SOURCE_AQUA_CONTROLHELPER_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <com/sun/star/uno/Any.hxx>
  25
  26 #include <list>
  27 #include <map>
  28
  29 #include <premac.h>
  30 #include <Cocoa/Cocoa.h>
  31 #include <postmac.h>
  32 #include "SalAquaConstants.h"
  33 #include "FilterHelper.hxx"
  34 #include "AquaFilePickerDelegate.hxx"
  35
  36 using namespace com::sun::star;
  37
  38 class ControlHelper {
  39
  40 public:
  41
  42
  43     // Constructor / Destructor
  44
  45     ControlHelper();
  46     virtual ~ControlHelper();
  47
  48
  49     // XInitialization delegate
  50
  51     void       initialize( sal_Int16 templateId );
  52
  53
  54     // XFilePickerControlAccess function delegates
  55
  56     void       setValue( sal_Int16 nControlId, sal_Int16 nControlAction, const uno::Any& rValue );
  57     uno::Any   getValue( sal_Int16 nControlId, sal_Int16 nControlAction ) const;
  58     void       enableControl( sal_Int16 nControlId, sal_Bool bEnable ) const;
  59     OUString   getLabel( sal_Int16 nControlId );
  60     void       setLabel( sal_Int16 nControlId, NSString* aLabel );
  61
  62
  63     // other stuff
  64
  65     void       updateFilterUI();
  66
  67
  68     // Type definitions
  69
  70     enum ToggleType {
  71         AUTOEXTENSION, //but autoextension is handled differently on MacOSX
  72         PASSWORD,
  73         FILTEROPTIONS,
  74         READONLY,
  75         LINK,
  76         PREVIEW,
  77         SELECTION,
  78         TOGGLE_LAST
  79     };
  80
  81     enum ListType {
  82         VERSION,
  83         TEMPLATE,
  84         IMAGE_TEMPLATE,
  85         LIST_LAST
  86     };
  87
  88
  89     // inline functions
  90
  91     inline NSView* getUserPane() {
  92         if (m_bIsUserPaneLaidOut == false) {
  93             createUserPane();
  94         }
  95         return m_pUserPane;
  96     }
  97
  98     inline bool    getVisibility(ToggleType tToggle) {
  99         return m_bToggleVisibility[tToggle];
 100     }
 101
 102     inline void    setFilterControlNeeded(bool bNeeded) {
 103         m_bIsFilterControlNeeded = bNeeded;
 104         if (bNeeded == true) {
 105             m_bUserPaneNeeded = true;
 106         }
 107     }
 108
 109     inline void    setFilterHelper(FilterHelper* pFilterHelper) {
 110         m_pFilterHelper = pFilterHelper;
 111     }
 112
 113     inline void    setFilePickerDelegate(AquaFilePickerDelegate* pDelegate) {
 114         m_pDelegate = pDelegate;
 115     }
 116
 117     inline bool    isAutoExtensionEnabled() {
 118         return ([((NSButton*) m_pToggles[AUTOEXTENSION]) state] == NSOnState);
 119     }
 120
 121 private:
 122
 123     // private member variables
 124
 125
 126     /** the native view object */
 127     NSView*    m_pUserPane;
 128
 129     /** the checkbox controls */
 130     NSControl* m_pToggles[ TOGGLE_LAST ];
 131
 132     /** the visibility flags for the checkboxes */
 133     bool m_bToggleVisibility[TOGGLE_LAST];
 134
 135     /** the special filter control */
 136     NSPopUpButton *m_pFilterControl;
 137
 138     /** the popup menu controls (except for the filter control) */
 139     NSControl* m_pListControls[ LIST_LAST ];
 140
 141     /** a map to store a control's label text */
 142     ::std::map<NSControl *, NSString *> m_aMapListLabels;
 143
 144     /** a map to store a popup menu's label text field */
 145     ::std::map<NSPopUpButton *, NSTextField *> m_aMapListLabelFields;
 146
 147     /** the visibility flags for the popup menus */
 148     bool m_bListVisibility[ LIST_LAST ];
 149
 150     /** indicates if a user pane is needed */
 151     bool m_bUserPaneNeeded;
 152
 153     /** indicates if the user pane was laid out already */
 154     bool m_bIsUserPaneLaidOut;
 155
 156     /** indicates if a filter control is needed */
 157     bool m_bIsFilterControlNeeded;
 158
 159     /** a list with all actively used controls */
 160     ::std::list<NSControl*> m_aActiveControls;
 161
 162     /** the filter helper */
 163     FilterHelper *m_pFilterHelper;
 164
 165     /** the save or open panel's delegate */
 166     AquaFilePickerDelegate *m_pDelegate;
 167
 168
 169     // private methods
 170
 171     void HandleSetListValue(const NSControl* pControl, const sal_Int16 nControlAction, const uno::Any& rValue);
 172     uno::Any HandleGetListValue(const NSControl* pControl, const sal_Int16 nControlAction) const;
 173
 174     void         createControls();
 175     void         createFilterControl();
 176     void         createUserPane();
 177     NSTextField* createLabelWithString(NSString* label);
 178
 179     int          getControlElementName(const Class clazz, const int nControlId) const;
 180     NSControl*   getControl( const sal_Int16 nControlId ) const;
 181     static int   getVerticalDistance(const NSControl* first, const NSControl* second);
 182
 183     void         layoutControls();
 184 };
 185
 186 #endif // INCLUDED_FPICKER_SOURCE_AQUA_CONTROLHELPER_HXX
 187
 188 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */