extensions/source/propctrlr/propertyeditor.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: propertyeditor.cxx,v $
  10  * $Revision: 1.22 $
  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_extensions.hxx"
  33 #include "propertyeditor.hxx"
  34 #include "browserpage.hxx"
  35 #include "linedescriptor.hxx"
  36
  37 /** === begin UNO includes === **/
  38 /** === end UNO includes === **/
  39 #include <tools/debug.hxx>
  40
  41 //............................................................................
  42 namespace pcr
  43 {
  44 //............................................................................
  45
  46     #define LAYOUT_BORDER_LEFT      3
  47     #define LAYOUT_BORDER_TOP       3
  48     #define LAYOUT_BORDER_RIGHT     3
  49     #define LAYOUT_BORDER_BOTTOM    3
  50
  51     /** === begin UNO using === **/
  52     using ::com::sun::star::uno::Any;
  53     using ::com::sun::star::inspection::XPropertyControl;
  54     using ::com::sun::star::uno::Reference;
  55     /** === end UNO using === **/
  56
  57     //==================================================================
  58     // class OPropertyEditor
  59     //==================================================================
  60     DBG_NAME(OPropertyEditor)
  61     //------------------------------------------------------------------
  62     OPropertyEditor::OPropertyEditor( Window* pParent, WinBits nWinStyle)
  63             :Control(pParent, nWinStyle)
  64             ,m_aTabControl( this )
  65             ,m_nNextId(1)
  66             ,m_bHasHelpSection( false )
  67             ,m_nMinHelpLines( 0 )
  68             ,m_nMaxHelpLines( 0 )
  69     {
  70         DBG_CTOR(OPropertyEditor,NULL);
  71
  72         m_aTabControl.Show();
  73         m_aTabControl.SetDeactivatePageHdl(LINK(this, OPropertyEditor, OnPageDeactivate));
  74         m_aTabControl.SetActivatePageHdl(LINK(this, OPropertyEditor, OnPageActivate));
  75         m_aTabControl.SetBackground(GetBackground());
  76         m_aTabControl.SetPaintTransparent(sal_True);
  77     }
  78
  79     //------------------------------------------------------------------
  80     OPropertyEditor::~OPropertyEditor()
  81     {
  82         Hide();
  83         ClearAll();
  84         DBG_DTOR(OPropertyEditor,NULL);
  85     }
  86
  87     //------------------------------------------------------------------
  88     void OPropertyEditor::ClearAll()
  89     {
  90         m_nNextId=1;
  91         sal_uInt16 nCount = m_aTabControl.GetPageCount();
  92         for(long i = nCount-1; i >= 0; --i)
  93         {
  94             sal_uInt16 nID = m_aTabControl.GetPageId((sal_uInt16)i);
  95             OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
  96             if (pPage)
  97             {
  98                 pPage->EnableInput(sal_False);
  99                 m_aTabControl.RemovePage(nID);
 100                 delete pPage;
 101             }
 102         }
 103         m_aTabControl.Clear();
 104
 105         {
 106             MapStringToPageId aEmpty;
 107             m_aPropertyPageIds.swap( aEmpty );
 108         }
 109
 110         while ( !m_aHiddenPages.empty() )
 111         {
 112             delete m_aHiddenPages.begin()->second.pPage;
 113             m_aHiddenPages.erase( m_aHiddenPages.begin() );
 114         }
 115     }
 116
 117     //------------------------------------------------------------------
 118     sal_Int32 OPropertyEditor::getMinimumHeight()
 119     {
 120         sal_Int32 nMinHeight( LAYOUT_BORDER_TOP + LAYOUT_BORDER_BOTTOM );
 121
 122         if ( m_aTabControl.GetPageCount() > 0 )
 123         {
 124             sal_uInt16 nFirstID = m_aTabControl.GetPageId( 0 );
 125
 126             // reserve space for the tabs themself
 127             Rectangle aTabArea( m_aTabControl.GetTabBounds( nFirstID ) );
 128             nMinHeight += aTabArea.GetHeight();
 129
 130             // ask the page how much it requires
 131             OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nFirstID ) );
 132             if ( pPage )
 133                 nMinHeight += pPage->getMinimumHeight();
 134         }
 135         else
 136             nMinHeight += 250;  // arbitrary ...
 137
 138         return nMinHeight;
 139     }
 140
 141     //------------------------------------------------------------------
 142     sal_Int32 OPropertyEditor::getMinimumWidth()
 143     {
 144         sal_uInt16 nCount = m_aTabControl.GetPageCount();
 145         sal_Int32 nPageMinWidth = 0;
 146         for(long i = nCount-1; i >= 0; --i)
 147         {
 148             sal_uInt16 nID = m_aTabControl.GetPageId((sal_uInt16)i);
 149             OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
 150             if (pPage)
 151             {
 152                 sal_Int32 nCurPageMinWidth = pPage->getMinimumWidth();
 153                 if( nCurPageMinWidth > nPageMinWidth )
 154                     nPageMinWidth = nCurPageMinWidth;
 155             }
 156         }
 157         return nPageMinWidth+6;
 158     }
 159
 160     //------------------------------------------------------------------
 161     void OPropertyEditor::CommitModified()
 162     {
 163         // commit all of my pages, if necessary
 164
 165         sal_uInt16 nCount = m_aTabControl.GetPageCount();
 166         for ( sal_uInt16 i=0; i<nCount; ++i )
 167         {
 168             sal_uInt16 nID = m_aTabControl.GetPageId( i );
 169             OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nID ) );
 170
 171             if ( pPage && pPage->getListBox().IsModified() )
 172                 pPage->getListBox().CommitModified();
 173         }
 174     }
 175
 176     //------------------------------------------------------------------
 177     void OPropertyEditor::GetFocus()
 178     {
 179         m_aTabControl.GrabFocus();
 180     }
 181
 182     //------------------------------------------------------------------
 183     OBrowserPage* OPropertyEditor::getPage( const ::rtl::OUString& _rPropertyName )
 184     {
 185         OBrowserPage* pPage = NULL;
 186         MapStringToPageId::const_iterator aPropertyPageIdPos = m_aPropertyPageIds.find( _rPropertyName );
 187         if ( aPropertyPageIdPos != m_aPropertyPageIds.end() )
 188             pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( aPropertyPageIdPos->second ) );
 189         return pPage;
 190     }
 191
 192     //------------------------------------------------------------------
 193     const OBrowserPage* OPropertyEditor::getPage( const ::rtl::OUString& _rPropertyName ) const
 194     {
 195         return const_cast< OPropertyEditor* >( this )->getPage( _rPropertyName );
 196     }
 197
 198     //------------------------------------------------------------------
 199     OBrowserPage* OPropertyEditor::getPage( sal_uInt16& _rPageId )
 200     {
 201         return static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( _rPageId ) );
 202     }
 203
 204     //------------------------------------------------------------------
 205     const OBrowserPage* OPropertyEditor::getPage( sal_uInt16& _rPageId ) const
 206     {
 207         return const_cast< OPropertyEditor* >( this )->getPage( _rPageId );
 208     }
 209
 210     //------------------------------------------------------------------
 211     void OPropertyEditor::Resize()
 212     {
 213         Rectangle aPlayground(
 214             Point( LAYOUT_BORDER_LEFT, LAYOUT_BORDER_TOP ),
 215             Size(
 216                 GetOutputSizePixel().Width() - LAYOUT_BORDER_LEFT - LAYOUT_BORDER_RIGHT,
 217                 GetOutputSizePixel().Height() - LAYOUT_BORDER_TOP - LAYOUT_BORDER_BOTTOM
 218             )
 219         );
 220
 221         Rectangle aTabArea( aPlayground );
 222         m_aTabControl.SetPosSizePixel( aTabArea.TopLeft(), aTabArea.GetSize() );
 223     }
 224
 225     //------------------------------------------------------------------
 226     sal_uInt16 OPropertyEditor::AppendPage( const String & _rText, const SmartId& _rHelpId )
 227     {
 228         // obtain a new id
 229         sal_uInt16 nId = m_nNextId++;
 230         // insert the id
 231         m_aTabControl.InsertPage(nId, _rText);
 232
 233         // create a new page
 234         OBrowserPage* pPage = new OBrowserPage(&m_aTabControl);
 235         pPage->SetText( _rText );
 236         // some knittings
 237         pPage->SetSizePixel(m_aTabControl.GetTabPageSizePixel());
 238         pPage->getListBox().SetListener(m_pListener);
 239         pPage->getListBox().SetObserver(m_pObserver);
 240         pPage->getListBox().EnableHelpSection( m_bHasHelpSection );
 241         pPage->getListBox().SetHelpLineLimites( m_nMinHelpLines, m_nMaxHelpLines );
 242         pPage->SetSmartHelpId( _rHelpId );
 243
 244         // immediately activate the page
 245         m_aTabControl.SetTabPage(nId, pPage);
 246         m_aTabControl.SetCurPageId(nId);
 247
 248         return nId;
 249     }
 250
 251     //------------------------------------------------------------------
 252     void OPropertyEditor::SetHelpId( sal_uInt32 nHelpId )
 253     {
 254         Control::SetHelpId(0);
 255         m_aTabControl.SetHelpId(nHelpId);
 256     }
 257
 258     //------------------------------------------------------------------
 259     void OPropertyEditor::RemovePage(sal_uInt16 nID)
 260     {
 261         OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
 262
 263         if (pPage)
 264             pPage->EnableInput(sal_False);
 265         m_aTabControl.RemovePage(nID);
 266         if (pPage)
 267             delete pPage;
 268     }
 269
 270     //------------------------------------------------------------------
 271     void OPropertyEditor::SetPage(sal_uInt16 nId)
 272     {
 273         m_aTabControl.SetCurPageId(nId);
 274     }
 275
 276     //------------------------------------------------------------------
 277     sal_uInt16 OPropertyEditor::GetCurPage()
 278     {
 279         if(m_aTabControl.GetPageCount()>0)
 280             return m_aTabControl.GetCurPageId();
 281         else
 282             return 0;
 283     }
 284
 285     //------------------------------------------------------------------
 286     void OPropertyEditor::Update(const ::std::mem_fun_t<void,OBrowserListBox>& _aUpdateFunction)
 287     {
 288         // forward this to all our pages
 289         sal_uInt16 nCount = m_aTabControl.GetPageCount();
 290         for (sal_uInt16 i=0;i<nCount;++i)
 291         {
 292             sal_uInt16 nID = m_aTabControl.GetPageId(i);
 293             OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
 294             if (pPage)
 295                 _aUpdateFunction(&pPage->getListBox());
 296         }
 297     }
 298     //------------------------------------------------------------------
 299     void OPropertyEditor::EnableUpdate()
 300     {
 301         Update(::std::mem_fun(&OBrowserListBox::EnableUpdate));
 302     }
 303     //------------------------------------------------------------------
 304     void OPropertyEditor::DisableUpdate()
 305     {
 306         Update(::std::mem_fun(&OBrowserListBox::DisableUpdate));
 307     }
 308
 309     //------------------------------------------------------------------
 310     void OPropertyEditor::forEachPage( PageOperation _pOperation, const void* _pArgument )
 311     {
 312         sal_uInt16 nCount = m_aTabControl.GetPageCount();
 313         for ( sal_uInt16 i=0; i<nCount; ++i )
 314         {
 315             sal_uInt16 nID = m_aTabControl.GetPageId(i);
 316             OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nID ) );
 317             if ( !pPage )
 318                 continue;
 319             (this->*_pOperation)( *pPage, _pArgument );
 320         }
 321     }
 322
 323     //------------------------------------------------------------------
 324     void OPropertyEditor::setPageLineListener( OBrowserPage& _rPage, const void* )
 325     {
 326         _rPage.getListBox().SetListener( m_pListener );
 327     }
 328
 329     //------------------------------------------------------------------
 330     void OPropertyEditor::SetLineListener(IPropertyLineListener* _pListener)
 331     {
 332         m_pListener = _pListener;
 333         forEachPage( &OPropertyEditor::setPageLineListener );
 334     }
 335
 336     //------------------------------------------------------------------
 337     void OPropertyEditor::setPageControlObserver( OBrowserPage& _rPage, const void* )
 338     {
 339         _rPage.getListBox().SetObserver( m_pObserver );
 340     }
 341
 342     //------------------------------------------------------------------
 343     void OPropertyEditor::SetControlObserver( IPropertyControlObserver* _pObserver )
 344     {
 345         m_pObserver = _pObserver;
 346         forEachPage( &OPropertyEditor::setPageControlObserver );
 347     }
 348
 349     //------------------------------------------------------------------
 350     void OPropertyEditor::EnableHelpSection( bool _bEnable )
 351     {
 352         m_bHasHelpSection = _bEnable;
 353         forEachPage( &OPropertyEditor::enableHelpSection );
 354     }
 355
 356     //------------------------------------------------------------------
 357     bool OPropertyEditor::HasHelpSection() const
 358     {
 359         return m_bHasHelpSection;
 360     }
 361
 362     //------------------------------------------------------------------
 363     void OPropertyEditor::SetHelpText( const ::rtl::OUString& _rHelpText )
 364     {
 365         forEachPage( &OPropertyEditor::setHelpSectionText, &_rHelpText );
 366     }
 367
 368     //------------------------------------------------------------------
 369     void OPropertyEditor::SetHelpLineLimites( sal_Int32 _nMinLines, sal_Int32 _nMaxLines )
 370     {
 371         m_nMinHelpLines = _nMinLines;
 372         m_nMaxHelpLines = _nMaxLines;
 373         forEachPage( &OPropertyEditor::setHelpLineLimits );
 374     }
 375
 376     //------------------------------------------------------------------
 377     void OPropertyEditor::enableHelpSection( OBrowserPage& _rPage, const void* )
 378     {
 379         _rPage.getListBox().EnableHelpSection( m_bHasHelpSection );
 380     }
 381
 382     //------------------------------------------------------------------
 383     void OPropertyEditor::setHelpSectionText( OBrowserPage& _rPage, const void* _pPointerToOUString )
 384     {
 385         OSL_ENSURE( _pPointerToOUString, "OPropertyEditor::setHelpSectionText: invalid argument!" );
 386         if ( !_pPointerToOUString )
 387             return;
 388
 389         const ::rtl::OUString& rText( *(const ::rtl::OUString*)_pPointerToOUString );
 390         _rPage.getListBox().SetHelpText( rText );
 391     }
 392
 393     //------------------------------------------------------------------
 394     void OPropertyEditor::setHelpLineLimits( OBrowserPage& _rPage, const void* )
 395     {
 396         _rPage.getListBox().SetHelpLineLimites( m_nMinHelpLines, m_nMaxHelpLines );
 397     }
 398
 399     //------------------------------------------------------------------
 400     sal_uInt16 OPropertyEditor::InsertEntry( const OLineDescriptor& rData, sal_uInt16 _nPageId, sal_uInt16 nPos )
 401     {
 402         // let the current page handle this
 403         OBrowserPage* pPage = getPage( _nPageId );
 404         DBG_ASSERT( pPage, "OPropertyEditor::InsertEntry: don't have such a page!" );
 405         if ( !pPage )
 406             return LISTBOX_ENTRY_NOTFOUND;
 407
 408         sal_uInt16 nEntry = pPage->getListBox().InsertEntry( rData, nPos );
 409
 410         OSL_ENSURE( m_aPropertyPageIds.find( rData.sName ) == m_aPropertyPageIds.end(),
 411             "OPropertyEditor::InsertEntry: property already present in the map!" );
 412         m_aPropertyPageIds.insert( MapStringToPageId::value_type( rData.sName, _nPageId ) );
 413
 414         return nEntry;
 415     }
 416
 417     //------------------------------------------------------------------
 418     void OPropertyEditor::RemoveEntry( const ::rtl::OUString& _rName )
 419     {
 420         OBrowserPage* pPage = getPage( _rName );
 421         if ( pPage )
 422         {
 423             OSL_VERIFY( pPage->getListBox().RemoveEntry( _rName ) );
 424
 425             OSL_ENSURE( m_aPropertyPageIds.find( _rName ) != m_aPropertyPageIds.end(),
 426                 "OPropertyEditor::RemoveEntry: property not present in the map!" );
 427             m_aPropertyPageIds.erase( _rName );
 428         }
 429     }
 430
 431     //------------------------------------------------------------------
 432     void OPropertyEditor::ChangeEntry( const OLineDescriptor& rData )
 433     {
 434         OBrowserPage* pPage = getPage( rData.sName );
 435         if ( pPage )
 436             pPage->getListBox().ChangeEntry( rData, EDITOR_LIST_REPLACE_EXISTING );
 437     }
 438
 439     //------------------------------------------------------------------
 440     void OPropertyEditor::SetPropertyValue( const ::rtl::OUString& rEntryName, const Any& _rValue, bool _bUnknownValue )
 441     {
 442         OBrowserPage* pPage = getPage( rEntryName );
 443         if ( pPage )
 444             pPage->getListBox().SetPropertyValue( rEntryName, _rValue, _bUnknownValue );
 445     }
 446
 447     //------------------------------------------------------------------
 448     sal_uInt16 OPropertyEditor::GetPropertyPos( const ::rtl::OUString& rEntryName ) const
 449     {
 450         sal_uInt16 nVal=LISTBOX_ENTRY_NOTFOUND;
 451         const OBrowserPage* pPage = getPage( rEntryName );
 452         if ( pPage )
 453             nVal = pPage->getListBox().GetPropertyPos( rEntryName );
 454         return nVal;
 455     }
 456
 457     //------------------------------------------------------------------
 458     void OPropertyEditor::ShowPropertyPage( sal_uInt16 _nPageId, bool _bShow )
 459     {
 460         if ( !_bShow )
 461         {
 462             sal_uInt16 nPagePos = m_aTabControl.GetPagePos( _nPageId );
 463             if ( TAB_PAGE_NOTFOUND == nPagePos )
 464                 return;
 465             DBG_ASSERT( m_aHiddenPages.find( _nPageId ) == m_aHiddenPages.end(), "OPropertyEditor::ShowPropertyPage: page already hidden!" );
 466
 467             m_aHiddenPages[ _nPageId ] = HiddenPage( nPagePos, m_aTabControl.GetTabPage( _nPageId ) );
 468             m_aTabControl.RemovePage( _nPageId );
 469         }
 470         else
 471         {
 472             ::std::map< sal_uInt16, HiddenPage >::iterator aPagePos = m_aHiddenPages.find( _nPageId );
 473             if ( aPagePos == m_aHiddenPages.end() )
 474                 return;
 475
 476             aPagePos->second.pPage->SetSizePixel( m_aTabControl.GetTabPageSizePixel() );
 477             m_aTabControl.InsertPage( aPagePos->first, aPagePos->second.pPage->GetText(), aPagePos->second.nPos );
 478             m_aTabControl.SetTabPage( aPagePos->first, aPagePos->second.pPage );
 479
 480             m_aHiddenPages.erase( aPagePos );
 481         }
 482     }
 483
 484     //------------------------------------------------------------------
 485     void OPropertyEditor::EnablePropertyControls( const ::rtl::OUString& _rEntryName, sal_Int16 _nControls, bool _bEnable )
 486     {
 487         for ( USHORT i = 0; i < m_aTabControl.GetPageCount(); ++i )
 488         {
 489             OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( m_aTabControl.GetPageId( i ) ) );
 490             if ( pPage )
 491                 pPage->getListBox().EnablePropertyControls( _rEntryName, _nControls, _bEnable );
 492         }
 493     }
 494
 495     //------------------------------------------------------------------
 496     void OPropertyEditor::EnablePropertyLine( const ::rtl::OUString& _rEntryName, bool _bEnable )
 497     {
 498         for ( USHORT i = 0; i < m_aTabControl.GetPageCount(); ++i )
 499         {
 500             OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( m_aTabControl.GetPageId( i ) ) );
 501             if ( pPage )
 502                 pPage->getListBox().EnablePropertyLine( _rEntryName, _bEnable );
 503         }
 504     }
 505
 506     //------------------------------------------------------------------
 507     Reference< XPropertyControl > OPropertyEditor::GetPropertyControl(const ::rtl::OUString& rEntryName)
 508     {
 509         Reference< XPropertyControl > xControl;
 510         // let the current page handle this
 511         OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(m_aTabControl.GetCurPageId()));
 512         if (pPage)
 513             xControl = pPage->getListBox().GetPropertyControl(rEntryName);
 514         return xControl;
 515     }
 516
 517     //------------------------------------------------------------------
 518     IMPL_LINK(OPropertyEditor, OnPageActivate, TabControl*, EMPTYARG)
 519     {
 520         if (m_aPageActivationHandler.IsSet())
 521             m_aPageActivationHandler.Call(NULL);
 522         return 0L;
 523     }
 524
 525     //------------------------------------------------------------------
 526     IMPL_LINK(OPropertyEditor, OnPageDeactivate, TabControl*, EMPTYARG)
 527     {
 528         // commit the data on the current (to-be-decativated) tab page
 529         // (79404)
 530         sal_Int32 nCurrentId = m_aTabControl.GetCurPageId();
 531         OBrowserPage* pCurrentPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage((sal_uInt16)nCurrentId));
 532         if ( !pCurrentPage )
 533             return 1L;
 534
 535         if ( pCurrentPage->getListBox().IsModified() )
 536             pCurrentPage->getListBox().CommitModified();
 537
 538         return 1L;
 539     }
 540
 541 //............................................................................
 542 } // namespace pcr
 543 //............................................................................
 544
 545