#include <IMoveColumnGuideCmdData.h>
Data interface for move column guide command.
- See Also
- kMoveColumnGuideCmdBoss
| virtual const int32 IMoveColumnGuideCmdData::GetColumnIndex | ( | | ) | |
| pure virtual |
Return the column index value from the data interface.
- Returns
- int32 the column index.
| virtual const PMReal& IMoveColumnGuideCmdData::GetColumnLocation | ( | | ) | const |
| pure virtual |
Return the column location value from the data interface.
- Returns
- PMReal& the location value (in points).
| virtual const UIDRef& IMoveColumnGuideCmdData::GetPageUIDRef | ( | | ) | const |
| pure virtual |
Return the targetted page value from the data interface.
- Returns
- UIDRef& a const reference to the targetted page.
| virtual void IMoveColumnGuideCmdData::Set | ( | const UIDRef & | pageUIDRef, | | | const int32 | columnIndex, | | | const PMReal & | columnLocation | | ) | | |
| pure virtual |
Set the new location value for the indicated column guide on the specified page. Automatically adjusts the neighboring column guide (except for first and last column guide on a page, in which case it isn't necessary).
- Parameters
| pageUIDRef | IN UIDRef& a UIDRef for the page that is targetted.. |
| columnIndex | IN int32 the index of the column to change. |
| columnLocation | IN PMReal& the value to use (in points). Relative to left margin (or top of page for J columns). |