Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes

XAP_Dialog_Image Class Reference

#include <xap_Dlg_Image.h>

Inheritance diagram for XAP_Dialog_Image:
XAP_Dialog_NonPersistent XAP_Dialog XAP_UnixDialog_Image XAP_Win32Dialog_Image

List of all members.

Public Types

enum  tAnswer { a_OK, a_Cancel }

Public Member Functions

 XAP_Dialog_Image (XAP_DialogFactory *pDlgFactory, XAP_Dialog_Id id)
virtual ~XAP_Dialog_Image (void)
virtual void runModal (XAP_Frame *pFrame)=0
void setWrapping (WRAPPING_TYPE iWrap)
void setPositionTo (POSITION_TO iPos)
bool isInHdrFtr (void)
void setInHdrFtr (bool b)
WRAPPING_TYPE getWrapping (void) const
POSITION_TO getPositionTo (void) const
double getWidth () const
double getHeight () const
bool getPreserveAspect () const
void setWidth (double w)
void setHeight (double h)
void setPreserveAspect (bool b)
void setWidth (UT_sint32 w)
void setHeight (UT_sint32 h)
void setMaxHeight (double h)
void setMaxWidth (double w)
double getMaxWidth () const
double getMaxHeight () const
tAnswer getAnswer () const
const char * getHeightString (void)
const char * getWidthString (void)
double getIncrement (const char *sz)
void incrementHeight (bool bIncrement)
void incrementWidth (bool bIncrement)
void setHeight (const char *szHeight)
void setWidth (const char *szWidth)
UT_Dimension getPreferedUnits (void)
void setPreferedUnits (UT_Dimension dim)
void setTightWrap (bool bTight)
bool isTightWrap (void)
void setTitle (const UT_UTF8String &title)
const UT_UTF8String & getTitle () const
void setDescription (const UT_UTF8String &description)
const UT_UTF8String & getDescription () const

Protected Member Functions

void setAnswer (tAnswer ans)
void _convertToPreferredUnits (const char *sz, UT_String &pRet)

Private Member Functions

void setWidth (double w, bool checkaspect)
void setHeight (double h, bool checkaspect)
void setWidthAndHeight (double wh, bool iswidth)

Private Attributes

bool m_bAspect
double m_width
double m_height
double m_maxWidth
double m_maxHeight
tAnswer m_answer
UT_String m_HeightString
UT_String m_WidthString
bool m_bHeightChanged
bool m_bWidthChanged
UT_Dimension m_PreferedUnits
UT_UTF8String m_title
UT_UTF8String m_description
WRAPPING_TYPE m_iWrappingType
POSITION_TO m_iPositionTo
bool m_bInHdrFtr
bool m_bTightWrap

Member Enumeration Documentation

enum XAP_Dialog_Image::tAnswer
Enumerator:
a_OK 
a_Cancel 

Constructor & Destructor Documentation

XAP_Dialog_Image::XAP_Dialog_Image ( XAP_DialogFactory *  pDlgFactory,
XAP_Dialog_Id  id 
)
XAP_Dialog_Image::~XAP_Dialog_Image ( void   )  [virtual]

Member Function Documentation

void XAP_Dialog_Image::_convertToPreferredUnits ( const char *  sz,
UT_String &  pRet 
) [protected]

Converts the string sz into the units seleced for the ruler.

Parameters:
const char * sz is the strinewheightng containing the old value
UT_String & pRet is the string to which the new value is copied.

References gchar, getPreferedUnits(), and UT_reformatDimensionString().

tAnswer XAP_Dialog_Image::getAnswer ( void   )  const [inline]

Referenced by Defun1(), and s_doFormatImageDlg().

const UT_UTF8String& XAP_Dialog_Image::getDescription (  )  const [inline]

Referenced by XAP_UnixDialog_Image::_constructWindow(), XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), and s_doFormatImageDlg().

