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

AP_Dialog_Columns Class Reference

#include <ap_Dialog_Columns.h>

Inheritance diagram for AP_Dialog_Columns:
XAP_Dialog_NonPersistent XAP_Dialog AP_CocoaDialog_Columns AP_UnixDialog_Columns AP_Win32Dialog_Columns

List of all members.

Public Types

enum  tAnswer { a_OK, a_CANCEL }

Public Member Functions

 AP_Dialog_Columns (XAP_DialogFactory *pDlgFactory, XAP_Dialog_Id id)
virtual ~AP_Dialog_Columns (void)
virtual void runModal (XAP_Frame *pFrame)=0
virtual void enableLineBetweenControl (bool bState=true)=0
void setColumns (UT_uint32 iColumns)
AP_Dialog_Columns::tAnswer getAnswer (void) const
UT_uint32 getColumns (void) const
void setLineBetween (bool bState)
bool getLineBetween (void) const
double getMaxHeightPercent (void)
double getSpaceAfterPercent (void)
void setColumnOrder (UT_uint32 iOrder)
UT_uint32 getColumnOrder (void) const
const char * getHeightString (void)
const char * getSpaceAfterString (void)
bool isSpaceAfterChanged (void) const
bool isMaxHeightChanged (void) const

Protected Member Functions

void _createPreviewFromGC (GR_Graphics *gc, UT_uint32 width, UT_uint32 height)
void _drawColumnButton (GR_Graphics *gc, UT_Rect rect, UT_uint32 iColumns)
void _convertToPreferredUnits (XAP_Frame *pFrame, const char *sz, gchar *pRet)
void incrementMaxHeight (bool bIncrement)
void incrementSpaceAfter (bool bIncrement)
double getIncrement (const char *sz)
void setViewAndDoc (XAP_Frame *pFrame)
double getPageWidth (void)
double getPageHeight (void)
void setMaxHeight (const char *szHeight)
void setSpaceAfter (const char *szAfter)

Protected Attributes

AP_Dialog_Columns::tAnswer m_answer
AP_Columns_preview * m_pColumnsPreview
AP_Columns_preview_drawer m_previewDrawer

Private Attributes

UT_uint32 m_iColumns
bool m_bLineBetween
UT_uint32 m_iColumnOrder
UT_String m_HeightString
UT_String m_SpaceAfterString
PD_Document * m_pDoc
FV_View * m_pView
bool m_bSpaceAfterChanged
bool m_bMaxHeightChanged
double m_dMarginTop
double m_dMarginBottom
double m_dMarginLeft
double m_dMarginRight

Member Enumeration Documentation

enum AP_Dialog_Columns::tAnswer
Enumerator:
a_OK 
a_CANCEL 

Constructor & Destructor Documentation

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

References DELETEP, and m_pColumnsPreview.

Member Function Documentation

void AP_Dialog_Columns::_convertToPreferredUnits ( XAP_Frame *  pFrame,
const char *  sz,
gchar *  pRet 
) [protected]

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

Parameters:
XAP_Frame * pFrame defined the frame of the application
const char * sz is the string containing the old value
const gchar * pRet is the string to which the new value is copied.

References AP_PREF_KEY_RulerUnits, gchar, XAP_App::getApp(), UT_determineDimension(), and UT_reformatDimensionString().

Referenced by setViewAndDoc().

void AP_Dialog_Columns::_createPreviewFromGC ( GR_Graphics *  gc,
UT_uint32  width,
UT_uint32  height 
) [protected]

References m_bLineBetween, m_iColumns, m_pColumnsPreview, AP_Columns_preview::set(), XAP_Preview::setWindowSize(), and UT_return_if_fail.

