InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IEveInfo Class Referenceabstract

#include <IEveInfo.h>

Inheritance diagram for IEveInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEVEINFO }
 

Public Member Functions

virtual uint32 GetHeight () const =0
 
virtual uint32 GetWidth () const =0
 
virtual void AppendEveDescriptionForControl (PMString *dialogDesc) const =0
 
virtual void ApplyEVELayoutToWidget (const PMPoint &newTopLeft, const PMReal &newWidth, const PMReal &newHeight)=0
 
virtual uint32 GetChildArrangement () const =0
 
virtual void SetChildArrangement (uint32 newArrangement)=0
 
virtual uint32 GetChildAlignment () const =0
 
virtual bool16 GetIncludeForFirstColumnAlignment () const =0
 
virtual bool16 GetDoNotIncludeForAlignmentOfLables () const =0
 
virtual uint32 GetChildSpaceAfter () const =0
 
virtual uint32 GetMargin () const =0
 
virtual void SetMargin (uint32)=0
 
virtual uint32 GetSpaceAfter () const =0
 
virtual void SetSpaceAfter (uint32 newSpaceAfter)=0
 
virtual uint32 GetAlignment () const =0
 
virtual bool16 HasEVEInfo () const =0
 
virtual void AppendEveDescriptionForControlToStdString (std::stringstream &dialogDesc) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for providing the information EVE needs about a widget to properly lay it out in a dialog.

Member Function Documentation

virtual void IEveInfo::AppendEveDescriptionForControl (PMStringdialogDesc) const
pure virtual

Append an EVE express view string describing this widget(& any child widgets)

Parameters
dialogDescspecifies the string to append to
virtual void IEveInfo::AppendEveDescriptionForControlToStdString (std::stringstream & dialogDesc) const
pure virtual
Append an EVE express view string describing this widget(& any child widgets)

Parameters
dialogDescspecifies the string to append to
virtual void IEveInfo::ApplyEVELayoutToWidget (const PMPointnewTopLeft,
const PMRealnewWidth,
const PMRealnewHeight 
)
pure virtual

Apply the changes suggested by EVE to this widget. Usually consists of moving to the new location and resizing to the new size

Parameters
newTopLeftnew top left point to move to (parent relative)
newWidthnew width for this widget
newHeightnew height for this widget
virtual uint32 IEveInfo::GetAlignment () const
pure virtual

report the alignment for this widget

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual uint32 IEveInfo::GetChildAlignment () const
pure virtual

report the child alignment for this widget - only valid for panels

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual uint32 IEveInfo::GetChildArrangement () const
pure virtual

report the child arrangement for this widget - only valid for panels

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual uint32 IEveInfo::GetChildSpaceAfter () const
pure virtual

report the child space after for this widget - only valid for panels

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual bool16 IEveInfo::GetDoNotIncludeForAlignmentOfLables () const
pure virtual

report if this widget specifies not to participate in alignment for column of labels in dialog

Returns
true if static text widget is not to be included for alignment across groups.
virtual uint32 IEveInfo::GetHeight () const
pure virtual

Get the height in pixels of the widget

Returns
height in pixels of this widget. For container widgets(i.e. panels) this is treated by EVE as a minimum height
virtual bool16 IEveInfo::GetIncludeForFirstColumnAlignment () const
pure virtual

report if this panel or this widget has to participate in alignment for first column of labels in dialog

Returns
true if Panel needs to be included for alignment with sibing groups or panels
virtual uint32 IEveInfo::GetMargin () const
pure virtual

report the margin for this widget - only valid for panels

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual uint32 IEveInfo::GetSpaceAfter () const
pure virtual

report the space after for this widget

Returns
a constant from EVEInfo.fh indicating the value for this widget
virtual uint32 IEveInfo::GetWidth () const
pure virtual

Get the width in pixels of the widget. This is typically a measured value for widgets which have a string(i.e. static text, radio buttons, etc)

Returns
width in pixels of this widget. For container widgets(i.e. panels) this is treated by EVE as a minimum width
virtual bool16 IEveInfo::HasEVEInfo () const
pure virtual

Report if this widget has EveInfo filled out.

Returns
true if this widget has EVE info.
virtual void IEveInfo::SetChildArrangement (uint32 newArrangement)
pure virtual

Change the child arrangement for this widget - only valid for panels

Parameters
newArrangementa constant from EVEInfo.fh indicating the value for this widget
virtual void IEveInfo::SetMargin (uint32 )
pure virtual

Set the margin for this widget

Parameters
aconstant from EVEInfo.fh indicating the value for this widget
virtual void IEveInfo::SetSpaceAfter (uint32 newSpaceAfter)
pure virtual

Set the space after for this widget

Parameters
aconstant from EVEInfo.fh indicating the value for this widget