extensions/source/propctrlr/propertyeditor.cxx

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