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