vbacontrol.hxx

Go to the documentation of this file.

/* -*- 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_OOX_OLE_VBACONTROL_HXX
#define INCLUDED_OOX_OLE_VBACONTROL_HXX
 
#include <memory>
 
#include <com/sun/star/uno/Reference.hxx>
#include <oox/helper/refvector.hxx>
#include <oox/ole/axbinaryreader.hxx>
#include <oox/ole/axcontrol.hxx>
#include <rtl/textenc.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
 
namespace com::sun::star {
    namespace awt { class XControlModel; }
    namespace container { class XNameContainer; }
    namespace frame { class XModel; }
    namespace uno { class XComponentContext; }
}
 
namespace oox {
    class BinaryInputStream;
    class GraphicHelper;
    class PropertyMap;
    class StorageBase;
}
 
namespace oox::ole {
 
 
class VbaSiteModel final
{
public:
    explicit            VbaSiteModel();
                        ~VbaSiteModel();
 
    void                importProperty( sal_Int32 nPropId, const OUString& rValue );
    bool                importBinaryModel( BinaryInputStream& rInStrm );
    void                moveRelative( const AxPairData& rDistance );
 
    const OUString& getName() const { return maName; }
    const AxPairData& getPosition() const { return maPos; }
    sal_Int32    getId() const { return mnId; }
    bool                isContainer() const;
    sal_uInt32          getStreamLength() const;
    OUString     getSubStorageName() const;
    sal_Int16    getTabIndex() const { return mnTabIndex; }
 
    ControlModelRef     createControlModel( const AxClassTable& rClassTable ) const;
    void                convertProperties(
                            PropertyMap& rPropMap,
                            const ControlConverter& rConv,
                            ApiControlType eCtrlType,
                            sal_Int32 nCtrlIndex ) const;
    const OUString& getControlSource() const { return  maControlSource; }
    const OUString& getRowSource() const { return  maRowSource; }
private:
    OUString     maName;             
    OUString     maTag;              
    OUString     maToolTip;          
    OUString     maControlSource;    
    OUString     maRowSource;        
 
    AxPairData          maPos;              
    sal_Int32           mnId;               
    sal_Int32           mnHelpContextId;    
    sal_uInt32          mnFlags;            
    sal_uInt32          mnStreamLen;        
    sal_Int16           mnTabIndex;         
    sal_uInt16          mnClassIdOrCache;   
    sal_uInt16          mnGroupId;          
};
 
typedef std::shared_ptr< VbaSiteModel > VbaSiteModelRef;
 
 
class VbaFormControl
{
public:
    explicit            VbaFormControl();
    virtual             ~VbaFormControl();
 
    void                importModelOrStorage(
                            BinaryInputStream& rInStrm,
                            StorageBase& rStrg,
                            const AxClassTable& rClassTable );
 
    OUString     getControlName() const;
 
    void                createAndConvert(
                            sal_Int32 nCtrlIndex,
                            const css::uno::Reference< css::container::XNameContainer >& rxParentNC,
                            const ControlConverter& rConv ) const;
 
protected:
    void                importControlModel( BinaryInputStream& rInStrm, const AxClassTable& rClassTable );
    void                importStorage( StorageBase& rStrg, const AxClassTable& rClassTable );
 
    bool                convertProperties(
                            const css::uno::Reference< css::awt::XControlModel >& rxCtrlModel,
                            const ControlConverter& rConv,
                            sal_Int32 nCtrlIndex ) const;
 
private:
    typedef RefVector< VbaFormControl >         VbaFormControlVector;
    typedef VbaFormControlVector::value_type    VbaFormControlRef;
 
    void                createControlModel( const AxClassTable& rClassTable );
    bool                importSiteModel( BinaryInputStream& rInStrm );
 
    void                importEmbeddedSiteModels( BinaryInputStream& rInStrm );
    /*  Final processing of all embedded controls after import. */
    void                finalizeEmbeddedControls();
 
    void                moveRelative( const AxPairData& rDistance );
    void                moveEmbeddedToAbsoluteParent();
 
    static bool         compareByTabIndex( const VbaFormControlRef& rxLeft, const VbaFormControlRef& rxRight );
 
protected:
    VbaSiteModelRef     mxSiteModel;        
    ControlModelRef     mxCtrlModel;        
 
private:
    VbaFormControlVector maControls;        
    AxClassTable         maClassTable;      
};
 
 
class VbaUserForm final : public VbaFormControl
{
public:
    explicit            VbaUserForm(
                            const css::uno::Reference< css::uno::XComponentContext >& rxContext,
                            const css::uno::Reference< css::frame::XModel >& rxDocModel,
                            const GraphicHelper& rGraphicHelper,
                            bool bDefaultColorBgr );
 
    void                importForm(
                           const css::uno::Reference< css::container::XNameContainer >& rxDialogLib,
                           StorageBase& rVbaFormStrg,
                           const OUString& rModuleName,
                           rtl_TextEncoding eTextEnc );
 
private:
    css::uno::Reference< css::uno::XComponentContext > mxContext;
    css::uno::Reference< css::frame::XModel >          mxDocModel;
    ControlConverter                                   maConverter;
};
 
 
} // namespace oox::ole
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */