office-gobmx/uui/source/fltdlg.cxx

329 lines
13 KiB
C++

/*************************************************************************
*
* $RCSfile: fltdlg.cxx,v $
*
* $Revision: 1.1 $
*
* last change: $Author: as $ $Date: 2001-11-08 12:05:13 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#ifndef UUI_FLTDLG_HXX
#include "fltdlg.hxx"
#endif
#ifndef UUI_IDS_HRC
#include "ids.hrc"
#endif
#ifndef UUI_FLTDLG_HRC
#include "fltdlg.hrc"
#endif
//_________________________________________________________________________________________________________________
// includes of other projects
//_________________________________________________________________________________________________________________
#ifndef _COM_SUN_STAR_UTIL_XSTRINGWIDTH_HPP_
#include <com/sun/star/util/XStringWidth.hpp>
#endif
#ifndef _CPPUHELPER_IMPLBASE1_HXX_
#include <cppuhelper/implbase1.hxx>
#endif
#ifndef _UNOTOOLS_LOCALFILEHELPER_HXX
#include <unotools/localfilehelper.hxx>
#endif
#ifndef _LIST_HXX //autogen
#include <tools/list.hxx>
#endif
#ifndef _URLOBJ_HXX //autogen
#include <tools/urlobj.hxx>
#endif
#ifndef _BUTTON_HXX //autogen
#include <vcl/button.hxx>
#endif
#ifndef _VOS_MUTEX_HXX_
#include <vos/mutex.hxx>
#endif
#ifndef _SV_SVAPP_HXX
#include <vcl/svapp.hxx>
#endif
#pragma hdrstop
namespace uui
{
/*-************************************************************************************************************//**
@short initialize filter dialog with start values
@descr We set some neccessary informations on these instance for later working and create internal structures.
After construction user should call "SetFilters()" and "SetURL()" to fill listbox with selectable filter
names and set file name of file, which should be used for selected filter.
@seealso method SetFilters()
@seealso method SetURL()
@param "pParentWindow" , parent window for dialog
@param "pResMgr" , ressource manager
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
FilterDialog::FilterDialog( Window* pParentWindow ,
ResMgr* pResMgr )
: ModalDialog ( pParentWindow, ResId( DLG_FILTER_SELECT, pResMgr ) )
, m_ftURL ( this, ResId( FT_URL ) )
, m_lbFilters ( this, ResId( LB_FILTERS ) )
, m_btnOK ( this, ResId( BTN_OK ) )
, m_btnCancel ( this, ResId( BTN_CANCEL ) )
, m_btnHelp ( this, ResId( BTN_HELP ) )
{
FreeResource();
}
/*-************************************************************************************************************//**
@short set file name on dialog control
@descr We convert given URL (it must be an URL!) into valid file name and show it on our dialog.
@seealso -
@param "sURL", URL for showing
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
void FilterDialog::SetURL( const String& sURL )
{
// convert it and use given pure string as fallback if convertion failed
m_ftURL.SetText( impl_buildUIFileName(sURL) );
}
/*-************************************************************************************************************//**
@short change list of filter names
@descr We save given pointer internal and use it to fill our listbox with given names.
Saved list pointer is used on method "AskForFilter()" too, to find user selected item
and return pointer into these list as result of operation.
So it's possible to call dialog again and again for different or same filter list
and ask user for his decision by best performance!
@attention Don't free memory of given list after this call till object will die ... or
you call "ChangeFilters( NULL )"! Then we forget it too.
@seealso method AskForFilter()
@param "pFilterNames", pointer to list of filter names, which should be used for later operations.
@return -
@onerror We clear list box and forget our currently set filter informations completly!
@threadsafe no
*//*-*************************************************************************************************************/
void FilterDialog::ChangeFilters( const FilterNameList* pFilterNames )
{
m_pFilterNames = pFilterNames;
m_lbFilters.Clear();
if( m_pFilterNames != NULL )
{
for( FilterNameListPtr pItem = m_pFilterNames->begin();
pItem != m_pFilterNames->end() ;
++pItem )
{
m_lbFilters.InsertEntry( pItem->sUI );
}
}
}
/*-************************************************************************************************************//**
@short ask user for his decision
@descr We show the dialog and if user finish it with "OK" - we try to find selected item in internal saved
name list (which you must set in "ChangeFilters()"!). If we return TRUE as result, you can use out
parameter "pSelectedItem" as pointer into your FilterNameList to get selected item realy ...
but if we return FALSE ... user hsa cancel the dialog ... you shouldnt do that. pSelectedItem isnt
set to any valid value then. We don't change them ...
@seealso method ChangeFilters()
@param "pSelectedItem", returns result of selection as pointer into set list of filter names
(valid for function return TRUE only!)
@return true => pSelectedItem parameter points into name list and represent use decision
false => use has cancelled dialog (pSelectedItem isnt valid then!)
@onerror We return false ... but don't change pSelectedItem!
@threadsafe no
*//*-*************************************************************************************************************/
bool FilterDialog::AskForFilter( FilterNameListPtr& pSelectedItem )
{
bool bSelected = sal_False;
if( m_pFilterNames != NULL )
{
if( ModalDialog::Execute() == RET_OK )
{
String sEntry = m_lbFilters.GetSelectEntry();
if( sEntry.Len() > 0 )
{
int nPos = m_lbFilters.GetSelectEntryPos();
if( nPos < (int)(m_pFilterNames->size()) )
{
pSelectedItem = m_pFilterNames->begin();
pSelectedItem += nPos;
bSelected = ( pSelectedItem != m_pFilterNames->end() );
}
}
}
}
return bSelected;
}
/*-************************************************************************************************************//**
@short handler function for OK button
@descr These method is called, if user press OK button. We end the dialog then.
@seealso -
@param -
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
IMPL_LINK_INLINE_START( FilterDialog, OKHandler, Control*, pControl )
{
EndDialog(RET_OK);
return 0;
}
IMPL_LINK_INLINE_END( FilterDialog, OKHandler, Control*, pControl )
/*-************************************************************************************************************//**
@short helper class to calculate length of given string
@descr Instances of it can be used as callback for INetURLObject::getAbbreviated() method to build
short URLs to show it on GUI. We use in ctor set OutputDevice to call special VCL method ...
@seealso method OutputDevice::GetTextWidth()
@seealso method InetURLObject::getAbbreviated()
@param -
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
class StringCalculator : public ::cppu::WeakImplHelper1< ::com::sun::star::util::XStringWidth >
{
public:
StringCalculator( const OutputDevice* pDevice )
: m_pDevice( pDevice )
{
}
sal_Int32 SAL_CALL queryStringWidth( const ::rtl::OUString& sString ) throw( ::com::sun::star::uno::RuntimeException )
{
return (sal_Int32)(m_pDevice->GetTextWidth(String(sString)));
}
private:
const OutputDevice* m_pDevice;
};
/*-************************************************************************************************************//**
@short try to build short name of given URL to show it n GUI
@descr We detect type of given URL automaticly and build this short name depend on this type ...
If we couldnt make it right we return full given string without any changes ...
@seealso class LocalFileHelper
@seealso method InetURLObject::getAbbreviated()
@param "sName", file name
@return A short file name ...
@onerror We return given name without any changes.
@threadsafe no
*//*-*************************************************************************************************************/
String FilterDialog::impl_buildUIFileName( const String& sName )
{
String sShortName( sName );
if( ::utl::LocalFileHelper::ConvertURLToSystemPath( sName, sShortName ) == sal_True )
{
// its a system file ... build short name by using osl functionality
}
else
{
// otherwise its realy a url ... build short name by using INetURLObject
::com::sun::star::uno::Reference< ::com::sun::star::util::XStringWidth > xStringCalculator( new StringCalculator(&m_ftURL) );
if( xStringCalculator.is() == sal_True )
{
INetURLObject aBuilder ( sName );
Size aSize = m_ftURL.GetOutputSize();
sShortName = aBuilder.getAbbreviated( xStringCalculator, aSize.Width(), INetURLObject::DECODE_UNAMBIGUOUS );
}
}
return sShortName;
}
} // namespace uui