Guiliani  Version 2.6 revision 7293 (documentation build 12)
GUIScrollingTextField.h
1/*
2* Copyright (C) TES Electronic Solutions GmbH,
3* All Rights Reserved.
4* Contact: info@guiliani.de
5*
6* This file is part of the Guiliani HMI framework
7* for the development of graphical user interfaces on embedded systems.
8*/
9
10#if !defined(GUISCROLLINGTEXTFIELD_H)
11#define GUISCROLLINGTEXTFIELD_H
12
13#include "GUITextField.h"
14
20{
21public:
38 CGUICompositeObject* const pkParent,
39 const eC_Value& vX, const eC_Value& vY,
40 const eC_Value& vWidth, const eC_Value& vHeight,
41 const eC_String &kText,
42 const eC_Bool& bMultiLine = false,
43 const eC_Bool& bAnimationActive = false,
44 const eC_Bool& bScrollVertical = false,
45 const eC_Int &iAnimationTime = 30,
46 const eC_Int &iAnimationStepSize = 1,
47 const ImageResource_t &eBackgroundImg = DUMMY_IMAGE,
48 const ObjectHandle_t &eID = NO_HANDLE);
49
63 CGUICompositeObject* const pkParent,
64 const CGUIRect &kRect,
65 const eC_String &kText,
66 const eC_Bool& bMultiLine = false,
67 const eC_Bool& bAnimationActive = false,
68 const eC_Bool& bScrollVertical = false,
69 const eC_Int &iAnimationTime = 30,
70 const eC_Int &iAnimationStepSize = 1,
71 const ImageResource_t &eBackgroundImg = DUMMY_IMAGE,
72 const ObjectHandle_t &eID = NO_HANDLE);
73
90 CGUICompositeObject* const pkParent,
91 const eC_Value& vX, const eC_Value& vY,
92 const eC_Value& vWidth, const eC_Value& vHeight,
93 const TextResource_t &eTextID,
94 const eC_Bool& bMultiLine = false,
95 const eC_Bool& bAnimationActive = false,
96 const eC_Bool& bScrollVertical = false,
97 const eC_Int &iAnimationTime = 30,
98 const eC_Int &iAnimationStepSize = 1,
99 const ImageResource_t &eBackgroundImg = DUMMY_IMAGE,
100 const ObjectHandle_t &eID = NO_HANDLE);
101
115 CGUICompositeObject* const pkParent,
116 const CGUIRect &kRect,
117 const TextResource_t &eTextID,
118 const eC_Bool& bMultiLine = false,
119 const eC_Bool& bAnimationActive = false,
120 const eC_Bool& bScrollVertical = false,
121 const eC_Int &iAnimationTime = 30,
122 const eC_Int &iAnimationStepSize = 1,
123 const ImageResource_t &eBackgroundImg = DUMMY_IMAGE,
124 const ObjectHandle_t &eID = NO_HANDLE);
125
128
135 void Init(const eC_Bool bAnimationActive, const eC_Bool bScrollVertical, const eC_Int iAnimationTime, const eC_Int iAnimationStepSize);
136
141
147
150
154 void SetAnimationActive(eC_Bool bAnimationActive);
155
157 eC_Bool GetAnimationActive() const;
158
162 void SetScrollVertical(eC_Bool bScrollVertical);
163
164#if defined(GUILIANI_STREAM_GUI)
169 virtual void ReadFromStream();
170#endif
171
172#if defined(GUILIANI_WRITE_GUI)
178 virtual void WriteToStream(const eC_Bool bWriteClassID=false);
179#endif
180
181};
182
183#endif // GUISCROLLINGTEXTFIELD_H
ImageResource_t
Enumeration of image resource ids.
Definition: GUIImageResource.h:126
ObjectHandle_t
List of object resource ids.
Definition: GUIObjectHandleResource.h:55
TextResource_t
List of text resource ids.
Definition: GUITextResource.h:40
This is the Guiliani base class for all composite objects.
Definition: GUICompositeObject.h:70
Helper class to supply a platform independent rectangle implementation.
Definition: GUIRect.h:63
Draws a smooth scrolling text field with configurable speed.
Definition: GUIScrollingTextField.h:20
CGUIScrollingTextField(CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
void Init(const eC_Bool bAnimationActive, const eC_Bool bScrollVertical, const eC_Int iAnimationTime, const eC_Int iAnimationStepSize)
CGUIScrollingTextField(CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
void SetScrollVertical(eC_Bool bScrollVertical)
CGUIScrollingTextField & operator=(const CGUIScrollingTextField &kSource)
CGUIScrollingTextField(CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
CGUIScrollingTextField(const CGUIScrollingTextField &kSource)
CGUIScrollingTextField(CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
virtual void WriteToStream(const eC_Bool bWriteClassID=false)
CGUIScrollingTextField()
Default constructor to be used by the factory.
virtual void ReadFromStream()
~CGUIScrollingTextField()
Destructor.
eC_Bool GetAnimationActive() const
void SetAnimationActive(eC_Bool bAnimationActive)
Represents a simple GUI object containing a text.
Definition: GUITextField.h:83