double XAP_Dialog_Image::getHeight (  )  const [inline]
const char * XAP_Dialog_Image::getHeightString ( void   ) 

Returns the dimensioned string that defines the height of the Image.

Returns:
const char * dimensioned string which is the height of the column.

References UT_String::c_str(), and m_HeightString.

Referenced by XAP_Win32Dialog_Image::_onCommand(), XAP_Win32Dialog_Image::_onDeltaPos(), XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), XAP_UnixDialog_Image::doHeightEntry(), XAP_UnixDialog_Image::doHeightSpin(), incrementHeight(), XAP_UnixDialog_Image::runModal(), s_doFormatImageDlg(), setHeight(), and XAP_UnixDialog_Image::setHeightEntry().

double XAP_Dialog_Image::getIncrement ( const char *  sz  ) 

Returns the increment associated with the dimension defined in the string.

Parameters:
const char * sz the dimensioned string.
Returns:
double - the increment associated with the dimension in sz

References dim, DIM_CM, DIM_IN, DIM_MM, DIM_PI, DIM_PT, DIM_PX, and UT_determineDimension().

Referenced by incrementHeight(), and incrementWidth().

double XAP_Dialog_Image::getMaxHeight (  )  const [inline]
double XAP_Dialog_Image::getMaxWidth (  )  const [inline]
POSITION_TO XAP_Dialog_Image::getPositionTo ( void   )  const [inline]

Referenced by XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), s_doFormatImageDlg(), and XAP_UnixDialog_Image::setPositionToGUI().

UT_Dimension XAP_Dialog_Image::getPreferedUnits ( void   ) 

Returns the current units used for the rulers.

References m_PreferedUnits.

Referenced by _convertToPreferredUnits(), XAP_Win32Dialog_Image::_onCommand(), setHeight(), setWidth(), and setWidthAndHeight().

bool XAP_Dialog_Image::getPreserveAspect (  )  const [inline]

Referenced by XAP_UnixDialog_Image::_constructWindow(), and XAP_Win32Dialog_Image::_onInitDialog().

const UT_UTF8String& XAP_Dialog_Image::getTitle (  )  const [inline]

Referenced by XAP_UnixDialog_Image::_constructWindow(), XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), and s_doFormatImageDlg().

double XAP_Dialog_Image::getWidth (  )  const [inline]
const char * XAP_Dialog_Image::getWidthString ( void   ) 

Returns the dimensioned string that defines the height of the Image.

Returns:
const char * dimensioned string which is the height of the column.

References UT_String::c_str(), and m_WidthString.

Referenced by XAP_Win32Dialog_Image::_onCommand(), XAP_Win32Dialog_Image::_onDeltaPos(), XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), XAP_UnixDialog_Image::doWidthEntry(), XAP_UnixDialog_Image::doWidthSpin(), incrementWidth(), XAP_UnixDialog_Image::runModal(), s_doFormatImageDlg(), setWidth(), and XAP_UnixDialog_Image::setWidthEntry().

WRAPPING_TYPE XAP_Dialog_Image::getWrapping ( void   )  const [inline]

Referenced by XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), s_doFormatImageDlg(), and XAP_UnixDialog_Image::setWrappingGUI().

void XAP_Dialog_Image::incrementHeight ( bool  bIncrement  ) 

Increment the member variable UT_String defining the dimensioned string for the image height.

References UT_String::c_str(), DIM_none, getHeightString(), getIncrement(), m_HeightString, setHeight(), setPreferedUnits(), UT_convertToInches(), UT_determineDimension(), and UT_incrementDimString().

Referenced by XAP_Win32Dialog_Image::_onDeltaPos(), and XAP_UnixDialog_Image::doHeightSpin().

void XAP_Dialog_Image::incrementWidth ( bool  bIncrement  ) 

Increment the member variable UT_String defining the dimensioned string for the image width.

