gl2d_latin1_texts_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_LATIN1_TEXTS_INTERFACE_H_
#define SDK_GL2D_LATIN1_TEXTS_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/color/color_base_types.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/vis_const.h>
 
#include "gl2d_text_interface.h"
#include "gl2d_texts_visibility_state_interface.h"
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DLatin1Texts);
 
 
class AutoStartFinishLatin1TextsEdit;
 
typedef GL2DTextID GL2DLatin1TextID;
static const GL2DLatin1TextID kGL2DUndefinedLatin1TextID = kGL2DUndefinedTextID;
 
enum GL2DLatin1TextsPropertyIDs
{
};
 
class IGL2DLatin1Texts : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetActiveTextPositionsCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetVertexCount() const throw() = 0;
 
  virtual IGL2DFontSP SDK_CALLTYPE GetFont() const throw() = 0;
  inline GL2DFontID SDK_CALLTYPE GetFontID() const
  {
    const IGL2DFontSP font = GetFont();
    return font ? font->GetID() : kGL2DUnknownFontID;
  }
  virtual float SDK_CALLTYPE GetFontSize() const throw() = 0;
  virtual SDKColorF SDK_CALLTYPE GetColor() const throw() = 0;
  virtual GL2DTextReadingDirection SDK_CALLTYPE GetReadingDirection() const throw()
  { return kGL2DTextReadingDirection_LeftToRight; } // Left-to-right only
 
  virtual SDKUInt32 SDK_CALLTYPE GetTextsCount() const throw() = 0;
  virtual GL2DLatin1TextID SDK_CALLTYPE Index2TextID(
    const SDKUInt32& index) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE StartEdit() throw() = 0;
  virtual SDKResult SDK_CALLTYPE FinishEdit() throw() = 0;
  virtual bool SDK_CALLTYPE IsEditing() const throw() = 0;
 
  virtual bool SDK_CALLTYPE IsLatin1Text(
    const SDKString& text_string) const throw() = 0;
 
  virtual GL2DLatin1TextID SDK_CALLTYPE AddText(const SDKString& text_string,
    const SDKPointF2D& text_position, const GL2DTextPivotPoint& pivot_point, 
    const SDKPointF2D& pivot_point_offset) throw() = 0;
  inline GL2DLatin1TextID SDK_CALLTYPE AddText(
    const SDKString& text_string, const SDKPointF2D& text_position)
  {
    const SDKPointF2D pivot_point_offset = { 0.0f, 0.0f };
    return AddText(text_string, text_position, 
      kGL2DTextPivotPoint_Default, pivot_point_offset);
  }
 
  virtual SDKResult SDK_CALLTYPE RemoveText(
    const GL2DLatin1TextID& text_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Toggle(
    const GL2DLatin1TextID& text_id, const bool& visible) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Toggle(
    const IGL2DTextsVisStateSP& texts_visibility_state) throw() = 0;
  virtual SDKResult SDK_CALLTYPE IsVisible(
    const GL2DLatin1TextID& text_id, bool& is_visible) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTextString(
    const GL2DLatin1TextID& text_id, SDKString& text_string) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPosition(
    const GL2DLatin1TextID& text_id, SDKPointF2D& position) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPivotPoint(
    const GL2DLatin1TextID& text_id, GL2DTextPivotPoint& pivot_point) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPivotPointOffset(
    const GL2DLatin1TextID& text_id, SDKPointF2D& pivot_point_offset) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DLatin1Texts)
  SDK_END_INTERFACE(IGL2DLatin1Texts)
};
SDK_DECLARE_IID(IGL2DLatin1Texts)
 
class AutoStartFinishLatin1TextsEdit
{
public:
  AutoStartFinishLatin1TextsEdit(const IGL2DLatin1TextsSP& latin1_texts)
    : m_latin1_texts(latin1_texts), m_started(false)
  {
    if (m_latin1_texts)
      m_started = SDK_SUCCEEDED(m_latin1_texts->StartEdit());
  }
 
  virtual ~AutoStartFinishLatin1TextsEdit()
  { if (m_started) m_latin1_texts->FinishEdit(); }
 
  inline bool IsEditing() const
  { return m_latin1_texts ? m_latin1_texts->IsEditing() : false; }
 
private:
  const IGL2DLatin1TextsSP m_latin1_texts;
  bool                     m_started;
};
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_LATIN1_TEXTS_INTERFACE_H_