binfilter/inc/bf_svtools/fileview.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: fileview.hxx,v $
  10  * $Revision: 1.3 $
  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 #ifndef _SVT_FILEVIEW_HXX
  31 #define _SVT_FILEVIEW_HXX
  32
  33 #ifndef INCLUDED_SVTDLLAPI_H
  34 #include "bf_svtools/svtdllapi.h"
  35 #endif
  36
  37 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_H_
  38 #include <com/sun/star/uno/Sequence.h>
  39 #endif
  40 #ifndef _COM_SUN_STAR_UCB_XCONTENT_HPP_
  41 #include <com/sun/star/ucb/XContent.hpp>
  42 #endif
  43
  44 #ifndef _SV_CTRL_HXX
  45 #include <vcl/ctrl.hxx>
  46 #endif
  47 #ifndef _SV_IMAGE_HXX
  48 #include <vcl/image.hxx>
  49 #endif
  50 #ifndef _SV_FIXED_HXX
  51 #include <vcl/fixed.hxx>
  52 #endif
  53 #ifndef _SV_BUTTON_HXX
  54 #include <vcl/button.hxx>
  55 #endif
  56 #ifndef _SV_DIALOG_HXX
  57 #include <vcl/dialog.hxx>
  58 #endif
  59
  60 namespace binfilter
  61 {
  62
  63 // class SvtFileView -----------------------------------------------------
  64
  65 #define FILEVIEW_ONLYFOLDER                     0x0001
  66 #define FILEVIEW_MULTISELECTION         0x0002
  67
  68 #define FILEVIEW_SHOW_TITLE                     0x0010
  69 #define FILEVIEW_SHOW_SIZE                      0x0020
  70 #define FILEVIEW_SHOW_DATE                      0x0040
  71 #define FILEVIEW_SHOW_ALL                       0x0070
  72
  73 class ViewTabListBox_Impl;
  74 class SvtFileView_Impl;
  75 class SvLBoxEntry;
  76 class HeaderBar;
  77 class IUrlFilter;
  78
  79 /// the result of an action in the FileView
  80 enum FileViewResult
  81 {
  82     eSuccess,
  83     eFailure,
  84     eTimeout,
  85     eStillRunning
  86 };
  87
  88 /// describes parameters for doing an action on the FileView asynchronously
  89 struct FileViewAsyncAction
  90 {
  91     sal_uInt32  nMinTimeout;    /// minimum time to wait for a result, in milliseconds
  92     sal_uInt32  nMaxTimeout;    /// maximum time to wait for a result, in milliseconds, until eTimeout is returned
  93     Link        aFinishHandler; /// the handler to be called when the action is finished. Called in every case, no matter of the result
  94
  95     FileViewAsyncAction()
  96     {
  97         nMinTimeout = nMaxTimeout = 0;
  98     }
  99 };
 100
 101 class  SvtFileView : public Control
 102 {
 103 private:
 104     SvtFileView_Impl*       mpImp;
 105
 106         void                                    OpenFolder( const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aContents );
 107
 108         DECL_LINK(                              HeaderSelect_Impl, HeaderBar * );
 109         DECL_LINK(                              HeaderEndDrag_Impl, HeaderBar * );
 110
 111 protected:
 112         virtual void GetFocus();
 113
 114 public:
 115         SvtFileView( Window* pParent, const ResId& rResId, sal_Bool bOnlyFolder, sal_Bool bMultiSelection );
 116         SvtFileView( Window* pParent, const ResId& rResId, sal_Int8 nFlags );
 117         ~SvtFileView();
 118
 119     const String&           GetViewURL() const;
 120         String                                  GetURL( SvLBoxEntry* pEntry ) const;
 121         String                                  GetCurrentURL() const;
 122
 123     sal_Bool                            GetParentURL( String& _rParentURL ) const;
 124         sal_Bool                                CreateNewFolder( const String& rNewFolder );
 125
 126         void                                    SetHelpId( sal_uInt32 nHelpId );
 127         sal_uInt32                              GetHelpId( ) const;
 128         void                                    SetSizePixel( const Size& rNewSize );
 129     using Window::SetPosSizePixel;
 130         virtual void                    SetPosSizePixel( const Point& rNewPos, const Size& rNewSize );
 131
 132     /** initialize the view with the content of a folder given by URL, and aply an immediate filter
 133
 134         @param rFolderURL
 135             the URL of the folder whose content is to be read
 136         @param rFilter
 137             the initial filter to be applied
 138         @param pAsyncDescriptor
 139             If not <NULL/>, this struct describes the parameters for doing the
 140             action asynchronously.
 141     */
 142         FileViewResult          Initialize(
 143                                 const String& rFolderURL,
 144                                 const String& rFilter,
 145                                 const FileViewAsyncAction* pAsyncDescriptor
 146                             );
 147
 148     /** initialze the view with a sequence of contents, which have already been obtained elsewhere
 149
 150         This method will never return <member>eStillRunning</member>, since it will fill the
 151         view synchronously
 152     */
 153     sal_Bool                Initialize( const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aContents );
 154
 155     /** initializes the view with the content of a folder given by an UCB content
 156     */
 157     sal_Bool                            Initialize( const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContent>& _xContent, const String& rFilter );
 158
 159     /** reads the current content of the current folder again, and applies the given filter to it
 160
 161         Note 1: The folder is really read a second time. This implies that any new elements (which were
 162         not present when you called Initialize the last time) are now displayed.
 163
 164         Note 2: This method must not be called when you previously initialized the view from a sequence
 165         of strings, or a UNO content object.
 166
 167         @param rFilter
 168             the filter to be applied
 169         @param pAsyncDescriptor
 170             If not <NULL/>, this struct describes the parameters for doing the
 171             action asynchronously.
 172     */
 173         FileViewResult          ExecuteFilter(
 174                                 const String& rFilter,
 175                                 const FileViewAsyncAction* pAsyncDescriptor
 176                             );
 177
 178     /** cancels a running async action (if any)
 179
 180         @seealso Initialize
 181         @seealso ExecuteFilter
 182         @seealso FileViewAsyncAction
 183     */
 184     void                    CancelRunningAsyncAction();
 185
 186     /** initializes the view with the parent folder of the current folder
 187
 188         @param rNewURL
 189             the URL of the folder which we just navigated to
 190         @param pAsyncDescriptor
 191             If not <NULL/>, this struct describes the parameters for doing the
 192             action asynchronously.
 193     */
 194         FileViewResult          PreviousLevel(
 195                                 const FileViewAsyncAction* pAsyncDescriptor
 196                             );
 197
 198     void                                        SetNoSelection();
 199         void                                    ResetCursor();
 200
 201         void                                    SetSelectHdl( const Link& rHdl );
 202         void                                    SetDoubleClickHdl( const Link& rHdl );
 203     void                    SetOpenDoneHdl( const Link& rHdl );
 204
 205         ULONG                           GetSelectionCount() const;
 206         SvLBoxEntry*                    FirstSelected() const;
 207         SvLBoxEntry*                    NextSelected( SvLBoxEntry* pEntry ) const;
 208         void                                    EnableAutoResize();
 209         void                                    SetFocus();
 210
 211     void                    EnableContextMenu( sal_Bool bEnable );
 212     void                    EnableDelete( sal_Bool bEnable );
 213         void                                    EnableNameReplacing( sal_Bool bEnable = sal_True );
 214                                                                 // translate folder names or display doc-title instead of file name
 215                                                                 // EnableContextMenu( TRUE )/EnableDelete(TRUE) disable name replacing!
 216
 217                                                         // save and load column size and sort order
 218         String                  GetConfigString() const;
 219         void                                    SetConfigString( const String& rCfgStr );
 220
 221     void                    SetUrlFilter( const IUrlFilter* _pFilter );
 222     const IUrlFilter*       GetUrlFilter( ) const;
 223
 224     void                    EndInplaceEditing( bool _bCancel );
 225
 226 protected:
 227     virtual void            StateChanged( StateChangedType nStateChange );
 228 };
 229
 230 // struct SvtContentEntry ------------------------------------------------
 231
 232 struct SvtContentEntry
 233 {
 234         sal_Bool        mbIsFolder;
 235         UniString       maURL;
 236
 237         SvtContentEntry( const UniString& rURL, sal_Bool bIsFolder ) :
 238                 mbIsFolder( bIsFolder ), maURL( rURL ) {}
 239 };
 240
 241 // -----------------------------------------------------------------------
 242 // QueryDeleteDlg_Impl
 243 // -----------------------------------------------------------------------
 244
 245 enum QueryDeleteResult_Impl
 246 {
 247         QUERYDELETE_YES = 0,
 248         QUERYDELETE_NO,
 249         QUERYDELETE_ALL,
 250         QUERYDELETE_CANCEL
 251 };
 252
 253 class  QueryDeleteDlg_Impl : public ModalDialog
 254 {
 255         FixedText               _aEntryLabel;
 256         FixedText               _aEntry;
 257         FixedText               _aQueryMsg;
 258
 259         PushButton              _aYesButton;
 260         PushButton              _aAllButton;
 261         PushButton              _aNoButton;
 262         CancelButton            _aCancelButton;
 263
 264     QueryDeleteResult_Impl  _eResult;
 265
 266 private:
 267
 268         DECL_DLLPRIVATE_STATIC_LINK( QueryDeleteDlg_Impl, ClickLink, PushButton* );
 269
 270 public:
 271
 272                                                         QueryDeleteDlg_Impl( Window* pParent,
 273                                                                                                  const String& rName );
 274
 275     void                    EnableAllButton() { _aAllButton.Enable( sal_True ); }
 276     QueryDeleteResult_Impl  GetResult() const { return _eResult; }
 277 };
 278
 279 }
 280
 281 #endif // _SVT_FILEVIEW_HXX
 282