#include <IAdaptiveLayoutPrefsCmdData.h>
Interface for setting and getting data for the kSetAdaptiveLayoutPrefsCmdBoss command.
| virtual const bool16 IAdaptiveLayoutPrefsCmdData::GetAdaptiveLayoutOn | ( | | ) | const |
| pure virtual |
Returns the on/off state of layout adjustment.
- Returns
- kTrue for on, kFalse for off
| virtual const UIDRef& IAdaptiveLayoutPrefsCmdData::GetDocument | ( | | ) | const |
| pure virtual |
Returns the document reference for which the change is to be made.
- Returns
- Reference to the document for which the change is to be made.
| virtual PMReal IAdaptiveLayoutPrefsCmdData::GetMaximumFontSize | ( | | ) | const |
| pure virtual |
Get the Maximum font size set by user.
- Returns
- the Maximum font size value
| virtual PMReal IAdaptiveLayoutPrefsCmdData::GetMinimumFontSize | ( | | ) | const |
| pure virtual |
Get the Minimum font size set by user.
- Returns
- the minimum font size value
| virtual const bool16 IAdaptiveLayoutPrefsCmdData::GetScaleLockedPageItems | ( | | ) | const |
| pure virtual |
Get whether locked items can be adjusted by layout adjustment.
- Returns
- kTrue for allow adjusting locked items, kFalse for disallow
| virtual bool16 IAdaptiveLayoutPrefsCmdData::IsAutoAdjustMarginsOn | ( | | ) | |
| pure virtual |
Set the value of option to adjust margin automatically based on page size changes.
- Returns
- kTrue if the option is to be turned on.
| virtual bool16 IAdaptiveLayoutPrefsCmdData::IsFontSizeandLeadingOn | ( | | ) | const |
| pure virtual |
Get value which signifies whether the text adjustment is to be turned on or not.
- Returns
- kTrue if the text is to be adjusted.
| virtual bool16 IAdaptiveLayoutPrefsCmdData::IsFontSizeLimitOn | ( | | ) | const |
| pure virtual |
Returns the on/off state of Scale font Size limit.
- Returns
- kTrue for on, kFalse for off
| virtual void IAdaptiveLayoutPrefsCmdData::Set | ( | const UIDRef & | doc, | | | bool16 | bAdaptiveLayoutOn, | | | bool16 | bScaleLockedPageItems, | | | bool16 | bFontSizeandLeadingOn, | | | bool16 | bFontSizeLimitOn, | | | PMReal | rFontMinimunSize, | | | PMReal | rFontMaximumSize, | | | bool16 | bAutoAdjustMargin | | ) | | |
| pure virtual |
Set all the values at once.
- Parameters
| doc | IN a reference to the document whose preferences are being set. |
| bAdaptiveLayoutOn | IN kTrue to turn on, kFalse to turn off. |
| bScaleLockedPageItems | IN kTrue to allow adjusting locked items, kFalse to disallow. |
| bFontSizeandLeadingOn | IN kTrue to facilitate font size limit , else not. |
| bFontSizeLimitOn | IN kTrue to facilitate minimum font size and maximum font size , else not. |
| rFontMinimunSize | IN minimum size of the font for the doc . |
| rFontMaximumSize | IN Maximum size of the font for the doc. |
| bAutoAdjustMargin | IN kTrue to auto adjust the margins based on the changes in the page size. Please note that this would only be effective when worked through Adjust Layout dialog. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetAdaptiveLayoutOn | ( | bool16 | val | ) | |
| pure virtual |
Enable the Layout Adjustment feature.
- Parameters
| val | IN kTrue to turn on, kFalse to turn off. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetAutoAdjustMargins | ( | bool16 | val | ) | |
| pure virtual |
Set the option to adjust margin automatically based on page size changes. This will only work when triggered from the Margin and column dialog.
- Parameters
| val | IN kTrue if the option is to be turned on. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetDocument | ( | UIDRef | docRef | ) | |
| pure virtual |
Set the document reference for which the options are to be set.
- Parameters
| docRef | IN the document reference |
| virtual void IAdaptiveLayoutPrefsCmdData::SetFontSizeandLeadingOn | ( | bool16 | val | ) | |
| pure virtual |
Sets whether text is to be adjusted or not.
- Parameters
| val | IN kTrue to allow adjusting of text |
| virtual void IAdaptiveLayoutPrefsCmdData::SetFontSizeLimitOn | ( | bool16 | val | ) | |
| pure virtual |
Sets whether a font size limit is to be enforced during the text adjustment.
- Parameters
| val | IN kTrue to adjust text within the specified limits. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetMaximumFontSize | ( | PMReal | val | ) | |
| pure virtual |
Set the maximum font size to decide the limits for text adjustment.
- Parameters
| val | IN value of maximum font size. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetMinimumFontSize | ( | PMReal | val | ) | |
| pure virtual |
Set the minimum font size to decide the limits for text adjustment.
- Parameters
| val | IN value of minimum font size. |
| virtual void IAdaptiveLayoutPrefsCmdData::SetScaleLockedPageItems | ( | bool16 | val | ) | |
| pure virtual |
Allow locked items to be adjusted by layout adjustment.
- Parameters
| val | IN kTrue to allow adjusting locked items, kFalse to disallow |