sfxhtml.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_SFX2_SFXHTML_HXX
#define INCLUDED_SFX2_SFXHTML_HXX
 
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <i18nlangtag/lang.h>
#include <svtools/parhtml.hxx>
#include <svl/macitem.hxx>
#include <memory>
 
 
class ImageMap;
class SfxMedium;
class SvNumberFormatter;
 
class SFX2_DLLPUBLIC SfxHTMLParser : public HTMLParser
{
    OUString                aScriptType;
 
    SfxMedium*              pMedium;
    std::unique_ptr<SfxMedium> pDLMedium;   // Medium for Download Files
 
    ScriptType eScriptType;
 
    SAL_DLLPRIVATE void GetScriptType_Impl( SvKeyValueIterator* );
 
protected:
 
    SfxHTMLParser( SvStream& rStream, bool bNewDoc, SfxMedium *pMedium );
 
    virtual ~SfxHTMLParser() override;
 
public:
    // Read the options of an image map
    // <MAP>: sal_True = Image-Map has a name
    // <AREA>: sal_True = Image-Map has now one vcl::Region more
    static bool ParseMapOptions(ImageMap* pImageMap, const HTMLOptions& rOptions);
    bool ParseMapOptions(ImageMap * pImageMap)
    { return ParseMapOptions(pImageMap, GetOptions()); }
    static bool ParseAreaOptions(ImageMap * pImageMap, std::u16string_view rBaseURL,
                                 const HTMLOptions& rOptions,
                                 SvMacroItemId nEventMouseOver,
                                 SvMacroItemId nEventMouseOut );
    inline bool ParseAreaOptions(ImageMap * pImageMap, std::u16string_view rBaseURL,
                                 SvMacroItemId nEventMouseOver,
                                 SvMacroItemId nEventMouseOut);
 
    // <TD SDVAL="..." SDNUM="...">
    static double GetTableDataOptionsValNum( sal_uInt32& nNumForm,
            LanguageType& eNumLang, const OUString& aValStr,
            std::u16string_view aNumStr, SvNumberFormatter& rFormatter );
 
protected:
    // Start a file download. This is done asynchronously or synchronously.
    // In the synchronous case, the parser is in the working state after
    // it has been called. The read file can then be picked up directly with
    // FinishFileDownload. In the asynchronous case, the parser is in the
    // pending state after it hs been called. The parser then has to leave
    // over the Continue (without Reschedule!). If the file is loaded,
    // a Continue is called with passed on token. The file can then be picked
    // up by FinishFileDownload. To cancel the download should a shell be
    // left. It can only exist a single download at the same time, For every
    // started download FinishFileDownload must be called.
    void StartFileDownload(const OUString& rURL);
 
    // End of an asynchronous file download. Returns TRUE if the download
    // was successful. The read file is then passed into String.
    bool FinishFileDownload( OUString& rStr );
 
    // Returns TRUE if a file was downloaded and if FileDownloadFinished
    // has not yet been called
    bool ShouldFinishFileDownload() const { return pDLMedium != nullptr; }
 
    SfxMedium *GetMedium() { return pMedium; }
    const SfxMedium *GetMedium() const { return pMedium; }
 
    // Default (without iterator) is JavaScript
    ScriptType GetScriptType( SvKeyValueIterator* ) const;
    const OUString& GetScriptTypeString( SvKeyValueIterator* ) const;
};
 
inline bool SfxHTMLParser::ParseAreaOptions(ImageMap * pImageMap, std::u16string_view rBaseURL,
                                            SvMacroItemId nEventMouseOver,
                                            SvMacroItemId nEventMouseOut)
{
    return ParseAreaOptions( pImageMap, rBaseURL, GetOptions(),
                             nEventMouseOver, nEventMouseOut );
}
 
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */