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