Referenced by AP_Win32Dialog_Columns::_onInitDialog(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

void AP_Dialog_Columns::_drawColumnButton ( GR_Graphics *  gc,
UT_Rect  rect,
UT_uint32  iColumns 
) [protected]

References GR_Painter::clearArea(), AP_Columns_preview_drawer::draw(), UT_Rect::height, UT_Rect::left, m_previewDrawer, GR_Graphics::tdu(), UT_Rect::top, and UT_Rect::width.

virtual void AP_Dialog_Columns::enableLineBetweenControl ( bool  bState = true  )  [pure virtual]

Implemented in AP_CocoaDialog_Columns, AP_UnixDialog_Columns, and AP_Win32Dialog_Columns.

Referenced by setColumns().

AP_Dialog_Columns::tAnswer AP_Dialog_Columns::getAnswer ( void   )  const

References m_answer.

Referenced by Defun().

UT_uint32 AP_Dialog_Columns::getColumnOrder ( void   )  const [inline]

Referenced by AP_UnixDialog_Columns::_constructWindowContents(), AP_Win32Dialog_Columns::_onInitDialog(), Defun(), and AP_CocoaDialog_Columns::runModal.

UT_uint32 AP_Dialog_Columns::getColumns ( void   )  const [inline]

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_Win32Dialog_Columns::_onDeltaPos(), AP_Win32Dialog_Columns::_onInitDialog(), Defun(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

const char * AP_Dialog_Columns::getHeightString ( void   ) 

Returns the dimensioned string that defines the maximum height of the Column.

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

References UT_String::c_str(), and m_HeightString.

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_Win32Dialog_Columns::_onDeltaPos(), AP_Win32Dialog_Columns::_onInitDialog(), Defun(), AP_UnixDialog_Columns::doHeightSpin(), AP_UnixDialog_Columns::doMaxHeightEntry(), AP_CocoaDialog_Columns::doMaxHeightEntry, getMaxHeightPercent(), incrementMaxHeight(), AP_CocoaDialog_Columns::incrMaxHeight, AP_UnixDialog_Columns::runModal(), AP_CocoaDialog_Columns::runModal, and setMaxHeight().

double AP_Dialog_Columns::getIncrement ( const char *  sz  )  [protected]

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 incrementMaxHeight(), and incrementSpaceAfter().

bool AP_Dialog_Columns::getLineBetween ( void   )  const [inline]

Referenced by AP_Win32Dialog_Columns::_onInitDialog(), Defun(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

double AP_Dialog_Columns::getMaxHeightPercent ( void   ) 

Returns the 100* the fraction of the total page height in the Maximum height string.

References getHeightString(), getPageHeight(), and UT_convertToInches().

Referenced by AP_Columns_preview::draw().

double AP_Dialog_Columns::getPageHeight ( void   )  [protected]

Returns the current height of the document page.

Returns:
UT_sint32 height of page in inches

References DIM_IN, fp_PageSize::Height(), m_dMarginBottom, m_dMarginTop, PD_Document::m_docPageSize, and m_pDoc.

Referenced by AP_UnixDialog_Columns::_constructWindowContents(), getMaxHeightPercent(), and getSpaceAfterPercent().

double AP_Dialog_Columns::getPageWidth ( void   )  [protected]

Returns the current width of the document page.

Returns:
UT_sint32 width of page in inches

References DIM_IN, m_dMarginLeft, m_dMarginRight, PD_Document::m_docPageSize, m_pDoc, and fp_PageSize::Width().

Referenced by AP_UnixDialog_Columns::_constructWindowContents().

double AP_Dialog_Columns::getSpaceAfterPercent ( void   ) 

Returns the 100* the fraction of the total page height in space after.

References getPageHeight(), getSpaceAfterString(), and UT_convertToInches().

Referenced by AP_Columns_preview::draw().

const char * AP_Dialog_Columns::getSpaceAfterString ( void   ) 

Returns the dimensioned string that defines the space between Columns.

Returns:
const char * dimensioned string which is the space between columns.

References UT_String::c_str(), and m_SpaceAfterString.

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_Win32Dialog_Columns::_onDeltaPos(), AP_Win32Dialog_Columns::_onInitDialog(), Defun(), AP_UnixDialog_Columns::doSpaceAfterEntry(), AP_CocoaDialog_Columns::doSpaceAfterEntry, AP_UnixDialog_Columns::doSpaceAfterSpin(), getSpaceAfterPercent(), incrementSpaceAfter(), AP_CocoaDialog_Columns::incrSpaceAfter, AP_UnixDialog_Columns::runModal(), AP_CocoaDialog_Columns::runModal, and setSpaceAfter().

void AP_Dialog_Columns::incrementMaxHeight ( bool  bIncrement  )  [protected]

Increment the member variable UT_String defining the dimensioned string for the maximum column height.

References UT_String::c_str(), dim, DIM_none, getHeightString(), getIncrement(), m_bLineBetween, m_bMaxHeightChanged, m_HeightString, m_iColumns, m_pColumnsPreview, AP_Columns_preview::set(), UT_convertInchesToDimensionString(), UT_convertToInches(), UT_determineDimension(), and UT_incrementDimString().

Referenced by AP_Win32Dialog_Columns::_onDeltaPos(), AP_UnixDialog_Columns::doHeightSpin(), and AP_CocoaDialog_Columns::incrMaxHeight.

void AP_Dialog_Columns::incrementSpaceAfter ( bool  bIncrement  )  [protected]

Increment the member variable UT_String defining the dimensioned string for the space between columns.

References UT_String::c_str(), dim, DIM_none, getIncrement(), getSpaceAfterString(), m_bLineBetween, m_bSpaceAfterChanged, m_iColumns, m_pColumnsPreview, m_SpaceAfterString, AP_Columns_preview::set(), UT_convertInchesToDimensionString(), UT_convertToInches(), UT_determineDimension(), and UT_incrementDimString().

Referenced by AP_Win32Dialog_Columns::_onDeltaPos(), AP_UnixDialog_Columns::doSpaceAfterSpin(), and AP_CocoaDialog_Columns::incrSpaceAfter.

bool AP_Dialog_Columns::isMaxHeightChanged ( void   )  const [inline]

Referenced by Defun().

bool AP_Dialog_Columns::isSpaceAfterChanged ( void   )  const [inline]

Referenced by Defun().

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

Implements XAP_Dialog_NonPersistent.

Implemented in AP_CocoaDialog_Columns, AP_UnixDialog_Columns, and AP_Win32Dialog_Columns.

Referenced by Defun().

void AP_Dialog_Columns::setColumnOrder ( UT_uint32  iOrder  ) 

References m_iColumnOrder.

Referenced by AP_Win32Dialog_Columns::_onCommand(), Defun(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

void AP_Dialog_Columns::setColumns ( UT_uint32  iColumns  ) 

References enableLineBetweenControl(), m_bLineBetween, m_iColumns, m_pColumnsPreview, and AP_Columns_preview::set().

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_Win32Dialog_Columns::_onDeltaPos(), Defun(), AP_UnixDialog_Columns::event_Toggle(), AP_CocoaDialog_Columns::event_Toggle, and AP_UnixDialog_Columns::readSpin().

void AP_Dialog_Columns::setLineBetween ( bool  bState  ) 

References m_bLineBetween, m_iColumns, m_pColumnsPreview, and AP_Columns_preview::set().

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_UnixDialog_Columns::checkLineBetween(), AP_CocoaDialog_Columns::checkLineBetween, Defun(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

void AP_Dialog_Columns::setMaxHeight ( const char *  szHeight  )  [protected]

Set the member string variable m_HeightString

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

References dim, DIM_none, getHeightString(), m_bLineBetween, m_bMaxHeightChanged, m_HeightString, m_iColumns, m_pColumnsPreview, AP_Columns_preview::set(), UT_convertInchesToDimensionString(), UT_convertToInches(), and UT_determineDimension().

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_UnixDialog_Columns::doMaxHeightEntry(), and AP_CocoaDialog_Columns::doMaxHeightEntry.

void AP_Dialog_Columns::setSpaceAfter ( const char *  szAfter  )  [protected]

Set the member string variable m_SpaceAfterString.

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

References dim, DIM_none, getSpaceAfterString(), m_bLineBetween, m_bSpaceAfterChanged, m_iColumns, m_pColumnsPreview, m_SpaceAfterString, AP_Columns_preview::set(), UT_convertInchesToDimensionString(), UT_convertToInches(), and UT_determineDimension().

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_UnixDialog_Columns::doSpaceAfterEntry(), AP_CocoaDialog_Columns::doSpaceAfterEntry, AP_CocoaDialog_Columns::incrSpaceAfter, and AP_CocoaDialog_Columns::runModal.

void AP_Dialog_Columns::setViewAndDoc ( XAP_Frame *  pFrame  )  [protected]

Sets pointer to the Current View and document. Also sets initial values for space-after and max column height.

Parameters:
XAP_Frame * pFrame - pointer to current Frame.

References _convertToPreferredUnits(), gchar, XAP_Frame::getCurrentView(), FV_View::getDocument(), FV_View::getSectionFormat(), m_dMarginBottom, m_dMarginLeft, m_dMarginRight, m_dMarginTop, m_HeightString, m_pDoc, m_pView, m_SpaceAfterString, PP_getAttribute(), UT_convertToInches(), and UT_DEBUGMSG.

Referenced by AP_Win32Dialog_Columns::runModal(), AP_UnixDialog_Columns::runModal(), and AP_CocoaDialog_Columns::runModal.

Member Data Documentation

AP_Dialog_Columns::tAnswer AP_Dialog_Columns::m_answer [protected]

Referenced by AP_Win32Dialog_Columns::_onCommand(), AP_UnixDialog_Columns::event_Cancel(), AP_CocoaDialog_Columns::event_Cancel, AP_UnixDialog_Columns::event_OK(), AP_CocoaDialog_Columns::event_OK, and getAnswer().

bool AP_Dialog_Columns::m_bLineBetween [private]

Referenced by _createPreviewFromGC(), incrementMaxHeight(), incrementSpaceAfter(), setColumns(), setLineBetween(), setMaxHeight(), and setSpaceAfter().

bool AP_Dialog_Columns::m_bMaxHeightChanged [private]

Referenced by incrementMaxHeight(), and setMaxHeight().

bool AP_Dialog_Columns::m_bSpaceAfterChanged [private]

Referenced by incrementSpaceAfter(), and setSpaceAfter().

double AP_Dialog_Columns::m_dMarginBottom [private]

Referenced by getPageHeight(), and setViewAndDoc().

double AP_Dialog_Columns::m_dMarginLeft [private]

Referenced by getPageWidth(), and setViewAndDoc().

double AP_Dialog_Columns::m_dMarginRight [private]

Referenced by getPageWidth(), and setViewAndDoc().

double AP_Dialog_Columns::m_dMarginTop [private]

Referenced by getPageHeight(), and setViewAndDoc().

UT_String AP_Dialog_Columns::m_HeightString [private]

Referenced by getHeightString(), incrementMaxHeight(), setMaxHeight(), and setViewAndDoc().

UT_uint32 AP_Dialog_Columns::m_iColumnOrder [private]

Referenced by setColumnOrder().

UT_uint32 AP_Dialog_Columns::m_iColumns [private]

Referenced by _createPreviewFromGC(), incrementMaxHeight(), incrementSpaceAfter(), setColumns(), setLineBetween(), setMaxHeight(), and setSpaceAfter().

AP_Columns_preview* AP_Dialog_Columns::m_pColumnsPreview [protected]

Referenced by _createPreviewFromGC(), AP_Win32Dialog_Columns::_onInitDialog(), AP_UnixDialog_Columns::event_previewExposed(), AP_UnixDialog_Columns::event_Toggle(), AP_CocoaDialog_Columns::event_Toggle, incrementMaxHeight(), incrementSpaceAfter(), AP_UnixDialog_Columns::readSpin(), setColumns(), setLineBetween(), setMaxHeight(), setSpaceAfter(), and ~AP_Dialog_Columns().

PD_Document* AP_Dialog_Columns::m_pDoc [private]

Referenced by getPageHeight(), getPageWidth(), and setViewAndDoc().

AP_Columns_preview_drawer AP_Dialog_Columns::m_previewDrawer [protected]

Referenced by _drawColumnButton().

FV_View* AP_Dialog_Columns::m_pView [private]

Referenced by setViewAndDoc().

UT_String AP_Dialog_Columns::m_SpaceAfterString [private]

Referenced by getSpaceAfterString(), incrementSpaceAfter(), setSpaceAfter(), and setViewAndDoc().

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