References UT_String::c_str(), DIM_none, getIncrement(), getWidthString(), m_WidthString, setPreferedUnits(), setWidth(), UT_convertToInches(), UT_determineDimension(), and UT_incrementDimString().

Referenced by XAP_Win32Dialog_Image::_onDeltaPos(), and XAP_UnixDialog_Image::doWidthSpin().

bool XAP_Dialog_Image::isInHdrFtr ( void   ) 

References m_bInHdrFtr.

Referenced by XAP_UnixDialog_Image::setPositionToGUI(), and XAP_UnixDialog_Image::setWrappingGUI().

bool XAP_Dialog_Image::isTightWrap ( void   )  [inline]

Referenced by XAP_Win32Dialog_Image::_onInitDialog(), Defun1(), s_doFormatImageDlg(), and XAP_UnixDialog_Image::setWrappingGUI().

virtual void XAP_Dialog_Image::runModal ( XAP_Frame *  pFrame  )  [pure virtual]

Implements XAP_Dialog_NonPersistent.

Implemented in XAP_UnixDialog_Image, and XAP_Win32Dialog_Image.

Referenced by Defun1(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setAnswer ( tAnswer  ans  )  [inline, protected]

Referenced by XAP_Win32Dialog_Image::_onCommand(), XAP_UnixDialog_Image::event_Cancel(), and XAP_UnixDialog_Image::event_Ok().

void XAP_Dialog_Image::setDescription ( const UT_UTF8String &  description  )  [inline]

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), XAP_UnixDialog_Image::event_Ok(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setHeight ( UT_sint32  iHeight  ) 

Set the member string variable m_HeightString from the pixel value of the image. This is to set the initial value if it's not defined.

Parameters:
UT_sint32 iHeight is the pixels height of the image.

References setHeight().

void XAP_Dialog_Image::setHeight ( double  dHeight,
bool  checkaspect 
) [private]

Set the member string variable m_HeightString from the a double value of the image.

Parameters:
double dHeight is the height of the image in inches.

References getPreferedUnits(), m_bAspect, m_height, m_HeightString, m_maxHeight, setWidthAndHeight(), and UT_convertInchesToDimensionString().

void XAP_Dialog_Image::setHeight ( double  h  )  [inline]

References setHeight().

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), XAP_UnixDialog_Image::doHeightEntry(), incrementHeight(), s_doFormatImageDlg(), and setHeight().

void XAP_Dialog_Image::setHeight ( const char *  szHeight  ) 

Set the member string variable m_HeightString

Parameters:
const char * szHeight is the string containing the new value

References dim, DIM_none, getHeightString(), m_bHeightChanged, m_HeightString, setHeight(), setPreferedUnits(), UT_convertToInches(), and UT_determineDimension().

void XAP_Dialog_Image::setInHdrFtr ( bool  b  )  [inline]

Referenced by Defun1(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setMaxHeight ( double  h  )  [inline]

Referenced by Defun1(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setMaxWidth ( double  w  )  [inline]

Referenced by Defun1(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setPositionTo ( POSITION_TO  iPos  ) 

References m_iPositionTo.

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), and XAP_UnixDialog_Image::event_Ok().

void XAP_Dialog_Image::setPreferedUnits ( UT_Dimension  dim  ) 

Sets the prefered units for the dialog.

References m_PreferedUnits.

Referenced by Defun1(), incrementHeight(), incrementWidth(), s_doFormatImageDlg(), setHeight(), and setWidth().

void XAP_Dialog_Image::setPreserveAspect ( bool  b  )  [inline]

Referenced by XAP_Win32Dialog_Image::_onCommand(), and XAP_UnixDialog_Image::aspectCheckbox().

void XAP_Dialog_Image::setTightWrap ( bool  bTight  )  [inline]

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), and XAP_UnixDialog_Image::event_Ok().

void XAP_Dialog_Image::setTitle ( const UT_UTF8String &  title  )  [inline]

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), XAP_UnixDialog_Image::event_Ok(), and s_doFormatImageDlg().

