extensions/source/propctrlr/propertyeditor.cxx

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