PdfPublishTextField.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 

//
// PdfPublishTextField.h
//
 
#ifndef _PDF_PUBLISH_TEXTFIELD_INCLUDED_
#define _PDF_PUBLISH_TEXTFIELD_INCLUDED_
 
#include "PdfPublishBaseObject.h"

namespace OdPdfPublish{

class PDFPUBLISH_TOOLKIT OdTextField : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdTextField();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTextField);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END
 
  virtual ~OdTextField();

  void setName(const OdString& name);
  
  void setFont(Text::StandardFontsType fontType);

  void setFont(const OdString& fontName, Text::FontStyle fontStyle = Text::kRegular, Text::Language language = Text::kDefault, bool embed = false);
  
  void setFontSize(OdUInt16 size);
  
  void setTextColor(ODCOLORREF color);
  
  void setTooltip(const OdString& tooltip);
  
  void setVisibility(bool state);
  
  void setPrintability(bool state);
  
  void setLock(bool state);
  
  void setBorder(bool state);
  
  void setBorderColor(ODCOLORREF color);
  
  void setBorderThickness(Border::Thickness thickness);
  
  void setBorderStyle(Border::Style style);
  
  void setFillColor(ODCOLORREF color);
    
  void setDefaultValue(const OdString& value);
  
  void setTextJustification(Text::Justification justification);
  
  void setMultiline(bool state);
  
  void setScrolling(bool state);
  
  void setReadOnly(bool state);
  
  void setTextRotation(Text::Rotation rotation);

  void getName(OdString& name) const;
  
  void getFont(Text::StorageType& storageType, Text::StandardFontsType& fontType, OdString& fontName, Text::FontStyle& fontStyle, Text::Language& language, bool& embed) const;
  
  void getFontSize(OdUInt16& size) const;
  
  void getTextColor(ODCOLORREF& color) const;
  
  void getTooltip(OdString& tooltip) const;
  
  void getVisibility(bool& state) const;
  
  void getPrintability(bool& state) const;
  
  void getLock(bool& state) const;
  
  void getBorder(bool& state) const;
  
  void getBorderColor(ODCOLORREF& color) const;
  
  void getBorderThickness(Border::Thickness& thickness) const;
  
  void getBorderStyle(Border::Style& style) const;
  
  void getFillColor(ODCOLORREF& color) const;
  
  void getDefaultValue(OdString& value) const;
  
  void getTextJustification(Text::Justification& justification) const;
  
  void getMultiline(bool& state) const;
  
  void getScrolling(bool& state) const;
  
  void getReadOnly(bool& state) const;
  
  void getTextRotation(Text::Rotation& rotation) const;
 
};

SMARTPTR(OdTextField);
 
}
#endif // _PDF_PUBLISH_TEXTFIELD_INCLUDED_