void XAP_Dialog_Image::setWidth ( const char *  szWidth  ) 

Set the member string variable m_HeightString

Parameters:
const char * szWidth is the string containing the new value

References dim, DIM_none, getWidthString(), m_bWidthChanged, m_WidthString, setPreferedUnits(), setWidth(), UT_convertToInches(), and UT_determineDimension().

void XAP_Dialog_Image::setWidth ( double  w  )  [inline]

References setWidth().

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), XAP_UnixDialog_Image::doWidthEntry(), incrementWidth(), s_doFormatImageDlg(), and setWidth().

void XAP_Dialog_Image::setWidth ( double  dWidth,
bool  checkaspect 
) [private]

Set the member string variable m_WidthString from the a double value of the image.

Parameters:
double dWidth is the width of the image in inches.

References getPreferedUnits(), m_bAspect, m_maxWidth, m_width, m_WidthString, setWidthAndHeight(), and UT_convertInchesToDimensionString().

void XAP_Dialog_Image::setWidth ( UT_sint32  iWidth  ) 

Set the member string variable m_WidthString from the pixel value of the image. This is to set the initial value if it's not defined.

Parameters:
UT_sint32 iWidth is the pixel width of the string.

References setWidth().

void XAP_Dialog_Image::setWidthAndHeight ( double  wh,
bool  iswidth 
) [private]

References getPreferedUnits(), m_height, m_HeightString, m_maxHeight, m_maxWidth, m_width, m_WidthString, and UT_convertInchesToDimensionString().

Referenced by setHeight(), and setWidth().

void XAP_Dialog_Image::setWrapping ( WRAPPING_TYPE  iWrap  ) 

References m_iWrappingType.

Referenced by XAP_Win32Dialog_Image::_onCommand(), Defun1(), and XAP_UnixDialog_Image::event_Ok().

Member Data Documentation

tAnswer XAP_Dialog_Image::m_answer [private]
bool XAP_Dialog_Image::m_bAspect [private]

Reimplemented in XAP_UnixDialog_Image.

Referenced by setHeight(), and setWidth().

bool XAP_Dialog_Image::m_bHeightChanged [private]

Referenced by setHeight().

bool XAP_Dialog_Image::m_bInHdrFtr [private]

Referenced by isInHdrFtr().

bool XAP_Dialog_Image::m_bTightWrap [private]
bool XAP_Dialog_Image::m_bWidthChanged [private]

Referenced by setWidth().

UT_UTF8String XAP_Dialog_Image::m_description [private]
double XAP_Dialog_Image::m_height [private]

Referenced by setHeight(), and setWidthAndHeight().

UT_String XAP_Dialog_Image::m_HeightString [private]

Referenced by getHeightString(), incrementHeight(), setHeight(), and setWidthAndHeight().

POSITION_TO XAP_Dialog_Image::m_iPositionTo [private]

Referenced by setPositionTo().

WRAPPING_TYPE XAP_Dialog_Image::m_iWrappingType [private]

Referenced by setWrapping().

double XAP_Dialog_Image::m_maxHeight [private]

Referenced by setHeight(), and setWidthAndHeight().

double XAP_Dialog_Image::m_maxWidth [private]

Referenced by setWidth(), and setWidthAndHeight().

UT_Dimension XAP_Dialog_Image::m_PreferedUnits [private]

Referenced by getPreferedUnits(), and setPreferedUnits().

UT_UTF8String XAP_Dialog_Image::m_title [private]
double XAP_Dialog_Image::m_width [private]

Referenced by setWidth(), and setWidthAndHeight().

UT_String XAP_Dialog_Image::m_WidthString [private]

Referenced by getWidthString(), incrementWidth(), setWidth(), and setWidthAndHeight().

The documentation for this class was generated from the following files:
Generated on Sun Feb 14 2021 for AbiWord by  doxygen 1.7.1