uui/source/fltdlg.cxx

   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: fltdlg.cxx,v $
  10  * $Revision: 1.5 $
  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 //_________________________________________________________________________________________________________________
  32 //      my own includes
  33 //_________________________________________________________________________________________________________________
  34
  35 #include "fltdlg.hxx"
  36
  37 #ifndef UUI_IDS_HRC
  38 #include "ids.hrc"
  39 #endif
  40
  41 #ifndef UUI_FLTDLG_HRC
  42 #include "fltdlg.hrc"
  43 #endif
  44
  45 //_________________________________________________________________________________________________________________
  46 //      includes of other projects
  47 //_________________________________________________________________________________________________________________
  48 #include <com/sun/star/util/XStringWidth.hpp>
  49 #include <cppuhelper/implbase1.hxx>
  50 #include <unotools/localfilehelper.hxx>
  51 #include <tools/list.hxx>
  52 #include <tools/urlobj.hxx>
  53
  54 #ifndef _BUTTON_HXX //autogen
  55 #include <vcl/button.hxx>
  56 #endif
  57 #include <vos/mutex.hxx>
  58 #include <vcl/svapp.hxx>
  59
  60 namespace uui
  61 {
  62
  63 /*-************************************************************************************************************//**
  64     @short      initialize filter dialog with start values
  65     @descr      We set some neccessary informations on these instance for later working and create internal structures.
  66                 After construction user should call "SetFilters()" and "SetURL()" to fill listbox with selectable filter
  67                 names and set file name of file, which should be used for selected filter.
  68
  69     @seealso    method SetFilters()
  70     @seealso    method SetURL()
  71
  72     @param      "pParentWindow"  , parent window for dialog
  73     @param      "pResMgr"        , ressource manager
  74     @return     -
  75
  76     @onerror    -
  77     @threadsafe no
  78 *//*-*************************************************************************************************************/
  79 FilterDialog::FilterDialog( Window* pParentWindow ,
  80                             ResMgr* pResMgr       )
  81     :   ModalDialog  ( pParentWindow, ResId( DLG_FILTER_SELECT, *pResMgr ) )
  82     ,   m_ftURL      ( this, ResId( FT_URL, *pResMgr            )                   )
  83     ,   m_lbFilters  ( this, ResId( LB_FILTERS, *pResMgr        )                   )
  84     ,   m_btnOK      ( this, ResId( BTN_OK, *pResMgr            )                   )
  85     ,   m_btnCancel  ( this, ResId( BTN_CANCEL, *pResMgr        )                   )
  86     ,   m_btnHelp    ( this, ResId( BTN_HELP, *pResMgr          )                   )
  87 {
  88     FreeResource();
  89 }
  90
  91 /*-************************************************************************************************************//**
  92     @short      set file name on dialog control
  93     @descr      We convert given URL (it must be an URL!) into valid file name and show it on our dialog.
  94
  95     @seealso    -
  96
  97     @param      "sURL", URL for showing
  98     @return     -
  99
 100     @onerror    -
 101     @threadsafe no
 102 *//*-*************************************************************************************************************/
 103 void FilterDialog::SetURL( const String& sURL )
 104 {
 105     // convert it and use given pure string as fallback if convertion failed
 106     m_ftURL.SetText( impl_buildUIFileName(sURL) );
 107 }
 108
 109 /*-************************************************************************************************************//**
 110     @short      change list of filter names
 111     @descr      We save given pointer internal and use it to fill our listbox with given names.
 112                 Saved list pointer is used on method "AskForFilter()" too, to find user selected item
 113                 and return pointer into these list as result of operation.
 114                 So it's possible to call dialog again and again for different or same filter list
 115                 and ask user for his decision by best performance!
 116
 117     @attention  Don't free memory of given list after this call till object will die ... or
 118                 you call "ChangeFilters( NULL )"! Then we forget it too.
 119
 120     @seealso    method AskForFilter()
 121
 122     @param      "pFilterNames", pointer to list of filter names, which should be used for later operations.
 123     @return     -
 124
 125     @onerror    We clear list box and forget our currently set filter informations completly!
 126     @threadsafe no
 127 *//*-*************************************************************************************************************/
 128 void FilterDialog::ChangeFilters( const FilterNameList* pFilterNames )
 129 {
 130     m_pFilterNames = pFilterNames;
 131     m_lbFilters.Clear();
 132     if( m_pFilterNames != NULL )
 133     {
 134         for( FilterNameListPtr pItem  = m_pFilterNames->begin();
 135                                pItem != m_pFilterNames->end()  ;
 136                                ++pItem                         )
 137         {
 138             m_lbFilters.InsertEntry( pItem->sUI );
 139         }
 140     }
 141 }
 142
 143 /*-************************************************************************************************************//**
 144     @short      ask user for his decision
 145     @descr      We show the dialog and if user finish it with "OK" - we try to find selected item in internal saved
 146                 name list (which you must set in "ChangeFilters()"!). If we return TRUE as result, you can use out
 147                 parameter "pSelectedItem" as pointer into your FilterNameList to get selected item realy ...
 148                 but if we return FALSE ... user hsa cancel the dialog ... you shouldnt do that. pSelectedItem isnt
 149                 set to any valid value then. We don't change them ...
 150
 151     @seealso    method ChangeFilters()
 152
 153     @param      "pSelectedItem", returns result of selection as pointer into set list of filter names
 154                                  (valid for function return TRUE only!)
 155     @return     true  => pSelectedItem parameter points into name list and represent use decision
 156                 false => use has cancelled dialog (pSelectedItem isnt valid then!)
 157
 158     @onerror    We return false ... but don't change pSelectedItem!
 159     @threadsafe no
 160 *//*-*************************************************************************************************************/
 161 bool FilterDialog::AskForFilter( FilterNameListPtr& pSelectedItem )
 162 {
 163     bool bSelected = sal_False;
 164
 165     if( m_pFilterNames != NULL )
 166     {
 167         if( ModalDialog::Execute() == RET_OK )
 168         {
 169             String sEntry = m_lbFilters.GetSelectEntry();
 170             if( sEntry.Len() > 0 )
 171             {
 172                 int nPos = m_lbFilters.GetSelectEntryPos();
 173                 if( nPos < (int)(m_pFilterNames->size()) )
 174                 {
 175                     pSelectedItem  = m_pFilterNames->begin();
 176                     pSelectedItem += nPos;
 177                     bSelected      = ( pSelectedItem != m_pFilterNames->end() );
 178                 }
 179             }
 180         }
 181     }
 182
 183     return bSelected;
 184 }
 185
 186 /*-************************************************************************************************************//**
 187     @short      helper class to calculate length of given string
 188     @descr      Instances of it can be used as callback for INetURLObject::getAbbreviated() method to build
 189                 short URLs to show it on GUI. We use in ctor set OutputDevice to call special VCL method ...
 190
 191     @seealso    method OutputDevice::GetTextWidth()
 192     @seealso    method InetURLObject::getAbbreviated()
 193
 194     @param      -
 195     @return     -
 196
 197     @onerror    -
 198     @threadsafe no
 199 *//*-*************************************************************************************************************/
 200 class StringCalculator : public ::cppu::WeakImplHelper1< ::com::sun::star::util::XStringWidth >
 201 {
 202     public:
 203         StringCalculator( const OutputDevice* pDevice )
 204             : m_pDevice( pDevice )
 205         {
 206         }
 207
 208         sal_Int32 SAL_CALL queryStringWidth( const ::rtl::OUString& sString ) throw( ::com::sun::star::uno::RuntimeException )
 209         {
 210             return (sal_Int32)(m_pDevice->GetTextWidth(String(sString)));
 211         }
 212
 213     private:
 214         const OutputDevice* m_pDevice;
 215 };
 216
 217 /*-************************************************************************************************************//**
 218     @short      try to build short name of given URL to show it n GUI
 219     @descr      We detect type of given URL automaticly and build this short name depend on this type ...
 220                 If we couldnt make it right we return full given string without any changes ...
 221
 222     @seealso    class LocalFileHelper
 223     @seealso    method InetURLObject::getAbbreviated()
 224
 225     @param      "sName", file name
 226     @return     A short file name ...
 227
 228     @onerror    We return given name without any changes.
 229     @threadsafe no
 230 *//*-*************************************************************************************************************/
 231 String FilterDialog::impl_buildUIFileName( const String& sName )
 232 {
 233     String sShortName( sName );
 234
 235     if( ::utl::LocalFileHelper::ConvertURLToSystemPath( sName, sShortName ) == sal_True )
 236     {
 237         // its a system file ... build short name by using osl functionality
 238     }
 239     else
 240     {
 241         // otherwise its realy a url ... build short name by using INetURLObject
 242         ::com::sun::star::uno::Reference< ::com::sun::star::util::XStringWidth > xStringCalculator( new StringCalculator(&m_ftURL) );
 243         if( xStringCalculator.is() == sal_True )
 244         {
 245             INetURLObject aBuilder   ( sName );
 246             Size          aSize      = m_ftURL.GetOutputSize();
 247                           sShortName = aBuilder.getAbbreviated( xStringCalculator, aSize.Width(), INetURLObject::DECODE_UNAMBIGUOUS );
 248         }
 249     }
 250
 251     return sShortName;
 252 }
 253
 254 }   // namespace uui