fpicker/source/win32/filepicker/FileOpenDlg.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: FileOpenDlg.hxx,v $
  10  * $Revision: 1.11 $
  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 _FILEOPENDLG_HXX_
  32 #define _FILEOPENDLG_HXX_
  33
  34 //------------------------------------------------------------------------
  35 // includes
  36 //------------------------------------------------------------------------
  37
  38 #include <sal/types.h>
  39
  40 #ifndef _RTL_USTRING_HXX_
  41 #include <rtl/ustring>
  42 #endif
  43 #include <rtl/ustrbuf.hxx>
  44
  45 #include "platform_xp.h"
  46 #include "getfilenamewrapper.hxx"
  47
  48 // because we don't want to import the new W2k platform skd
  49 // into our build environment if have stolen the definition
  50 // for the new OPENFILENAME structure from the new headers
  51
  52 #ifndef _CDSIZEOF_STRUCT
  53 #define _CDSIZEOF_STRUCT(structname, member)  (((int)((LPBYTE)(&((structname*)0)->member) - ((LPBYTE)((structname*)0)))) + sizeof(((structname*)0)->member))
  54 #endif
  55
  56 typedef struct _tagOFNA {
  57    DWORD        lStructSize;
  58    HWND         hwndOwner;
  59    HINSTANCE    hInstance;
  60    LPCSTR       lpstrFilter;
  61    LPSTR        lpstrCustomFilter;
  62    DWORD        nMaxCustFilter;
  63    DWORD        nFilterIndex;
  64    LPSTR        lpstrFile;
  65    DWORD        nMaxFile;
  66    LPSTR        lpstrFileTitle;
  67    DWORD        nMaxFileTitle;
  68    LPCSTR       lpstrInitialDir;
  69    LPCSTR       lpstrTitle;
  70    DWORD        Flags;
  71    WORD         nFileOffset;
  72    WORD         nFileExtension;
  73    LPCSTR       lpstrDefExt;
  74    LPARAM       lCustData;
  75    LPOFNHOOKPROC lpfnHook;
  76    LPCSTR       lpTemplateName;
  77 #ifdef _MAC
  78    LPEDITMENU   lpEditInfo;
  79    LPCSTR       lpstrPrompt;
  80 #endif
  81 #if (_WIN32_WINNT >= 0x0500)
  82    void *               pvReserved;
  83    DWORD        dwReserved;
  84    DWORD        FlagsEx;
  85 #endif // (_WIN32_WINNT >= 0x0500)
  86 } _OPENFILENAMEA, *_LPOPENFILENAMEA;
  87
  88 typedef struct _tagOFNW {
  89    DWORD        lStructSize;
  90    HWND         hwndOwner;
  91    HINSTANCE    hInstance;
  92    LPCWSTR      lpstrFilter;
  93    LPWSTR       lpstrCustomFilter;
  94    DWORD        nMaxCustFilter;
  95    DWORD        nFilterIndex;
  96    LPWSTR       lpstrFile;
  97    DWORD        nMaxFile;
  98    LPWSTR       lpstrFileTitle;
  99    DWORD        nMaxFileTitle;
 100    LPCWSTR      lpstrInitialDir;
 101    LPCWSTR      lpstrTitle;
 102    DWORD        Flags;
 103    WORD         nFileOffset;
 104    WORD         nFileExtension;
 105    LPCWSTR      lpstrDefExt;
 106    LPARAM       lCustData;
 107    LPOFNHOOKPROC lpfnHook;
 108    LPCWSTR      lpTemplateName;
 109 #if (_WIN32_WINNT >= 0x0500)
 110    void *       pvReserved;
 111    DWORD        dwReserved;
 112    DWORD        FlagsEx;
 113 #endif // (_WIN32_WINNT >= 0x0500)
 114 } _OPENFILENAMEW, *_LPOPENFILENAMEW;
 115
 116 #ifdef UNICODE
 117 typedef _OPENFILENAMEW _OPENFILENAME;
 118 typedef _LPOPENFILENAMEW _LPOPENFILENAME;
 119 #else
 120 typedef _OPENFILENAMEA _OPENFILENAME;
 121 typedef _LPOPENFILENAMEA _LPOPENFILENAME;
 122 #endif // UNICODE
 123
 124 #if (_WIN32_WINNT >= 0x0500)
 125     #define _OPENFILENAME_SIZE_VERSION_400A  _CDSIZEOF_STRUCT(_OPENFILENAMEA,lpTemplateName)
 126     #define _OPENFILENAME_SIZE_VERSION_400W  _CDSIZEOF_STRUCT(_OPENFILENAMEW,lpTemplateName)
 127     #ifdef UNICODE
 128         #define _OPENFILENAME_SIZE_VERSION_400  _OPENFILENAME_SIZE_VERSION_400W
 129     #else
 130         #define _OPENFILENAME_SIZE_VERSION_400  _OPENFILENAME_SIZE_VERSION_400A
 131     #endif // !UNICODE
 132 #else
 133     #error _WIN32_WINNT seams not to be valid.
 134 #endif // (_WIN32_WINNT >= 0x0500)
 135
 136
 137 //-------------------------------------------------------------
 138 // A simple wrapper class around the Win32 GetOpenFileName API.
 139 // This class is not thread-safe and only one instance at a
 140 // time is allowed
 141 //-------------------------------------------------------------
 142
 143 class CFileOpenDialog
 144 {
 145 public:
 146     // ctor
 147     // bFileOpenDialog idicates if we want a FileOpen or FileSave
 148     // dialog
 149     // dwFlags see OPENFILENAME
 150     // dwTemplateId - an ID for custom templates
 151     // hInstance    - an instance handle for the module
 152     // which provides the custom template, unused if dwTemplateId
 153     // is 0
 154     CFileOpenDialog(
 155         bool bFileOpenDialog = sal_True,
 156         sal_uInt32 dwFlags = OFN_HIDEREADONLY | OFN_OVERWRITEPROMPT,
 157         sal_uInt32 dwTemplateId = 0,
 158         HINSTANCE hInstance = 0);
 159
 160     virtual ~CFileOpenDialog();
 161
 162     virtual void SAL_CALL setTitle(const rtl::OUString& aTitle);
 163
 164     // to set a filter string using the M$ format
 165     // e.g. FltName\0*.txt;*.rtf\0...\0\0
 166     void SAL_CALL setFilter(const rtl::OUString& aFilter);
 167
 168     // set the index of the current filter when the
 169     // dialog is about to shown, the index starts with 1
 170     // the function succeeded if the given filter index
 171     // is greater than zero and is a valid position
 172     // within filter string that was previously set
 173     bool SAL_CALL setFilterIndex(sal_uInt32 aIndex);
 174
 175     // get the index of the currently selected filter
 176     // the index of the returned filter starts with 1
 177     sal_uInt32 SAL_CALL getSelectedFilterIndex() const;
 178
 179     // set the name and optional the path of the
 180     // file that will be initially be shown when
 181     // the dialog will be displayed
 182     virtual void SAL_CALL setDefaultName(const rtl::OUString& aName);
 183
 184     // set the initial directory
 185     virtual void SAL_CALL setDisplayDirectory(const rtl::OUString& aDirectory);
 186
 187     // returns only the path of the selected file
 188     virtual rtl::OUString SAL_CALL getLastDisplayDirectory() const;
 189
 190     // returns the full file name including drive letter, path
 191     // file name and file extension
 192     virtual rtl::OUString SAL_CALL getFullFileName() const;
 193
 194     // returns the file name and the file extension without
 195     // drive letter and path
 196     rtl::OUString SAL_CALL getFileName() const;
 197
 198     // returns the file extension of the selected file
 199     rtl::OUString SAL_CALL getFileExtension();
 200
 201     // set a default extension, only the first three letters of
 202     // the given extension will be used; the given extension
 203     // should not contain a '.'
 204     void SAL_CALL setDefaultFileExtension(const rtl::OUString& aExtension);
 205
 206     // enables or disables the multiselection mode for
 207     // the FileOpen/FileSave dialog
 208     void SAL_CALL setMultiSelectionMode(bool bMode);
 209
 210     // returns whether multi-selection mode is enabled or not
 211     bool SAL_CALL getMultiSelectionMode() const;
 212
 213     // shows the dialog, calls preModal before
 214     // showing the dialog and postModal after
 215     // showing the dialog
 216     // the method returns:
 217     //  0 - when the dialog was canceled by the user
 218     //  1 - when the dialog was closed with ok
 219     // -1 - when an error occured
 220     sal_Int16 SAL_CALL doModal();
 221
 222     // returns the last dialog error that occured
 223     sal_uInt32 SAL_CALL getLastDialogError() const;
 224
 225     // retrievs the currently selected file
 226     // including path and drive information
 227     // can be called only if the dialog is
 228     // already displayed
 229     rtl::OUString SAL_CALL getCurrentFilePath() const;
 230
 231     // retrievs the currently selected folder
 232     rtl::OUString SAL_CALL getCurrentFolderPath() const;
 233
 234     // retrievs the currently selected file name
 235     // without drive and path
 236     rtl::OUString SAL_CALL getCurrentFileName() const;
 237
 238 protected:
 239     // have to be overwritten when subclasses
 240     // want to do special pre- and post-modal
 241     // processing
 242
 243     // if preModal return true processing will
 244     // continue else doModal exit without showing
 245     // a dialog and returns -1
 246     virtual bool SAL_CALL preModal();
 247
 248     // post modal processing
 249     // the function should accept only values returned from
 250     // doModal and act appropriately
 251     virtual void SAL_CALL postModal(sal_Int16 nDialogResult);
 252
 253     // message handler, to be overwritten by subclasses
 254     virtual sal_uInt32 SAL_CALL onShareViolation(const rtl::OUString& aPathName);
 255     virtual sal_uInt32 SAL_CALL onFileOk();
 256     virtual void SAL_CALL onSelChanged(HWND hwndListBox);
 257     virtual void SAL_CALL onHelp();
 258
 259     // only called back if OFN_EXPLORER is set
 260     virtual void SAL_CALL onInitDone();
 261     virtual void SAL_CALL onFolderChanged();
 262     virtual void SAL_CALL onTypeChanged(sal_uInt32 nFilterIndex);
 263
 264     virtual void SAL_CALL onInitDialog(HWND hwndDlg) = 0;
 265
 266     virtual sal_uInt32 SAL_CALL onCtrlCommand(HWND hwndDlg, sal_uInt16 ctrlId, sal_uInt16 notifyCode);
 267
 268     sal_uInt32 SAL_CALL onWMNotify(HWND hwndChild, LPOFNOTIFYW lpOfNotify);
 269
 270     // we use non-virtual functions to do necessary work before
 271     // calling the virtual funtions (see Gamma: Template method)
 272     void SAL_CALL handleInitDialog(HWND hwndDlg, HWND hwndChild);
 273
 274 protected:
 275
 276     // handle to the window of the
 277     // FileOpen/FileSave dialog
 278     // will be set on message
 279     // WM_INITDIALOG, before this
 280     // value is undefined
 281     HWND        m_hwndFileOpenDlg;
 282     HWND        m_hwndFileOpenDlgChild;
 283
 284     _OPENFILENAME       m_ofn;
 285
 286     // we connect the instance with the dialog window using
 287     // SetProp, with this function we can reconnect from
 288     // callback functions to this instance
 289     static CFileOpenDialog* SAL_CALL getCurrentInstance(HWND hwnd);
 290
 291     void SAL_CALL centerPositionToParent() const;
 292
 293 private:
 294     // FileOpen or FileSaveDialog
 295     bool                        m_bFileOpenDialog;
 296     rtl::OUString       m_dialogTitle;
 297     rtl::OUString       m_displayDirectory;
 298     rtl::OUString       m_defaultExtension;
 299
 300     mutable     rtl::OUStringBuffer m_filterBuffer;
 301     mutable     rtl::OUStringBuffer m_fileTitleBuffer;
 302     mutable rtl::OUStringBuffer m_helperBuffer;
 303     mutable rtl::OUStringBuffer m_fileNameBuffer;
 304
 305     CGetFileNameWrapper m_GetFileNameWrapper;
 306
 307     WNDPROC                     m_pfnBaseDlgProc;
 308
 309     // callback function
 310     static unsigned int CALLBACK ofnHookProc(
 311         HWND hChildDlg, // handle to child dialog box
 312         unsigned int uiMsg,     // message identifier
 313         WPARAM wParam,  // message parameter
 314         LPARAM lParam   // message parameter
 315     );
 316
 317     // we have to subclass the dialog in order
 318     // to clean up the window property we are
 319     // using to connect the window with a class
 320     // instance in WM_NCDESTROY
 321     static LRESULT CALLBACK BaseDlgProc(
 322         HWND hWnd, UINT wMessage, WPARAM wParam, LPARAM lParam );
 323
 324 private:
 325     // avoid copy and assignment
 326     CFileOpenDialog(const CFileOpenDialog&);
 327     CFileOpenDialog& operator=(const CFileOpenDialog&);
 328 };
 329
 330 #endif