office-gobmx/include/svx/sdtakitm.hxx
Oliver Specht c39e4f6b8a Add SfxItemType to SfxPoolItem
The SfxPoolItem has a new member SfxItemType m_eItemType to
compare types based on enums instead of typeinfo() which
consumes a lot of time e.g. while AutoFormat is running

Change-Id: I033ce67bc9a28ee4790f162380314de85fb4154e
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/166452
Tested-by: Jenkins
Reviewed-by: Thorsten Behrens <thorsten.behrens@allotropia.de>
Reviewed-by: Armin Le Grand <Armin.Le.Grand@me.com>
2024-06-18 01:07:42 +02:00

95 lines
4.5 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_SVX_SDTAKITM_HXX
#define INCLUDED_SVX_SDTAKITM_HXX
#include <svl/eitem.hxx>
#include <svx/svddef.hxx>
#include <svx/svxdllapi.h>
/**
* Animation type for text frame.
*/
enum class SdrTextAniKind {
NONE, /// no animation
Blink, /// blinking
Scroll, /// scroll through
Alternate, /// scroll back and forth
Slide /// scroll in
};
// - SdrTextAniKind::Blink:
// Just blink. Direction and Amount don't effect things.
// Frequency delay: 0 = 0.5Hz (Delay = 250).
// Count = number of blinks. (0 = forever)
// start inside: sal_False = begin with the blinker off, sal_True = begin with the blinker on
// stop inside: sal_False = end with the blinker off, sal_True = end with the blinker on
// (Only if count! = 0)
// - SdrTextAniKind::Scroll:
// Text just scrolls all the way through, and starts over when it is done.
// Delay in ms: (except delay = 0 means 50ms (20Hz) default)
// Count = number of passes (0 = go forever)
// Direction: the direction to scroll
// StartInside: sal_False = on the first pass, scroll the text in (not initially visible)
// sal_True = on the first pass, the left part of the text is already visible
// in the scroll area before starting.
// StopInside: sal_False = on the last pass, scroll the text all the way out.
// sal_True = on the last pass, keep the right part of the text visible.
// (Only if count! = 0)
// Amount: Step size in logical units. Negative values = use Pixels instead
// of logical units. If Amount = 0, then default to 1 Pixel.
// - SdrTextAniKind::Alternate:
// Like SdrTextAniKind::Scroll, except don't scroll until all of the text is out,
// but just until the last part is visible. Then, change direction and
// scroll the text the other way.
// Count = number of passes (number of direction changes minus 1)
// If count = 1, this is the same as SdrTextAniKind::Scroll
// Direction = the starting direction.
// All Other Parameters: just like SdrTextAniKind::Scroll
// - SdrTextAniKind::Slide:
// Text will slide into the original position.
// -> same as SCROLL with StartInside = sal_False, StopInside = sal_True
// and Count = 1 (Count = 0 is interpreted as count = 1).
// For each count > 1, the text, will be slid out backwards
// (much like ALTERNATE) and then slid back in again.
// StopInside is not evaluated, because inside is always stopped.
// StartInside is not evaluated, because outside is always started.
// All other parameters are like SdrTextAniKind::Scroll
// StartInside, StopInside: When sal_True, the starting / final position
// of the text depends on the anchor of the drawing object. This
// corresponds to the position of the text in normal Paint (without scrolling).
class SVXCORE_DLLPUBLIC SdrTextAniKindItem final : public SfxEnumItem<SdrTextAniKind> {
public:
SdrTextAniKindItem(SdrTextAniKind eKind=SdrTextAniKind::NONE)
: SfxEnumItem(SDRATTR_TEXT_ANIKIND, SfxItemType::SdrTextAniKindItemType, eKind) {}
virtual SdrTextAniKindItem* Clone(SfxItemPool* pPool=nullptr) const override;
virtual sal_uInt16 GetValueCount() const override; // { return 5; }
virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
static OUString GetValueTextByPos(sal_uInt16 nPos);
virtual bool GetPresentation(SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString& rText, const IntlWrapper&) const override;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */