svx/source/dialog/langbox.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: langbox.cxx,v $
  10  * $Revision: 1.25.132.2 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svx.hxx"
  33
  34 // include ---------------------------------------------------------------
  35
  36 #ifndef _COM_SUN_STAR_LINGUISTIC2_XLINGUSERVICEMANAGER_HDL_
  37 #include <com/sun/star/linguistic2/XLinguServiceManager.hdl>
  38 #endif
  39 #include <com/sun/star/linguistic2/XAvailableLocales.hpp>
  40 #include <com/sun/star/i18n/ScriptType.hpp>
  41 #include <linguistic/misc.hxx>
  42 #include <rtl/ustring.hxx>
  43 #include <unotools/localedatawrapper.hxx>
  44
  45 #include <svtools/langtab.hxx>
  46 #include <tools/shl.hxx>
  47 #include <i18npool/mslangid.hxx>
  48 #include <i18npool/lang.h>
  49 #include <svx/scripttypeitem.hxx>
  50 #include <unolingu.hxx>
  51 #include <svx/langbox.hxx>
  52 #include <svx/dialmgr.hxx>
  53 #include <svx/dialogs.hrc>
  54
  55 using namespace ::com::sun::star::util;
  56 using namespace ::com::sun::star::lang;
  57 using namespace ::com::sun::star::linguistic2;
  58 using namespace ::com::sun::star::uno;
  59
  60
  61 //========================================================================
  62 //      misc local helper functions
  63 //========================================================================
  64
  65
  66
  67 static Sequence< INT16 > lcl_LocaleSeqToLangSeq( Sequence< Locale > &rSeq )
  68 {
  69     const Locale *pLocale = rSeq.getConstArray();
  70     INT32 nCount = rSeq.getLength();
  71
  72     Sequence< INT16 >   aLangs( nCount );
  73     INT16 *pLang = aLangs.getArray();
  74     for (INT32 i = 0;  i < nCount;  ++i)
  75     {
  76         pLang[i] = SvxLocaleToLanguage( pLocale[i] );
  77
  78     }
  79
  80     return aLangs;
  81 }
  82
  83
  84 static BOOL lcl_SeqHasLang( const Sequence< INT16 > & rLangSeq, INT16 nLang )
  85 {
  86     INT32 i = -1;
  87     INT32 nLen = rLangSeq.getLength();
  88     if (nLen)
  89     {
  90         const INT16 *pLang = rLangSeq.getConstArray();
  91         for (i = 0;  i < nLen;  ++i)
  92         {
  93             if (nLang == pLang[i])
  94                 break;
  95         }
  96     }
  97     return i >= 0  &&  i < nLen;
  98 }
  99
 100 //========================================================================
 101 //      class SvxLanguageBox
 102 //========================================================================
 103
 104 USHORT TypeToPos_Impl( LanguageType eType, const ListBox& rLb )
 105 {
 106     USHORT      nPos   = LISTBOX_ENTRY_NOTFOUND;
 107     USHORT      nCount = rLb.GetEntryCount();
 108
 109     for ( USHORT i=0; nPos == LISTBOX_ENTRY_NOTFOUND && i<nCount; i++ )
 110         if ( eType == LanguageType((ULONG)rLb.GetEntryData(i)) )
 111             nPos = i;
 112
 113     return nPos;
 114 }
 115
 116 //-----------------------------------------------------------------------
 117 SvxLanguageBox::SvxLanguageBox( Window* pParent, WinBits nWinStyle, BOOL bCheck ) :
 118     ListBox( pParent, nWinStyle ),
 119     m_pSpellUsedLang( NULL ),
 120     m_bWithCheckmark( bCheck )
 121 {
 122     Init();
 123 }
 124 //------------------------------------------------------------------------
 125 SvxLanguageBox::SvxLanguageBox( Window* pParent, const ResId& rResId, BOOL bCheck ) :
 126     ListBox( pParent, rResId ),
 127     m_pSpellUsedLang( NULL ),
 128     m_bWithCheckmark( bCheck )
 129 {
 130     Init();
 131 }
 132 //------------------------------------------------------------------------
 133 void SvxLanguageBox::Init()
 134 {
 135     m_pLangTable = new SvtLanguageTable;
 136     m_aNotCheckedImage = Image( SVX_RES( RID_SVXIMG_NOTCHECKED ) );
 137     m_aCheckedImage = Image( SVX_RES( RID_SVXIMG_CHECKED ) );
 138     m_aCheckedImageHC = Image( SVX_RES( RID_SVXIMG_CHECKED_H ) );
 139     m_aAllString                        = String( SVX_RESSTR( RID_SVXSTR_LANGUAGE_ALL ) );
 140     m_nLangList                         = LANG_LIST_EMPTY;
 141     m_bHasLangNone                      = FALSE;
 142     m_bLangNoneIsLangAll        = FALSE;
 143
 144     // display entries sorted
 145     SetStyle( GetStyle() | WB_SORT );
 146
 147     if ( m_bWithCheckmark )
 148     {
 149         SvtLanguageTable aLangTable;
 150         sal_uInt32 nCount = aLangTable.GetEntryCount();
 151         for ( sal_uInt32 i = 0; i < nCount; i++ )
 152         {
 153             LanguageType nLangType = aLangTable.GetTypeAtIndex( i );
 154
 155             BOOL bInsert = TRUE;
 156             if ((LANGUAGE_DONTKNOW == nLangType)  ||
 157                 (LANGUAGE_SYSTEM   == nLangType)  ||
 158                 (LANGUAGE_USER1 <= nLangType  &&  nLangType <= LANGUAGE_USER9))
 159             {
 160                 bInsert = FALSE;
 161             }
 162
 163             if ( bInsert )
 164                 InsertLanguage( nLangType );
 165         }
 166         m_nLangList     = LANG_LIST_ALL;
 167     }
 168 }
 169 //------------------------------------------------------------------------
 170
 171 SvxLanguageBox::~SvxLanguageBox()
 172 {
 173     delete m_pSpellUsedLang;
 174     delete m_pLangTable;
 175 }
 176
 177 //------------------------------------------------------------------------
 178
 179 USHORT SvxLanguageBox::ImplInsertImgEntry( const String& rEntry, USHORT nPos, bool bChecked )
 180 {
 181     USHORT nRet = 0;
 182     if( !bChecked )
 183         nRet = InsertEntry( rEntry, m_aNotCheckedImage, nPos );
 184     else if( GetSettings().GetStyleSettings().GetFaceColor().IsDark() )
 185         nRet = InsertEntry( rEntry, m_aCheckedImageHC, nPos );
 186     else
 187         nRet = InsertEntry( rEntry, m_aCheckedImage, nPos );
 188     return nRet;
 189 }
 190
 191 //------------------------------------------------------------------------
 192
 193 void SvxLanguageBox::SetLanguageList( INT16 nLangList,
 194         BOOL bHasLangNone, BOOL bLangNoneIsLangAll, BOOL bCheckSpellAvail )
 195 {
 196     Clear();
 197
 198     m_nLangList                         = nLangList;
 199     m_bHasLangNone                      = bHasLangNone;
 200     m_bLangNoneIsLangAll        = bLangNoneIsLangAll;
 201     m_bWithCheckmark            = bCheckSpellAvail;
 202
 203     if ( LANG_LIST_EMPTY != nLangList )
 204     {
 205         Sequence< INT16 > aSpellAvailLang;
 206         Sequence< INT16 > aHyphAvailLang;
 207         Sequence< INT16 > aThesAvailLang;
 208         Sequence< INT16 > aSpellUsedLang;
 209         Sequence< INT16 > aHyphUsedLang;
 210         Sequence< INT16 > aThesUsedLang;
 211         Reference< XAvailableLocales > xAvail( LinguMgr::GetLngSvcMgr(), UNO_QUERY );
 212         if (xAvail.is())
 213         {
 214             Sequence< Locale > aTmp;
 215
 216             if (LANG_LIST_SPELL_AVAIL & nLangList)
 217             {
 218                 aTmp = xAvail->getAvailableLocales( A2OU( SN_SPELLCHECKER ) );
 219                 aSpellAvailLang = lcl_LocaleSeqToLangSeq( aTmp );
 220             }
 221             if (LANG_LIST_HYPH_AVAIL  & nLangList)
 222             {
 223                 aTmp = xAvail->getAvailableLocales( A2OU( SN_HYPHENATOR ) );
 224                 aHyphAvailLang = lcl_LocaleSeqToLangSeq( aTmp );
 225             }
 226             if (LANG_LIST_THES_AVAIL  & nLangList)
 227             {
 228                 aTmp = xAvail->getAvailableLocales( A2OU( SN_THESAURUS ) );
 229                 aThesAvailLang = lcl_LocaleSeqToLangSeq( aTmp );
 230             }
 231         }
 232         if (LANG_LIST_SPELL_USED & nLangList)
 233         {
 234             Reference< XSpellChecker1 > xTmp1( SvxGetSpellChecker(), UNO_QUERY );
 235             if (xTmp1.is())
 236                 aSpellUsedLang = xTmp1->getLanguages();
 237         }
 238         if (LANG_LIST_HYPH_USED  & nLangList)
 239         {
 240             Reference< XHyphenator > xTmp( SvxGetHyphenator() );
 241             if (xTmp.is()) {
 242                 Sequence < Locale > aLocaleSequence( xTmp->getLocales() );
 243                 aHyphUsedLang = lcl_LocaleSeqToLangSeq( aLocaleSequence );
 244             }
 245         }
 246         if (LANG_LIST_THES_USED  & nLangList)
 247         {
 248             Reference< XThesaurus > xTmp( SvxGetThesaurus() );
 249             if (xTmp.is()) {
 250                 Sequence < Locale > aLocaleSequence( xTmp->getLocales() );
 251                 aThesUsedLang = lcl_LocaleSeqToLangSeq( aLocaleSequence );
 252             }
 253         }
 254
 255         SvtLanguageTable aLangTable;
 256         ::com::sun::star::uno::Sequence< sal_uInt16 > xKnown;
 257         const sal_uInt16* pKnown;
 258         sal_uInt32 nCount;
 259         if ( nLangList & LANG_LIST_ONLY_KNOWN )
 260         {
 261             xKnown = LocaleDataWrapper::getInstalledLanguageTypes();
 262             pKnown = xKnown.getConstArray();
 263             nCount = xKnown.getLength();
 264         }
 265         else
 266         {
 267             nCount = aLangTable.GetEntryCount();
 268             pKnown = NULL;
 269         }
 270         for ( sal_uInt32 i = 0; i < nCount; i++ )
 271         {
 272             LanguageType nLangType;
 273             if ( nLangList & LANG_LIST_ONLY_KNOWN )
 274                 nLangType = pKnown[i];
 275             else
 276                 nLangType = aLangTable.GetTypeAtIndex( i );
 277             if ( nLangType != LANGUAGE_DONTKNOW &&
 278                  nLangType != LANGUAGE_SYSTEM &&
 279                  nLangType != LANGUAGE_NONE &&
 280                  (nLangType < LANGUAGE_USER1 || nLangType > LANGUAGE_USER9) &&
 281                  (MsLangId::getSubLanguage( nLangType) != 0 ||
 282                   (nLangList & LANG_LIST_ALSO_PRIMARY_ONLY)) &&
 283                  ((nLangList & LANG_LIST_ALL) != 0 ||
 284                   ((nLangList & LANG_LIST_WESTERN) != 0 &&
 285                    (SvtLanguageOptions::GetScriptTypeOfLanguage(nLangType) ==
 286                     SCRIPTTYPE_LATIN)) ||
 287                   ((nLangList & LANG_LIST_CTL) != 0 &&
 288                    (SvtLanguageOptions::GetScriptTypeOfLanguage(nLangType) ==
 289                     SCRIPTTYPE_COMPLEX)) ||
 290                   ((nLangList & LANG_LIST_CJK) != 0 &&
 291                    (SvtLanguageOptions::GetScriptTypeOfLanguage(nLangType) ==
 292                     SCRIPTTYPE_ASIAN)) ||
 293                   ((nLangList & LANG_LIST_FBD_CHARS) != 0 &&
 294                    MsLangId::hasForbiddenCharacters(nLangType)) ||
 295                   ((nLangList & LANG_LIST_SPELL_AVAIL) != 0 &&
 296                    lcl_SeqHasLang(aSpellAvailLang, nLangType)) ||
 297                   ((nLangList & LANG_LIST_HYPH_AVAIL) != 0 &&
 298                    lcl_SeqHasLang(aHyphAvailLang, nLangType)) ||
 299                   ((nLangList & LANG_LIST_THES_AVAIL) != 0 &&
 300                    lcl_SeqHasLang(aThesAvailLang, nLangType)) ||
 301                   ((nLangList & LANG_LIST_SPELL_USED) != 0 &&
 302                    lcl_SeqHasLang(aSpellUsedLang, nLangType)) ||
 303                   ((nLangList & LANG_LIST_HYPH_USED) != 0 &&
 304                    lcl_SeqHasLang(aHyphUsedLang, nLangType)) ||
 305                   ((nLangList & LANG_LIST_THES_USED) != 0 &&
 306                    lcl_SeqHasLang(aThesUsedLang, nLangType))) )
 307                 InsertLanguage( nLangType );
 308         }
 309
 310         if (bHasLangNone)
 311             InsertLanguage( LANGUAGE_NONE );
 312     }
 313 }
 314
 315 //------------------------------------------------------------------------
 316
 317 USHORT SvxLanguageBox::InsertLanguage( const LanguageType nLangType, USHORT nPos )
 318 {
 319     return ImplInsertLanguage( nLangType, nPos, ::com::sun::star::i18n::ScriptType::WEAK );
 320 }
 321
 322 //------------------------------------------------------------------------
 323
 324 USHORT SvxLanguageBox::ImplInsertLanguage( const LanguageType nLangType, USHORT nPos, sal_Int16 nType )
 325 {
 326     LanguageType nLang = MsLangId::getReplacementForObsoleteLanguage( nLangType);
 327     // For obsolete and to be replaced languages check whether an entry of the
 328     // replacement already exists and if so don't add an entry with identical
 329     // string as would be returned by SvtLanguageTable::GetString().
 330     if (nLang != nLangType)
 331     {
 332         USHORT nAt = TypeToPos_Impl( nLang, *this );
 333         if ( nAt != LISTBOX_ENTRY_NOTFOUND )
 334             return nAt;
 335     }
 336
 337     String aStrEntry = m_pLangTable->GetString( nLang );
 338     if (LANGUAGE_NONE == nLang && m_bHasLangNone && m_bLangNoneIsLangAll)
 339         aStrEntry = m_aAllString;
 340
 341     LanguageType nRealLang = nLang;
 342     if (nRealLang == LANGUAGE_SYSTEM)
 343     {
 344         nRealLang = MsLangId::resolveSystemLanguageByScriptType(nRealLang, nType);
 345         aStrEntry.AppendAscii(" - ");
 346         aStrEntry.Append(m_pLangTable->GetString( nRealLang ));
 347     }
 348
 349     aStrEntry = ApplyLreOrRleEmbedding( aStrEntry );
 350
 351     USHORT nAt = 0;
 352     if ( m_bWithCheckmark )
 353     {
 354         sal_Bool bFound = sal_False;
 355
 356         if (!m_pSpellUsedLang)
 357         {
 358             Reference< XSpellChecker1 > xSpell( SvxGetSpellChecker(), UNO_QUERY );
 359             if ( xSpell.is() )
 360                 m_pSpellUsedLang = new Sequence< INT16 >( xSpell->getLanguages() );
 361         }
 362         bFound = m_pSpellUsedLang ?
 363             lcl_SeqHasLang( *m_pSpellUsedLang, nRealLang ) : FALSE;
 364
 365         nAt = ImplInsertImgEntry( aStrEntry, nPos, bFound );
 366     }
 367     else
 368         nAt = InsertEntry( aStrEntry, nPos );
 369
 370     SetEntryData( nAt, (void*)(ULONG)nLangType );
 371     return nAt;
 372 }
 373
 374 //------------------------------------------------------------------------
 375
 376 USHORT SvxLanguageBox::InsertDefaultLanguage( sal_Int16 nType, USHORT nPos )
 377 {
 378     return ImplInsertLanguage( LANGUAGE_SYSTEM, nPos, nType );
 379 }
 380
 381 //------------------------------------------------------------------------
 382
 383 USHORT SvxLanguageBox::InsertLanguage( const LanguageType nLangType,
 384         BOOL bCheckEntry, USHORT nPos )
 385 {
 386     LanguageType nLang = MsLangId::getReplacementForObsoleteLanguage( nLangType);
 387     // For obsolete and to be replaced languages check whether an entry of the
 388     // replacement already exists and if so don't add an entry with identical
 389     // string as would be returned by SvtLanguageTable::GetString().
 390     if (nLang != nLangType)
 391     {
 392         USHORT nAt = TypeToPos_Impl( nLang, *this );
 393         if ( nAt != LISTBOX_ENTRY_NOTFOUND )
 394             return nAt;
 395     }
 396
 397     String aStrEntry = m_pLangTable->GetString( nLang );
 398     if (LANGUAGE_NONE == nLang && m_bHasLangNone && m_bLangNoneIsLangAll)
 399         aStrEntry = m_aAllString;
 400
 401     USHORT nAt = ImplInsertImgEntry( aStrEntry, nPos, bCheckEntry );
 402     SetEntryData( nAt, (void*)(ULONG)nLang );
 403
 404     return nAt;
 405 }
 406
 407 //------------------------------------------------------------------------
 408
 409 void SvxLanguageBox::RemoveLanguage( const LanguageType eLangType )
 410 {
 411     USHORT nAt = TypeToPos_Impl( eLangType, *this );
 412
 413     if ( nAt != LISTBOX_ENTRY_NOTFOUND )
 414         RemoveEntry( nAt );
 415 }
 416
 417 //------------------------------------------------------------------------
 418
 419 LanguageType SvxLanguageBox::GetSelectLanguage() const
 420 {
 421     USHORT               nPos   = GetSelectEntryPos();
 422
 423     if ( nPos != LISTBOX_ENTRY_NOTFOUND )
 424         return LanguageType( (ULONG)GetEntryData(nPos) );
 425     else
 426         return LanguageType( LANGUAGE_DONTKNOW );
 427 }
 428
 429 //------------------------------------------------------------------------
 430
 431 void SvxLanguageBox::SelectLanguage( const LanguageType eLangType, BOOL bSelect )
 432 {
 433     // If the core uses a LangID of an imported MS document and wants to select
 434     // a language that is replaced, we need to select the replacement instead.
 435     LanguageType nLang = MsLangId::getReplacementForObsoleteLanguage( eLangType);
 436
 437     USHORT nAt = TypeToPos_Impl( nLang, *this );
 438
 439     if ( nAt != LISTBOX_ENTRY_NOTFOUND )
 440         SelectEntryPos( nAt, bSelect );
 441 }
 442
 443 //------------------------------------------------------------------------
 444
 445 BOOL SvxLanguageBox::IsLanguageSelected( const LanguageType eLangType ) const
 446 {
 447     // Same here, work on the replacement if applicable.
 448     LanguageType nLang = MsLangId::getReplacementForObsoleteLanguage( eLangType);
 449
 450     USHORT nAt = TypeToPos_Impl( nLang, *this );
 451
 452     if ( nAt != LISTBOX_ENTRY_NOTFOUND )
 453         return IsEntryPosSelected( nAt );
 454     else
 455         return FALSE;
 456 }
 457
 458 #if ENABLE_LAYOUT
 459
 460 namespace layout
 461 {
 462
 463 SvxLanguageBox::~SvxLanguageBox ()
 464 {
 465 }
 466
 467 SvxLanguageBox::SvxLanguageBox( Context* pParent, const char* pFile, BOOL bCheck )
 468 : ListBox ( pParent, pFile, bCheck )
 469 {
 470 }
 471
 472 void SvxLanguageBox::SetLanguageList( sal_Int16/*list*/, bool/*hasLangNone*/, bool /*langNoneIsLangAll*/, bool /*checkSpellAvail*/)
 473 {
 474 }
 475
 476 sal_uInt16 SvxLanguageBox::InsertLanguage( const LanguageType/*type*/, sal_uInt16/*pos*/)
 477 {
 478     return 0;
 479 }
 480 sal_uInt16 SvxLanguageBox::InsertLanguage( const LanguageType/*type*/, bool/*checkEntry*/, sal_uInt16 /*pos*/)
 481 {
 482     return 0;
 483 }
 484 void SvxLanguageBox::RemoveLanguage( const LanguageType/*type*/)
 485 {
 486 }
 487 void SvxLanguageBox::SelectLanguage( const LanguageType/*type*/, bool/*select*/)
 488 {
 489 }
 490 LanguageType SvxLanguageBox::GetSelectLanguage() const
 491 {
 492     return 0;
 493 }
 494 bool SvxLanguageBox::IsLanguageSelected( const LanguageType/*type*/) const
 495 {
 496     return true;
 497 }
 498
 499 /*IMPL_IMPL (SvxLanguageBox, ListBox);
 500 IMPL_CONSTRUCTORS ( SvxLanguageBox, ListBox, "svxlanguagebox" );
 501 IMPL_GET_IMPL( SvxLanguageBox );
 502 IMPL_GET_WINDOW (SvxLanguageBox);*/
 503 };
 504
 505 #endif
 506