office-gobmx/cui/source/inc/iconcdlg.hxx
Thomas Arnhold df2fe97072 fixincludeguards.sh: cui
Change-Id: I0a9f69b8c2129329f742f18e7749484b6f3e5bf7
2013-10-28 15:16:19 +01:00

231 lines
8.4 KiB
C++

/* -*- 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 .
*/
#ifndef INCLUDED_CUI_SOURCE_INC_ICONCDLG_HXX
#define INCLUDED_CUI_SOURCE_INC_ICONCDLG_HXX
#include <rtl/ustring.hxx>
#include <svl/itempool.hxx>
#include <svl/itemset.hxx>
#include <svtools/ivctrl.hxx>
#include <vcl/tabpage.hxx>
#include <vcl/msgbox.hxx>
#include <vcl/dialog.hxx>
#include <vcl/button.hxx>
#include <vcl/image.hxx>
#include <vector>
#define CTRLS_OFFSET 3
#define RET_USER 100
#define RET_USER_CANCEL 101
// forward-declarations
struct IconChoicePageData;
class IconChoiceDialog;
class IconChoicePage;
// Create-Function
typedef IconChoicePage* (*CreatePage)(Window *pParent, const SfxItemSet &rAttrSet);
typedef sal_uInt16* (*GetPageRanges)(); // gives international Which-value
// position of iconchoicectrl
enum EIconChoicePos { PosLeft, PosRight, PosTop, PosBottom };
/// Data-structure for pages in dialog
struct IconChoicePageData
{
sal_uInt16 nId;
CreatePage fnCreatePage; ///< pointer to the factory
GetPageRanges fnGetRanges; ///< pointer to the ranges-function
IconChoicePage* pPage; ///< the TabPage itself
sal_Bool bOnDemand; ///< Flag: ItemSet onDemand
sal_Bool bRefresh; ///< Flag: page has to be newly initialized
// constructor
IconChoicePageData( sal_uInt16 Id, CreatePage fnPage, GetPageRanges fnRanges, sal_Bool bDemand )
: nId ( Id ),
fnCreatePage ( fnPage ),
fnGetRanges ( fnRanges ),
pPage ( NULL ),
bOnDemand ( bDemand ),
bRefresh ( sal_False )
{}
};
class IconChoicePage : public TabPage
{
using TabPage::ActivatePage;
using TabPage::DeactivatePage;
private :
const SfxItemSet* pSet;
OUString aUserString;
sal_Bool bHasExchangeSupport;
IconChoiceDialog* pDialog;
void SetDialog( IconChoiceDialog* pNew ) { pDialog = pNew; }
IconChoiceDialog* GetDialog() const { return pDialog; }
void SetInputSet( const SfxItemSet* pNew ) { pSet = pNew; }
void ImplInitSettings();
protected :
IconChoicePage( Window *pParent, const ResId &, const SfxItemSet &rAttrSet );
sal_uInt16 GetSlot( sal_uInt16 nWhich ) const { return pSet->GetPool()->GetSlotId( nWhich ); }
sal_uInt16 GetWhich( sal_uInt16 nSlot ) const { return pSet->GetPool()->GetWhich( nSlot ); }
public :
virtual ~IconChoicePage();
const SfxItemSet& GetItemSet() const { return *pSet; }
virtual sal_Bool FillItemSet( SfxItemSet& ) = 0;
virtual void Reset( const SfxItemSet& ) = 0;
sal_Bool HasExchangeSupport() const { return bHasExchangeSupport; }
void SetExchangeSupport( sal_Bool bNew = sal_True ) { bHasExchangeSupport = bNew; }
enum {
KEEP_PAGE = 0x0000, ///< error handling
/** 2nd filling of an ItemSet for updating superior examples;
this pointer can always be NULL!! */
LEAVE_PAGE = 0x0001,
/// refresh set and update other pages
REFRESH_SET = 0x0002
};
virtual void ActivatePage( const SfxItemSet& );
virtual int DeactivatePage( SfxItemSet* pSet = 0 );
void SetUserData(const OUString& rString) { aUserString = rString; }
OUString GetUserData() { return aUserString; }
virtual void FillUserData();
virtual sal_Bool IsReadOnly() const;
virtual sal_Bool QueryClose();
void StateChanged( StateChangedType nType );
void DataChanged( const DataChangedEvent& rDCEvt );
};
class IconChoiceDialog : public ModalDialog
{
private :
friend class IconChoicePage;
EIconChoicePos meChoicePos;
::std::vector< IconChoicePageData* > maPageList;
SvtIconChoiceCtrl maIconCtrl;
sal_uInt16 mnCurrentPageId;
// Buttons
OKButton aOKBtn;
CancelButton aCancelBtn;
HelpButton aHelpBtn;
PushButton aResetBtn;
const SfxItemSet* pSet;
SfxItemSet* pOutSet;
SfxItemSet* pExampleSet;
sal_uInt16* pRanges;
sal_uInt32 nResId;
sal_Bool bHideResetBtn;
sal_Bool bModal;
sal_Bool bInOK;
sal_Bool bModified;
sal_Bool bItemsReset;
DECL_LINK ( ChosePageHdl_Impl, void * );
DECL_LINK(OkHdl, void *);
DECL_LINK(ResetHdl, void *);
DECL_LINK(CancelHdl, void *);
IconChoicePageData* GetPageData ( sal_uInt16 nId );
void Start_Impl();
sal_Bool OK_Impl();
void SetPosSizeCtrls ( sal_Bool bInit = sal_False );
void SetPosSizePages ( sal_uInt16 nId );
void FocusOnIcon ( sal_uInt16 nId );
protected :
void ShowPageImpl ( IconChoicePageData* pData );
void HidePageImpl ( IconChoicePageData* pData );
virtual void PageCreated( sal_uInt16 nId, IconChoicePage& rPage );
virtual SfxItemSet* CreateInputItemSet( sal_uInt16 nId );
inline SfxItemSet* GetInputSetImpl() { return (SfxItemSet*)pSet; }
inline IconChoicePage* GetTabPage( sal_uInt16 nPageId )
{ return ( GetPageData (nPageId)->pPage?GetPageData (nPageId)->pPage:NULL); }
const SfxItemSet* GetRefreshedSet();
void ActivatePageImpl ();
sal_Bool DeActivatePageImpl ();
void ResetPageImpl ();
short Ok();
public :
// the IconChoiceCtrl's could also be set in the Ctor
IconChoiceDialog ( Window* pParent, const ResId &rResId,
const EIconChoicePos ePos = PosLeft, const SfxItemSet * pItemSet = 0 );
~IconChoiceDialog ();
virtual void Paint( const Rectangle& rRect );
virtual void Resize();
// interface
SvxIconChoiceCtrlEntry* AddTabPage(
sal_uInt16 nId, const OUString& rIconText, const Image& rChoiceIcon,
CreatePage pCreateFunc /* != NULL */, GetPageRanges pRangesFunc = NULL /* NULL allowed*/,
sal_Bool bItemsOnDemand = sal_False, sal_uLong nPos = LIST_APPEND );
void SetCurPageId( sal_uInt16 nId ) { mnCurrentPageId = nId; FocusOnIcon( nId ); }
sal_uInt16 GetCurPageId() const { return mnCurrentPageId; }
void ShowPage( sal_uInt16 nId );
/// gives via map converted local slots if applicable
const sal_uInt16* GetInputRanges( const SfxItemPool& );
void SetInputSet( const SfxItemSet* pInSet );
const SfxItemSet* GetOutputItemSet() const { return pOutSet; }
const OKButton& GetOKButton() const { return aOKBtn; }
OKButton& GetOKButton() { return aOKBtn; }
const CancelButton& GetCancelButton() const { return aCancelBtn; }
CancelButton& GetCancelButton() { return aCancelBtn; }
const HelpButton& GetHelpButton() const { return aHelpBtn; }
HelpButton& GetHelpButton() { return aHelpBtn; }
short Execute();
void Start( sal_Bool bShow = sal_True );
sal_Bool QueryClose();
const SfxItemSet* GetExampleSet() const { return pExampleSet; }
EIconChoicePos SetCtrlPos ( const EIconChoicePos& rPos );
};
#endif // INCLUDED_CUI_SOURCE_INC_ICONCDLG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */