office-gobmx/forms/source/richtext/richtextimplcontrol.hxx
Rüdiger Timm 53150f8597 INTEGRATION: CWS changefileheader (1.6.126); FILE MERGED
2008/04/01 15:16:39 thb 1.6.126.3: #i85898# Stripping all external header guards
2008/04/01 12:30:30 thb 1.6.126.2: #i85898# Stripping all external header guards
2008/03/31 13:11:41 rt 1.6.126.1: #i87441# Change license header to LPGL v3.
2008-04-11 07:46:39 +00:00

199 lines
8.4 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: richtextimplcontrol.hxx,v $
* $Revision: 1.7 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef FORMS_SOURCE_RICHTEXT_RICHTEXTIMPLCONTOL_HXX
#define FORMS_SOURCE_RICHTEXT_RICHTEXTIMPLCONTOL_HXX
#include "rtattributehandler.hxx"
#include "richtextviewport.hxx"
#include "richtextengine.hxx"
#include <vcl/scrbar.hxx>
#include <svx/editdata.hxx>
#include <map>
class EditView;
class EditStatus;
class Window;
class SvxScriptSetItem;
//........................................................................
namespace frm
{
//........................................................................
class ITextAttributeListener;
class ITextSelectionListener;
class RichTextViewPort;
//====================================================================
//= RichTextControlImpl
//====================================================================
class RichTextControlImpl : public IEngineStatusListener
{
typedef ::std::map< AttributeId, AttributeState > StateCache;
typedef ::std::map< AttributeId, ::rtl::Reference< IAttributeHandler > > AttributeHandlerPool;
typedef ::std::map< AttributeId, ITextAttributeListener* > AttributeListenerPool;
StateCache m_aLastKnownStates;
AttributeHandlerPool m_aAttributeHandlers;
AttributeListenerPool m_aAttributeListeners;
ESelection m_aLastKnownSelection;
Control* m_pAntiImpl;
RichTextViewPort* m_pViewport;
ScrollBar* m_pHScroll;
ScrollBar* m_pVScroll;
ScrollBarBox* m_pScrollCorner;
RichTextEngine* m_pEngine;
EditView* m_pView;
ITextAttributeListener* m_pTextAttrListener;
ITextSelectionListener* m_pSelectionListener;
bool m_bHasEverBeenShown;
public:
struct GrantAccess { friend class RichTextControl; private: GrantAccess() { } };
inline EditView* getView( const GrantAccess& ) const { return m_pView; }
inline RichTextEngine* getEngine( const GrantAccess& ) const { return m_pEngine; }
inline Window* getViewport( const GrantAccess& ) const { return m_pViewport; }
public:
RichTextControlImpl( Control* _pAntiImpl, RichTextEngine* _pEngine,
ITextAttributeListener* _pTextAttrListener, ITextSelectionListener* _pSelectionListener );
virtual ~RichTextControlImpl();
/** updates the cache with the state of all attribute values from the given set, notifies
the listener if the state changed
*/
void updateAllAttributes( );
/** updates the cache with the state of the attribute given by which id, notifies
the listener if the state changed
*/
void updateAttribute( AttributeId _nAttribute );
/// enables the callback for a particular attribute
void enableAttributeNotification( AttributeId _nAttributeId, ITextAttributeListener* _pListener = NULL );
/// disables the change notifications for a particular attribute
void disableAttributeNotification( AttributeId _nAttributeId );
/// executes a toggle of the given attribute
bool executeAttribute( const SfxItemSet& _rCurrentAttribs, SfxItemSet& _rNewAttribs, AttributeId _nAttribute, const SfxPoolItem* _pArgument, ScriptType _nForScriptType );
/// retrieves the state of the given attribute from the cache
AttributeState getAttributeState( AttributeId _nAttributeId ) const;
/** normalizes the given item so that the state of script dependent attributes
is correct considering the current script type
There are some attributes which are script dependent, e.g. the CharPosture. This means
that in real, there are 3 attributes for this, one for every possible script type (latin,
asian, complex). However, to the out world, we behave as if there is only one attribute:
E.g., if the outter world asks for the state of the "CharPosture" attribute, we return
the state of either CharPostureLatin, CharPostureAsian, or CharPostureComplex, depending
on the script type of the current selection. (In real, it may be more complex since
the current selection may contain more than one script type.)
This method normalizes a script dependent attribute, so that it's state takes into account
the currently selected script type.
*/
void normalizeScriptDependentAttribute( SvxScriptSetItem& _rScriptSetItem );
// gets the script type of the selection in our edit view (with fallback)
ScriptType getSelectedScriptType() const;
/** re-arranges the view and the scrollbars
*/
void layoutWindow();
/** to be called when the style of our window changed
*/
void notifyStyleChanged();
/** to be called when the zoom of our window changed
*/
void notifyZoomChanged();
/** to be called when the STATE_CHANGE_INITSHOW event arrives
*/
void notifyInitShow();
// VCL "overrides"
void SetBackgroundColor( );
void SetBackgroundColor( const Color& _rColor );
void SetReadOnly( bool _bReadOnly );
bool IsReadOnly() const;
void SetHideInactiveSelection( bool _bHide );
bool GetHideInactiveSelection() const;
/// draws the control onto a given output device
void Draw( OutputDevice* _pDev, const Point& _rPos, const Size& _rSize, ULONG _nFlags );
/// handles command events arrived at the anti-impl control
long HandleCommand( const CommandEvent& _rEvent );
private:
// updates the cache with the state provided by the given attribut handler
void implUpdateAttribute( AttributeHandlerPool::const_iterator _pHandler );
// updates the cache with the given state, and calls listeners (if necessary)
void implCheckUpdateCache( AttributeId _nAttribute, const AttributeState& _rState );
// updates range and position of our scrollbars
void updateScrollbars();
// determines whether automatic (soft) line breaks are ON
bool windowHasAutomaticLineBreak();
/// hides or shows our scrollbars, according to the current WinBits of the window
void ensureScrollbars();
/// ensures that our "automatic line break" setting matches the current WinBits of the window
void ensureLineBreakSetting();
inline bool hasVScrollBar( ) const { return m_pVScroll != NULL; }
inline bool hasHScrollBar( ) const { return m_pHScroll != NULL; }
// IEngineStatusListener overridables
virtual void EditEngineStatusChanged( const EditStatus& _rStatus );
private:
DECL_LINK( OnInvalidateAllAttributes, void* );
DECL_LINK( OnHScroll, ScrollBar* );
DECL_LINK( OnVScroll, ScrollBar* );
};
//........................................................................
} // namespace frm
//........................................................................
#endif // FORMS_SOURCE_RICHTEXT_RICHTEXTIMPLCONTOL_HXX