mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
afd3ab436bf920ef80c642891e9e63133fca41a0
libreoffice/sfx2/source/dialog/tabdlg.cxx
Noel Grandin afd3ab436b loplugin:constantparam in sfx2 
Change-Id: I9a5a9fd1f4f43e0b7ef13d14979cb231f6aa9d46
Reviewed-on: https://gerrit.libreoffice.org/23801
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noelgrandin@gmail.com>
2016-04-04 13:41:15 +00:00

1343 lines
37 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <limits.h>
#include <stdlib.h>
#include <algorithm>
#include <vcl/builder.hxx>
#include <vcl/msgbox.hxx>
#include <unotools/viewoptions.hxx>
#include "appdata.hxx"
#include "sfxtypes.hxx"
#include <sfx2/tabdlg.hxx>
#include <sfx2/viewfrm.hxx>
#include <sfx2/app.hxx>
#include <sfx2/sfxresid.hxx>
#include <sfx2/sfxhelp.hxx>
#include <sfx2/ctrlitem.hxx>
#include <sfx2/bindings.hxx>
#include <sfx2/sfxdlg.hxx>
#include <sfx2/itemconnect.hxx>
#include "dialog.hrc"
#include "helpid.hrc"
using namespace ::com::sun::star::uno;
#define USERITEM_NAME "UserItem"
struct TabPageImpl
{
bool mbStandard;
sfx::ItemConnectionArray maItemConn;
css::uno::Reference< css::frame::XFrame > mxFrame;
TabPageImpl() : mbStandard( false ) {}
};
struct Data_Impl
{
sal_uInt16 nId; // The ID
CreateTabPage fnCreatePage; // Pointer to Factory
GetTabPageRanges fnGetRanges; // Pointer to Ranges-Function
VclPtr<SfxTabPage> pTabPage; // The TabPage itself
bool bOnDemand; // Flag: ItemSet onDemand
bool bRefresh; // Flag: Page must be re-initialized
// Constructor
Data_Impl( sal_uInt16 Id, CreateTabPage fnPage,
GetTabPageRanges fnRanges, bool bDemand ) :
nId ( Id ),
fnCreatePage( fnPage ),
fnGetRanges ( fnRanges ),
pTabPage ( nullptr ),
bOnDemand ( bDemand ),
bRefresh ( false )
{
if ( !fnCreatePage )
{
SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create();
if ( pFact )
{
fnCreatePage = pFact->GetTabPageCreatorFunc( nId );
fnGetRanges = pFact->GetTabPageRangesFunc( nId );
}
}
}
};
SfxTabDialogItem::SfxTabDialogItem( const SfxTabDialogItem& rAttr, SfxItemPool* pItemPool )
: SfxSetItem( rAttr, pItemPool )
{
}
SfxTabDialogItem::SfxTabDialogItem( sal_uInt16 nId, const SfxItemSet& rItemSet )
: SfxSetItem( nId, rItemSet )
{
}
SfxPoolItem* SfxTabDialogItem::Clone(SfxItemPool* pToPool) const
{
return new SfxTabDialogItem( *this, pToPool );
}
SfxPoolItem* SfxTabDialogItem::Create(SvStream& /*rStream*/, sal_uInt16 /*nVersion*/) const
{
OSL_FAIL( "Use it only in UI!" );
return nullptr;
}
typedef std::vector<Data_Impl*> SfxTabDlgData_Impl;
struct TabDlg_Impl
{
bool bModified : 1,
bModal : 1,
bHideResetBtn : 1;
SfxTabDlgData_Impl aData;
explicit TabDlg_Impl( sal_uInt8 nCnt ) :
bModified ( false ),
bModal ( true ),
bHideResetBtn ( false )
{
aData.reserve( nCnt );
}
~TabDlg_Impl()
{
}
};
static Data_Impl* Find( const SfxTabDlgData_Impl& rArr, sal_uInt16 nId, sal_uInt16* pPos = nullptr)
{
const sal_uInt16 nCount = rArr.size();
for ( sal_uInt16 i = 0; i < nCount; ++i )
{
Data_Impl* pObj = rArr[i];
if ( pObj->nId == nId )
{
if ( pPos )
*pPos = i;
return pObj;
}
}
return nullptr;
}
void SfxTabPage::SetFrame(const css::uno::Reference< css::frame::XFrame >& xFrame)
{
if (pImpl)
pImpl->mxFrame = xFrame;
}
css::uno::Reference< css::frame::XFrame > SfxTabPage::GetFrame()
{
if (pImpl)
return pImpl->mxFrame;
return css::uno::Reference< css::frame::XFrame >();
}
SfxTabPage::SfxTabPage(vcl::Window *pParent, const OString& rID, const OUString& rUIXMLDescription, const SfxItemSet *rAttrSet)
: TabPage(pParent, rID, rUIXMLDescription)
, pSet ( rAttrSet )
, bHasExchangeSupport ( false )
, pImpl ( new TabPageImpl )
{
}
SfxTabPage::~SfxTabPage()
{
disposeOnce();
}
void SfxTabPage::dispose()
{
delete pImpl;
pImpl = nullptr;
TabPage::dispose();
}
bool SfxTabPage::FillItemSet( SfxItemSet* rSet )
{
return pImpl->maItemConn.DoFillItemSet( *rSet, GetItemSet() );
}
void SfxTabPage::Reset( const SfxItemSet* rSet )
{
pImpl->maItemConn.DoApplyFlags( rSet );
pImpl->maItemConn.DoReset( rSet );
}
void SfxTabPage::ActivatePage( const SfxItemSet& )
/* [Description]
Default implementation of the virtual ActivatePage method. This method is
called when a page of dialogue supports the exchange of data between pages.
<SfxTabPage::DeactivatePage(SfxItemSet *)>
*/
{
}
SfxTabPage::sfxpg SfxTabPage::DeactivatePage( SfxItemSet* )
/* [Description]
Default implementation of the virtual DeactivatePage method. This method is
called by Sfx when leaving a page; the application can, through the return
value, control whether to leave the page. If the page is displayed through
bHasExchangeSupport which supports data exchange between pages, then a
pointer to the exchange set is passed as parameter. This takes on data for
the exchange, then the set is available as a parameter in
<SfxTabPage::ActivatePage(const SfxItemSet &)>.
[Return value]
LEAVE_PAGE; Allow leaving the page
*/
{
return LEAVE_PAGE;
}
void SfxTabPage::FillUserData()
/* [Description]
Virtual method is called by the base class in the destructor to save
specific information of the TabPage in the ini-file. When overriding a
string must be compiled, which is then flushed with the <SetUserData()>.
*/
{
}
bool SfxTabPage::IsReadOnly() const
{
return false;
}
const SfxPoolItem* SfxTabPage::GetItem( const SfxItemSet& rSet, sal_uInt16 nSlot, bool bDeep )
/* [Description]
static Method: hereby are the implementations of the TabPage code
being simplified.
*/
{
const SfxItemPool* pPool = rSet.GetPool();
sal_uInt16 nWh = pPool->GetWhich( nSlot, bDeep );
const SfxPoolItem* pItem = nullptr;
rSet.GetItemState( nWh, true, &pItem );
if ( !pItem && nWh != nSlot )
pItem = &pPool->GetDefaultItem( nWh );
return pItem;
}
const SfxPoolItem* SfxTabPage::GetOldItem( const SfxItemSet& rSet,
sal_uInt16 nSlot, bool bDeep )
/* [Description]
This method returns an attribute for comparison of the old value.
*/
{
const SfxItemSet& rOldSet = GetItemSet();
sal_uInt16 nWh = GetWhich( nSlot, bDeep );
const SfxPoolItem* pItem = nullptr;
if ( pImpl->mbStandard && rOldSet.GetParent() )
pItem = GetItem( *rOldSet.GetParent(), nSlot );
else if ( rSet.GetParent() &&
SfxItemState::DONTCARE == rSet.GetItemState( nWh ) )
pItem = GetItem( *rSet.GetParent(), nSlot );
else
pItem = GetItem( rOldSet, nSlot );
return pItem;
}
void SfxTabPage::PageCreated( const SfxAllItemSet& /*aSet*/ )
{
DBG_ASSERT(false, "SfxTabPage::PageCreated should not be called");
}
void SfxTabPage::ChangesApplied()
{
}
void SfxTabPage::AddItemConnection( sfx::ItemConnectionBase* pConnection )
{
pImpl->maItemConn.AddConnection( pConnection );
}
SfxTabDialog* SfxTabPage::GetTabDialog() const
{
return dynamic_cast<SfxTabDialog*>(GetParentDialog());
}
SfxTabDialog::SfxTabDialog
/* [Description]
Constructor, temporary without Frame
*/
(
vcl::Window* pParent, // Parent Window
const OUString& rID, const OUString& rUIXMLDescription, //Dialog Name, Dialog .ui path
const SfxItemSet* pItemSet, // Itemset with the data;
// can be NULL, when Pages are onDemand
bool bEditFmt // when yes -> additional Button for standard
)
: TabDialog(pParent, rID, rUIXMLDescription)
, pSet(pItemSet ? new SfxItemSet(*pItemSet) : nullptr)
, pOutSet(nullptr)
, pRanges(nullptr)
, nAppPageId(USHRT_MAX)
, bItemsReset(false)
, bStandardPushed(false)
, pExampleSet(nullptr)
{
Init_Impl(bEditFmt);
}
SfxTabDialog::~SfxTabDialog()
{
disposeOnce();
}
void SfxTabDialog::dispose()
{
SavePosAndId();
for ( SfxTabDlgData_Impl::const_iterator it = pImpl->aData.begin(); it != pImpl->aData.end(); ++it )
{
Data_Impl* pDataObject = *it;
if ( pDataObject->pTabPage )
{
// save settings of all pages (user data)
pDataObject->pTabPage->FillUserData();
OUString aPageData( pDataObject->pTabPage->GetUserData() );
if ( !aPageData.isEmpty() )
{
// save settings of all pages (user data)
OUString sConfigId = OStringToOUString(pDataObject->pTabPage->GetConfigId(),
RTL_TEXTENCODING_UTF8);
if (sConfigId.isEmpty())
{
SAL_WARN("sfx.config", "Tabpage needs to be converted to .ui format");
sConfigId = OUString::number(pDataObject->nId);
}
SvtViewOptions aPageOpt(E_TABPAGE, sConfigId);
aPageOpt.SetUserItem( USERITEM_NAME, makeAny( OUString( aPageData ) ) );
}
if ( pDataObject->bOnDemand )
delete &pDataObject->pTabPage->GetItemSet();
pDataObject->pTabPage.disposeAndClear();
}
delete pDataObject;
pDataObject = nullptr;
}
delete pImpl;
pImpl = nullptr;
delete pSet;
pSet = nullptr;
delete pOutSet;
pOutSet = nullptr;
delete pExampleSet;
pExampleSet = nullptr;
delete [] pRanges;
pRanges = nullptr;
if (m_bOwnsBaseFmtBtn)
m_pBaseFmtBtn.disposeAndClear();
if (m_bOwnsResetBtn)
m_pResetBtn.disposeAndClear();
if (m_bOwnsHelpBtn)
m_pHelpBtn.disposeAndClear();
if (m_bOwnsCancelBtn)
m_pCancelBtn.disposeAndClear();
if (m_bOwnsOKBtn)
m_pOKBtn.disposeAndClear();
m_pBox.clear();
m_pTabCtrl.clear();
m_pOKBtn.clear();
m_pApplyBtn.clear();
m_pUserBtn.clear();
m_pCancelBtn.clear();
m_pHelpBtn.clear();
m_pResetBtn.clear();
m_pBaseFmtBtn.clear();
m_pActionArea.clear();
TabDialog::dispose();
}
void SfxTabDialog::Init_Impl(bool bFmtFlag)
/* [Description]
internal initialization of the dialogue
*/
{
m_pBox = get_content_area();
assert(m_pBox);
m_pUIBuilder->get(m_pTabCtrl, "tabcontrol");
pImpl = new TabDlg_Impl(m_pTabCtrl->GetPageCount());
m_pActionArea = get_action_area();
assert(m_pActionArea);
m_pOKBtn = m_pUIBuilder->get<PushButton>("ok");
m_bOwnsOKBtn = m_pOKBtn == nullptr;
if (m_bOwnsOKBtn)
m_pOKBtn = VclPtr<OKButton>::Create(m_pActionArea);
m_pApplyBtn = m_pUIBuilder->get<PushButton>("apply");
m_pUserBtn = m_pUIBuilder->get<PushButton>("user");
m_pCancelBtn = m_pUIBuilder->get<CancelButton>("cancel");
m_bOwnsCancelBtn = m_pCancelBtn == nullptr;
if (m_bOwnsCancelBtn)
m_pCancelBtn = VclPtr<CancelButton>::Create(m_pActionArea);
m_pHelpBtn = m_pUIBuilder->get<HelpButton>("help");
m_bOwnsHelpBtn = m_pHelpBtn == nullptr;
if (m_bOwnsHelpBtn)
m_pHelpBtn = VclPtr<HelpButton>::Create(m_pActionArea);
m_pResetBtn = m_pUIBuilder->get<PushButton>("reset");
m_bOwnsResetBtn = m_pResetBtn == nullptr;
if (m_bOwnsResetBtn)
m_pResetBtn = VclPtr<PushButton>::Create(m_pActionArea.get());
else
pImpl->bHideResetBtn = !m_pResetBtn->IsVisible();
m_pBaseFmtBtn = m_pUIBuilder->get<PushButton>("standard");
m_bOwnsBaseFmtBtn = m_pBaseFmtBtn == nullptr;
if (m_bOwnsBaseFmtBtn)
m_pBaseFmtBtn = VclPtr<PushButton>::Create(m_pActionArea.get());
m_pOKBtn->SetClickHdl( LINK( this, SfxTabDialog, OkHdl ) );
m_pCancelBtn->SetClickHdl( LINK( this, SfxTabDialog, CancelHdl ) );
m_pResetBtn->SetClickHdl( LINK( this, SfxTabDialog, ResetHdl ) );
m_pResetBtn->SetText( SfxResId( STR_RESET ).toString() );
m_pTabCtrl->SetActivatePageHdl(
LINK( this, SfxTabDialog, ActivatePageHdl ) );
m_pTabCtrl->SetDeactivatePageHdl(
LINK( this, SfxTabDialog, DeactivatePageHdl ) );
m_pActionArea->Show();
m_pBox->Show();
m_pTabCtrl->Show();
m_pOKBtn->Show();
m_pCancelBtn->Show();
m_pHelpBtn->Show();
m_pResetBtn->Show();
m_pResetBtn->SetHelpId( HID_TABDLG_RESET_BTN );
if ( m_pUserBtn )
{
m_pUserBtn->SetClickHdl( LINK( this, SfxTabDialog, UserHdl ) );
m_pUserBtn->Show();
}
if ( bFmtFlag )
{
m_pBaseFmtBtn->SetText( SfxResId( STR_STANDARD_SHORTCUT ).toString() );
m_pBaseFmtBtn->SetClickHdl( LINK( this, SfxTabDialog, BaseFmtHdl ) );
m_pBaseFmtBtn->SetHelpId( HID_TABDLG_STANDARD_BTN );
m_pBaseFmtBtn->Show();
}
if ( pSet )
{
pExampleSet = new SfxItemSet( *pSet );
pOutSet = new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() );
}
}
void SfxTabDialog::RemoveResetButton()
{
m_pResetBtn->Hide();
pImpl->bHideResetBtn = true;
}
void SfxTabDialog::RemoveStandardButton()
{
m_pBaseFmtBtn->Hide();
}
short SfxTabDialog::Execute()
{
if ( !m_pTabCtrl->GetPageCount() )
return RET_CANCEL;
Start_Impl();
return TabDialog::Execute();
}
void SfxTabDialog::StartExecuteModal( const Link<Dialog&,void>& rEndDialogHdl )
{
if ( !m_pTabCtrl->GetPageCount() )
return;
Start_Impl();
TabDialog::StartExecuteModal( rEndDialogHdl );
}
void SfxTabDialog::Start()
{
pImpl->bModal = false;
Start_Impl();
Show();
if ( IsVisible() && ( !HasChildPathFocus() || HasFocus() ) )
GrabFocusToFirstControl();
}
void SfxTabDialog::SetApplyHandler(const Link<Button*, void>& _rHdl)
{
DBG_ASSERT( m_pApplyBtn, "SfxTabDialog::GetApplyHandler: no apply button enabled!" );
if ( m_pApplyBtn )
m_pApplyBtn->SetClickHdl( _rHdl );
}
void SfxTabDialog::Start_Impl()
{
assert(pImpl->aData.size() == m_pTabCtrl->GetPageCount()
&& "not all pages registered");
sal_uInt16 nActPage = m_pTabCtrl->GetPageId( 0 );
// load old settings, when exists
SvtViewOptions aDlgOpt(E_TABDIALOG, OStringToOUString(GetHelpId(),RTL_TEXTENCODING_UTF8));
if ( aDlgOpt.Exists() )
{
SetWindowState(OUStringToOString(aDlgOpt.GetWindowState().getStr(), RTL_TEXTENCODING_ASCII_US));
// initial TabPage from Program/Help/config
nActPage = (sal_uInt16)aDlgOpt.GetPageID();
if ( USHRT_MAX != nAppPageId )
nActPage = nAppPageId;
else
{
sal_uInt16 nAutoTabPageId = SfxGetpApp()->Get_Impl()->nAutoTabPageId;
if ( nAutoTabPageId )
nActPage = nAutoTabPageId;
}
if ( TAB_PAGE_NOTFOUND == m_pTabCtrl->GetPagePos( nActPage ) )
nActPage = m_pTabCtrl->GetPageId( 0 );
}
else if ( USHRT_MAX != nAppPageId && TAB_PAGE_NOTFOUND != m_pTabCtrl->GetPagePos( nAppPageId ) )
nActPage = nAppPageId;
m_pTabCtrl->SetCurPageId( nActPage );
ActivatePageHdl( m_pTabCtrl );
}
void SfxTabDialog::AddTabPage( sal_uInt16 nId, const OUString &rRiderText )
{
AddTabPage( nId, rRiderText, nullptr, nullptr );
}
/*
Adds a page to the dialog. The Name must correspond to a entry in the
TabControl in the dialog .ui
*/
sal_uInt16 SfxTabDialog::AddTabPage
(
const OString &rName, // Page ID
CreateTabPage pCreateFunc, // Pointer to the Factory Method
GetTabPageRanges pRangesFunc // Pointer to the Method for quering
// Ranges onDemand
)
{
sal_uInt16 nId = m_pTabCtrl->GetPageId(rName);
pImpl->aData.push_back(
new Data_Impl( nId, pCreateFunc, pRangesFunc, false/*bItemsOnDemand*/ ) );
return nId;
}
/*
Adds a page to the dialog. The Name must correspond to a entry in the
TabControl in the dialog .ui
*/
sal_uInt16 SfxTabDialog::AddTabPage
(
const OString &rName, // Page ID
sal_uInt16 nPageCreateId // Identifier of the Factory Method to create the page
)
{
SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create();
assert(pFact);
CreateTabPage pCreateFunc = pFact->GetTabPageCreatorFunc(nPageCreateId);
assert(pCreateFunc);
GetTabPageRanges pRangesFunc = pFact->GetTabPageRangesFunc(nPageCreateId);
sal_uInt16 nPageId = m_pTabCtrl->GetPageId(rName);
pImpl->aData.push_back(new Data_Impl(nPageId, pCreateFunc, pRangesFunc, false));
return nPageId;
}
void SfxTabDialog::AddTabPage
/* [Description]
Add a page to the dialog. The Rider text is passed on, the page has no
counterpart in the TabControl in the resource of the dialogue.
*/
(
sal_uInt16 nId,
const OUString& rRiderText,
CreateTabPage pCreateFunc,
GetTabPageRanges pRangesFunc,
sal_uInt16 nPos
)
{
DBG_ASSERT( TAB_PAGE_NOTFOUND == m_pTabCtrl->GetPagePos( nId ),
"Double Page-Ids in the Tabpage" );
m_pTabCtrl->InsertPage( nId, rRiderText, nPos );
pImpl->aData.push_back(
new Data_Impl( nId, pCreateFunc, pRangesFunc, false/*bItemsOnDemand*/ ) );
}
void SfxTabDialog::RemoveTabPage( sal_uInt16 nId )
/* [Description]
Delete the TabPage with ID nId
*/
{
sal_uInt16 nPos = 0;
m_pTabCtrl->RemovePage( nId );
Data_Impl* pDataObject = Find( pImpl->aData, nId, &nPos );
if ( pDataObject )
{
if ( pDataObject->pTabPage )
{
pDataObject->pTabPage->FillUserData();
OUString aPageData( pDataObject->pTabPage->GetUserData() );
if ( !aPageData.isEmpty() )
{
// save settings of this page (user data)
OUString sConfigId = OStringToOUString(pDataObject->pTabPage->GetConfigId(),
RTL_TEXTENCODING_UTF8);
if (sConfigId.isEmpty())
{
SAL_WARN("sfx.config", "Tabpage needs to be converted to .ui format");
sConfigId = OUString::number(pDataObject->nId);
}
SvtViewOptions aPageOpt(E_TABPAGE, sConfigId);
aPageOpt.SetUserItem( USERITEM_NAME, makeAny( OUString( aPageData ) ) );
}
if ( pDataObject->bOnDemand )
delete &pDataObject->pTabPage->GetItemSet();
pDataObject->pTabPage.disposeAndClear();
}
delete pDataObject;
pImpl->aData.erase( pImpl->aData.begin() + nPos );
}
else
{
SAL_INFO( "sfx.dialog", "TabPage-Id not known" );
}
}
void SfxTabDialog::RemoveTabPage(const OString &rName)
{
RemoveTabPage(m_pTabCtrl->GetPageId(rName));
}
void SfxTabDialog::PageCreated
/* [Description]
Default implementation of the virtual method. This is called immediately
after creating a page. Here the dialogue can call the TabPage Method
directly.
*/
(
sal_uInt16, // Id of the created page
SfxTabPage& // Reference to the created page
)
{
}
SfxItemSet* SfxTabDialog::GetInputSetImpl()
/* [Description]
Derived classes may create new storage for the InputSet. This has to be
released in the Destructor. To do this, this method must be called.
*/
{
return pSet;
}
SfxTabPage* SfxTabDialog::GetTabPage( sal_uInt16 nPageId ) const
/* [Description]
Return TabPage with the specified Id.
*/
{
sal_uInt16 nPos = 0;
Data_Impl* pDataObject = Find( pImpl->aData, nPageId, &nPos );
if ( pDataObject )
return pDataObject->pTabPage;
return nullptr;
}
void SfxTabDialog::SavePosAndId()
{
// save settings (screen position and current page)
SvtViewOptions aDlgOpt(E_TABDIALOG, OStringToOUString(GetHelpId(),RTL_TEXTENCODING_UTF8));
aDlgOpt.SetWindowState(OStringToOUString(GetWindowState(WINDOWSTATE_MASK_POS),RTL_TEXTENCODING_ASCII_US));
// to-do replace with name of page when all pages are converted to .ui
aDlgOpt.SetPageID( m_pTabCtrl->GetCurPageId() );
}
short SfxTabDialog::Ok()
/* [Description]
Ok handler for the Dialogue.
Dialog's current location and current page are saved for the next time
the dialog is shown.
The OutputSet is created and for each page this or the special OutputSet
is set by calling the method <SfxTabPage::FillItemSet(SfxItemSet &)>, to
insert the entered data by the user into the set.
[Return value]
RET_OK: if at least one page has returned from FillItemSet,
otherwise RET_CANCEL.
*/
{
SavePosAndId(); //See fdo#38828 "Apply" resetting window position
if ( !pOutSet )
{
if ( !pExampleSet && pSet )
pOutSet = pSet->Clone( false ); // without Items
else if ( pExampleSet )
pOutSet = new SfxItemSet( *pExampleSet );
}
bool bModified = false;
for ( SfxTabDlgData_Impl::const_iterator it = pImpl->aData.begin(); it != pImpl->aData.end(); ++it )
{
Data_Impl* pDataObject = *it;
SfxTabPage* pTabPage = pDataObject->pTabPage;
if ( pTabPage )
{
if ( pDataObject->bOnDemand )
{
SfxItemSet& rSet = (SfxItemSet&)pTabPage->GetItemSet();
rSet.ClearItem();
bModified |= pTabPage->FillItemSet( &rSet );
}
else if ( pSet && !pTabPage->HasExchangeSupport() )
{
SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
if ( pTabPage->FillItemSet( &aTmp ) )
{
bModified = true;
if (pExampleSet)
pExampleSet->Put( aTmp );
pOutSet->Put( aTmp );
}
}
}
}
if ( pImpl->bModified || ( pOutSet && pOutSet->Count() > 0 ) )
bModified = true;
if (bStandardPushed)
bModified = true;
return bModified ? RET_OK : RET_CANCEL;
}
IMPL_LINK_NOARG_TYPED(SfxTabDialog, CancelHdl, Button*, void)
{
EndDialog( RET_USER_CANCEL );
}
SfxItemSet* SfxTabDialog::CreateInputItemSet( sal_uInt16 )
/* [Description]
Default implementation of the virtual Method.
This is called when pages create their sets onDemand.
*/
{
SAL_WARN( "sfx.dialog", "CreateInputItemSet not implemented" );
return new SfxAllItemSet( SfxGetpApp()->GetPool() );
}
void SfxTabDialog::RefreshInputSet()
/* [Description]
Default implementation of the virtual Method.
This is called, when <SfxTabPage::DeactivatePage(SfxItemSet *)>
returns <SfxTabPage::REFRESH_SET>.
*/
{
SAL_INFO ( "sfx.dialog", "RefreshInputSet not implemented" );
}
IMPL_LINK_NOARG_TYPED(SfxTabDialog, OkHdl, Button*, void)
/* [Description]
Handler of the Ok-Buttons
This calls the current page <SfxTabPage::DeactivatePage(SfxItemSet *)>.
Returns <SfxTabPage::LEAVE_PAGE>, <SfxTabDialog::Ok()> is called
and the Dialog is ended.
*/
{
if (PrepareLeaveCurrentPage())
{
if ( pImpl->bModal )
EndDialog( Ok() );
else
{
Ok();
Close();
}
}
}
bool SfxTabDialog::Apply()
{
bool bApplied = false;
if (PrepareLeaveCurrentPage())
{
bApplied = (Ok() == RET_OK);
//let the pages update their saved values
GetInputSetImpl()->Put(*GetOutputItemSet());
sal_uInt16 pageCount = m_pTabCtrl->GetPageCount();
for (sal_uInt16 pageIdx = 0; pageIdx < pageCount; ++pageIdx)
{
SfxTabPage* pPage = dynamic_cast<SfxTabPage*> (m_pTabCtrl->GetTabPage(m_pTabCtrl->GetPageId(pageIdx)));
if (pPage)
pPage->ChangesApplied();
}
}
return bApplied;
}
bool SfxTabDialog::PrepareLeaveCurrentPage()
{
sal_uInt16 const nId = m_pTabCtrl->GetCurPageId();
SfxTabPage* pPage = dynamic_cast<SfxTabPage*> (m_pTabCtrl->GetTabPage( nId ));
bool bEnd = !pPage;
if ( pPage )
{
int nRet = SfxTabPage::LEAVE_PAGE;
if ( pSet )
{
SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
if ( pPage->HasExchangeSupport() )
nRet = pPage->DeactivatePage( &aTmp );
else
nRet = pPage->DeactivatePage( nullptr );
if ( ( SfxTabPage::LEAVE_PAGE & nRet ) == SfxTabPage::LEAVE_PAGE
&& aTmp.Count() )
{
pExampleSet->Put( aTmp );
pOutSet->Put( aTmp );
}
}
else
nRet = pPage->DeactivatePage( nullptr );
bEnd = nRet;
}
return bEnd;
}
IMPL_LINK_NOARG_TYPED(SfxTabDialog, UserHdl, Button*, void)
/* [Description]
Handler of the User-Buttons
This calls the current page <SfxTabPage::DeactivatePage(SfxItemSet *)>.
returns this <SfxTabPage::LEAVE_PAGE> and <SfxTabDialog::Ok()> is called.
Then the Dialog is ended with the Return value <SfxTabDialog::Ok()>
*/
{
if ( PrepareLeaveCurrentPage () )
{
short nRet = Ok();
if ( RET_OK == nRet )
nRet = RET_USER;
else
nRet = RET_USER_CANCEL;
EndDialog( nRet );
}
}
IMPL_LINK_NOARG_TYPED(SfxTabDialog, ResetHdl, Button*, void)
/* [Description]
Handler behind the reset button.
The Current Page is new initialized with their initial data, all the
settings that the user has made on this page are repealed.
*/
{
const sal_uInt16 nId = m_pTabCtrl->GetCurPageId();
Data_Impl* pDataObject = Find( pImpl->aData, nId );
DBG_ASSERT( pDataObject, "Id not known" );
if ( pDataObject->bOnDemand )
{
// CSet on AIS has problems here, thus separated
const SfxItemSet* pItemSet = &pDataObject->pTabPage->GetItemSet();
pDataObject->pTabPage->Reset( pItemSet );
}
else
pDataObject->pTabPage->Reset( pSet );
}
IMPL_LINK_NOARG_TYPED(SfxTabDialog, BaseFmtHdl, Button*, void)
/* [Description]
Handler behind the Standard-Button.
This button is available when editing style sheets. All the set attributes
in the edited stylesheet are deleted.
*/
{
bStandardPushed = true;
const sal_uInt16 nId = m_pTabCtrl->GetCurPageId();
Data_Impl* pDataObject = Find( pImpl->aData, nId );
DBG_ASSERT( pDataObject, "Id not known" );
if ( pDataObject->fnGetRanges )
{
if ( !pExampleSet )
pExampleSet = new SfxItemSet( *pSet );
const SfxItemPool* pPool = pSet->GetPool();
const sal_uInt16* pTmpRanges = (pDataObject->fnGetRanges)();
SfxItemSet aTmpSet( *pExampleSet );
while ( *pTmpRanges )
{
const sal_uInt16* pU = pTmpRanges + 1;
if ( *pTmpRanges == *pU )
{
// Range which two identical values -> only set one Item
sal_uInt16 nWh = pPool->GetWhich( *pTmpRanges );
pExampleSet->ClearItem( nWh );
aTmpSet.ClearItem( nWh );
// At the Outset of InvalidateItem,
// so that the change takes effect
pOutSet->InvalidateItem( nWh );
}
else
{
// Correct Range with multiple values
sal_uInt16 nTmp = *pTmpRanges, nTmpEnd = *pU;
DBG_ASSERT( nTmp <= nTmpEnd, "Range is sorted the wrong way" );
if ( nTmp > nTmpEnd )
{
// If really sorted wrongly, then set new
sal_uInt16 nTmp1 = nTmp;
nTmp = nTmpEnd;
nTmpEnd = nTmp1;
}
while ( nTmp <= nTmpEnd )
{
// Iterate over the Range and set the Items
sal_uInt16 nWh = pPool->GetWhich( nTmp );
pExampleSet->ClearItem( nWh );
aTmpSet.ClearItem( nWh );
// At the Outset of InvalidateItem,
// so that the change takes effect
pOutSet->InvalidateItem( nWh );
nTmp++;
}
}
// Go to the next pair
pTmpRanges += 2;
}
// Set all Items as new -> the call the current Page Reset()
DBG_ASSERT( pDataObject->pTabPage, "the Page is gone" );
pDataObject->pTabPage->Reset( &aTmpSet );
pDataObject->pTabPage->pImpl->mbStandard = true;
}
}
IMPL_LINK_TYPED( SfxTabDialog, ActivatePageHdl, TabControl *, pTabCtrl, void )
/* [Description]
Handler that is called by StarView for switching to a different page.
If the page not exist yet then it is created and the virtual Method
<SfxTabDialog::PageCreated( sal_uInt16, SfxTabPage &)> is called. If the page
exist, then the if possible the <SfxTabPage::Reset(const SfxItemSet &)> or
<SfxTabPage::ActivatePage(const SfxItemSet &)> is called.
*/
{
sal_uInt16 nId = pTabCtrl->GetCurPageId();
DBG_ASSERT( pImpl->aData.size(), "no Pages registered" );
SfxGetpApp();
// Tab Page schon da?
VclPtr<SfxTabPage> pTabPage = dynamic_cast<SfxTabPage*> (pTabCtrl->GetTabPage( nId ));
Data_Impl* pDataObject = Find( pImpl->aData, nId );
//UUUU fallback to 1st page when requested one does not exist
if(!pDataObject && pTabCtrl->GetPageCount())
{
pTabCtrl->SetCurPageId(pTabCtrl->GetPageId(0));
nId = pTabCtrl->GetCurPageId();
pTabPage = dynamic_cast< SfxTabPage* >(pTabCtrl->GetTabPage(nId));
pDataObject = Find(pImpl->aData, nId);
}
if (!pDataObject)
{
SAL_WARN("sfx.config", "Tab Page ID not known, this is pretty serious and needs investigation");
return;
}
// Create TabPage if possible:
if ( !pTabPage )
{
const SfxItemSet* pTmpSet = nullptr;
if ( pSet )
{
if ( bItemsReset && pSet->GetParent() )
pTmpSet = pSet->GetParent();
else
pTmpSet = pSet;
}
if ( pTmpSet && !pDataObject->bOnDemand )
pTabPage = (pDataObject->fnCreatePage)( pTabCtrl, pTmpSet );
else
pTabPage = (pDataObject->fnCreatePage)
( pTabCtrl, CreateInputItemSet( nId ) );
DBG_ASSERT( nullptr == pDataObject->pTabPage, "create TabPage more than once" );
pDataObject->pTabPage = pTabPage;
OUString sConfigId = OStringToOUString(pTabPage->GetConfigId(), RTL_TEXTENCODING_UTF8);
if (sConfigId.isEmpty())
{
SAL_WARN("sfx.config", "Tabpage needs to be converted to .ui format");
sConfigId = OUString::number(pDataObject->nId);
}
SvtViewOptions aPageOpt(E_TABPAGE, sConfigId);
OUString sUserData;
Any aUserItem = aPageOpt.GetUserItem( USERITEM_NAME );
OUString aTemp;
if ( aUserItem >>= aTemp )
sUserData = aTemp;
pTabPage->SetUserData( sUserData );
Size aSiz = pTabPage->GetSizePixel();
Size aCtrlSiz = pTabCtrl->GetTabPageSizePixel();
// Only set Size on TabControl when < as TabPage
if ( aCtrlSiz.Width() < aSiz.Width() ||
aCtrlSiz.Height() < aSiz.Height() )
{
pTabCtrl->SetTabPageSizePixel( aSiz );
}
PageCreated( nId, *pTabPage );
if ( pDataObject->bOnDemand )
pTabPage->Reset( &pTabPage->GetItemSet() );
else
pTabPage->Reset( pSet );
pTabCtrl->SetTabPage( nId, pTabPage );
}
else if ( pDataObject->bRefresh )
pTabPage->Reset( pSet );
pDataObject->bRefresh = false;
if ( pExampleSet )
pTabPage->ActivatePage( *pExampleSet );
if ( pTabPage->IsReadOnly() || pImpl->bHideResetBtn )
m_pResetBtn->Hide();
else
m_pResetBtn->Show();
}
IMPL_LINK_TYPED( SfxTabDialog, DeactivatePageHdl, TabControl *, pTabCtrl, bool )
/* [Description]
Handler that is called by StarView before leaving a page.
[Cross-reference]
<SfxTabPage::DeactivatePage(SfxItemSet *)>
*/
{
sal_uInt16 nId = pTabCtrl->GetCurPageId();
SfxGetpApp();
SfxTabPage *pPage = dynamic_cast<SfxTabPage*> (pTabCtrl->GetTabPage( nId ));
DBG_ASSERT( pPage, "no active Page" );
if (!pPage)
return false;
#ifdef DBG_UTIL
Data_Impl* pDataObject = Find( pImpl->aData, pTabCtrl->GetCurPageId() );
DBG_ASSERT( pDataObject, "no Data structure for current page" );
if ( pPage->HasExchangeSupport() && pDataObject->bOnDemand )
{
SAL_INFO( "sfx.config", "Data exchange in ItemsOnDemand is not desired!" );
}
#endif
int nRet = SfxTabPage::LEAVE_PAGE;
if ( !pExampleSet && pPage->HasExchangeSupport() && pSet )
pExampleSet = new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() );
if ( pSet )
{
SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
if ( pPage->HasExchangeSupport() )
nRet = pPage->DeactivatePage( &aTmp );
else
nRet = pPage->DeactivatePage( nullptr );
if ( ( SfxTabPage::LEAVE_PAGE & nRet ) == SfxTabPage::LEAVE_PAGE &&
aTmp.Count() )
{
pExampleSet->Put( aTmp );
pOutSet->Put( aTmp );
}
}
else
{
if ( pPage->HasExchangeSupport() ) //!!!
{
if ( !pExampleSet )
{
SfxItemPool* pPool = pPage->GetItemSet().GetPool();
pExampleSet =
new SfxItemSet( *pPool, GetInputRanges( *pPool ) );
}
nRet = pPage->DeactivatePage( pExampleSet );
}
else
nRet = pPage->DeactivatePage( nullptr );
}
if ( nRet & SfxTabPage::REFRESH_SET )
{
RefreshInputSet();
// Flag all Pages as to be initialized as new
for ( SfxTabDlgData_Impl::const_iterator it = pImpl->aData.begin(); it != pImpl->aData.end(); ++it )
{
Data_Impl* pObj = *it;
if ( pObj->pTabPage.get() != pPage ) // Do not refresh own Page anymore
pObj->bRefresh = true;
else
pObj->bRefresh = false;
}
}
if ( nRet & SfxTabPage::LEAVE_PAGE )
return true;
else
return false;
}
void SfxTabDialog::ShowPage( sal_uInt16 nId )
/* [Description]
The TabPage is activated with the specified Id.
*/
{
m_pTabCtrl->SetCurPageId( nId );
ActivatePageHdl( m_pTabCtrl );
}
const sal_uInt16* SfxTabDialog::GetInputRanges( const SfxItemPool& rPool )
/* [Description]
Makes the set over the range of all pages of the dialogue. Pages have the
static method for querying their range in AddTabPage, ie deliver their
sets onDemand.
[Return value]
Pointer to a null-terminated array of sal_uInt16. This array belongs to the
dialog and is deleted when the dialogue is destroy.
[Cross-reference]
<SfxTabDialog::AddTabPage(sal_uInt16, CreateTabPage, GetTabPageRanges, bool)>
<SfxTabDialog::AddTabPage(sal_uInt16, const String &, CreateTabPage, GetTabPageRanges, bool, sal_uInt16)>
<SfxTabDialog::AddTabPage(sal_uInt16, const Bitmap &, CreateTabPage, GetTabPageRanges, bool, sal_uInt16)>
*/
{
if ( pSet )
{
SAL_WARN( "sfx.dialog", "Set already exists!" );
return pSet->GetRanges();
}
if ( pRanges )
return pRanges;
std::vector<sal_uInt16> aUS;
for ( SfxTabDlgData_Impl::const_iterator it = pImpl->aData.begin(); it != pImpl->aData.end(); ++it )
{
Data_Impl* pDataObject = *it;
if ( pDataObject->fnGetRanges )
{
const sal_uInt16* pTmpRanges = (pDataObject->fnGetRanges)();
const sal_uInt16* pIter = pTmpRanges;
sal_uInt16 nLen;
for( nLen = 0; *pIter; ++nLen, ++pIter )
;
aUS.insert( aUS.end(), pTmpRanges, pTmpRanges + nLen );
}
}
//! Remove duplicated Ids?
{
sal_uInt16 nCount = aUS.size();
for ( sal_uInt16 i = 0; i < nCount; ++i )
aUS[i] = rPool.GetWhich( aUS[i] );
}
// sort
if ( aUS.size() > 1 )
{
std::sort( aUS.begin(), aUS.end() );
}
pRanges = new sal_uInt16[aUS.size() + 1];
std::copy( aUS.begin(), aUS.end(), pRanges );
pRanges[aUS.size()] = 0;
return pRanges;
}
void SfxTabDialog::SetInputSet( const SfxItemSet* pInSet )
/* [Description]
With this method the Input-Set can subsequently be set initially or re-set.
*/
{
bool bSet = ( pSet != nullptr );
delete pSet;
pSet = pInSet ? new SfxItemSet(*pInSet) : nullptr;
if (!bSet && !pExampleSet && !pOutSet && pSet)
{
pExampleSet = new SfxItemSet( *pSet );
pOutSet = new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() );
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink