include/svx/sdtakitm.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef SDTAKITM_HXX
  20 #define SDTAKITM_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include <svx/svddef.hxx>
  24 #include "svx/svxdllapi.h"
  25
  26 //------------------------------
  27 // class SdrTextAniKindItem
  28 //------------------------------
  29
  30 enum SdrTextAniKind {SDRTEXTANI_NONE,
  31                      SDRTEXTANI_BLINK,
  32                      SDRTEXTANI_SCROLL,
  33                      SDRTEXTANI_ALTERNATE,
  34                      SDRTEXTANI_SLIDE};
  35
  36 // - SDRTEXTANI_BLINK:
  37 //   Just blink.  Direction and Amount don't effect things.
  38 //   Frequency delay: 0 = 0.5Hz (Delay = 250).
  39 //   Count = number of blinks. (0 = forever)
  40 //   start inside: sal_False = begin with the blinker off, sal_True  = begin with the blinker on
  41 //   stop inside: sal_False = end with the blinker off, sal_True = end with the blinker on
  42 //                (Only if count! = 0)
  43 // - SDRTEXTANI_SCROLL:
  44 //   Text just scrolls all the way through, and starts over when it is done.
  45 //
  46 //   Delay in ms: (except delay = 0 means 50ms (20Hz) default)
  47 //   Count = number of passes (0 = go forever)
  48 //   Direction: the direction to scroll
  49 //   StartInside: sal_False = on the first pass, scroll the text in (not initially visible)
  50 //                sal_True = on the first pass, the left part of the text is already visible
  51 //                           in the scroll area before starting.
  52 //   StopInside: sal_False = on the last pass, scroll the text all the way out.
  53 //                sal_True = on the last pass, keep the right part of the text visible.
  54 //                (Only if count! = 0)
  55 //   Amount: Step size in logical units. Negative values = use Pixels instead
  56 //           of logical units. If Amount = 0, then default to 1 Pixel.
  57 // - SDRTEXTANI_ALTERNATE:
  58 //   Like SDRTEXTANI_SCROLL, except don't scroll until all of the text is out,
  59 //        but just until the last part is visible.  Then, change direction and
  60 //        scroll the text the other way.
  61 //   Count = number of passes (number of direction changes minus 1)
  62 //        If count = 1, this is the same as SDRTEXTANI_SCROLL
  63 //   Direction = the starting direction.
  64 //   All Other Parameters: just like SDRTEXTANI_SCROLL
  65 // - SDRTEXTANI_SLIDE:
  66 //   Text will slide in to the original position.
  67 //   -> same as SCROLL with StartInside = sal_False, StopInside = sal_True
  68 //   and Count = 1 (Count = 0 is interpreted as count = 1).
  69 //   For each count > 1, the text, will be slid out backwards
  70 //   (much like ALTERNATE) and then slid back in again.
  71 //   StopInside is not evaluated, because inside is always stopped.
  72 //   StartInside is not evaluated, because outside is always started.
  73 //   All other parameters are like SDRTEXTANI_SCROLL
  74 // StartInside, StopInside: When sal_True, the starting / final position
  75 //   of the text depends on the anchor of the drawing object.  This
  76 //   corresponds to the position of the text in normal Paint (without scrolling).
  77
  78 class SVX_DLLPUBLIC SdrTextAniKindItem: public SfxEnumItem {
  79 public:
  80     TYPEINFO();
  81     SdrTextAniKindItem(SdrTextAniKind eKind=SDRTEXTANI_NONE): SfxEnumItem(SDRATTR_TEXT_ANIKIND,(sal_uInt16)eKind) {}
  82     SdrTextAniKindItem(SvStream& rIn)                       : SfxEnumItem(SDRATTR_TEXT_ANIKIND,rIn)  {}
  83     virtual SfxPoolItem*      Clone(SfxItemPool* pPool=NULL) const;
  84     virtual SfxPoolItem*      Create(SvStream& rIn, sal_uInt16 nVer) const;
  85     virtual sal_uInt16            GetValueCount() const; // { return 5; }
  86             SdrTextAniKind GetValue() const      { return (SdrTextAniKind)SfxEnumItem::GetValue(); }
  87
  88     virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
  89     virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
  90
  91     virtual OUString GetValueTextByPos(sal_uInt16 nPos) const;
  92     virtual SfxItemPresentation GetPresentation(SfxItemPresentation ePres, SfxMapUnit eCoreMetric, SfxMapUnit ePresMetric, OUString& rText, const IntlWrapper * = 0) const;
  93 };
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */