Global Enumerations


[view globals]
BooleanConstants
enum BooleanConstants { false=0, 
                        true=1 }

[view globals]
EDeviceMappingMode
enum EDeviceMappingMode { kPixel, 
                          kLowMetric, 
                          kHighMetric, 
                          kLowEnglish, 
                          kHighEnglish, 
                          kTwips }

These enumerators specify how coordinates in an IExtendedRootGrafPort are mapped to the device that displays the graphics.

kPixel
Coordinates are equivalent to pixels on the device
kLowMetric
Coordinates are in units of 0.1 mm
kHighMetric
Coordinates are in units of 0.01 mm
kLowEnglish
Coordinates are in units of 0.01 inch
kHighEnglish
Coordinates are in units of 0.001 inch
kTwips
Coordinates are in units of 1/1440 inch

[view globals]
EMatrixKind
enum EMatrixKind { kModelMatrix, 
                   kViewMatrix }
EMatrixKind for the rendering pipeline.

[view globals]
IExplicitInit
enum IExplicitInit { IINIT }

[view globals]
ITreeIterationOrder
enum ITreeIterationOrder { IPreorder, 
                           IPostorder }


Global Type Definitions


[view globals]
ISemaphoreHandle
typedef ISharedSemaphoreHandle ISemaphoreHandle

[view globals]
ILowEventParameter
typedef IEventData ILowEventParameter

Use the ILowEventParameter class to encapsulate the message parameter (MPARAM) result (MRESULT) data of an event.

ILowEventParameter is an alias of the IEventData class. See IEventData for more information.

In addition, ILowEventParameter is interchangable with the following classes (which are other aliases of the class IEventData):


[view globals]
IThreadHandle
typedef IThreadId IThreadHandle
A typedef for the thread handle host type.

[view globals]
SIZEL
typedef struct tagSIZE SIZEL

[view globals]
UniChar
typedef unsigned short UniChar

[view globals]
_DRAGITEM
typedef IDragItem _DRAGITEM

[view globals]
INativeWindowHandle
typedef unsigned long INativeWindowHandle

[view globals]
IVCollection
typedef IVCollectionImpl IVCollection

[view globals]
IEventParameter2
typedef IEventData IEventParameter2

Use the IEventParameter2 class to encapsulate the message parameter (MPARAM) an result (MRESULT) data of an event.

IEventParameter2 is an alias of the IEventData class. See IEventData for more information.

In addition, IEventParameter2 is interchangable with the following classes (which are other aliases of the class IEventData):


[view globals]
IFileName
typedef IText IFileName

[view globals]
GDegrees
typedef double GDegrees
Angular measure in degrees.

[view globals]
PartialChar
typedef unsigned char PartialChar

[view globals]
IFileSize
typedef long long IFileSize

[view globals]
_DRAGINFO
typedef IDragInfo _DRAGINFO

[view globals]
ITestDecisionFn
typedef bool (ITest::*ITestDecisionFn)()

[view globals]
ILongLong
typedef __int64 ILongLong

[view globals]
IHostPathName
typedef IText IHostPathName

[view globals]
GCoord
typedef double GCoord

[view globals]
IEventParameter1
typedef IEventData IEventParameter1

Use the IEventParameter1 class to encapsulate the message parameter (MPARAM) an result (MRESULT) data of an event.

IEventParameter1 is an alias of the IEventData class. See IEventData for more information.

In addition, IEventParameter1 is interchangable with the following classes (which are other aliases of the class IEventData):


[view globals]
IMenuHandle
typedef IWindowHandle IMenuHandle

[view globals]
CharIntensity
typedef unsigned char CharIntensity

[view globals]
IFileKind
typedef const void * IFileKind

[view globals]
GCoordinate
typedef double GCoordinate
Coordinates in 2-D or 3-D.

[view globals]
_DRAGITEM
typedef IDragItem _DRAGITEM

[view globals]
IReverseConstTextIterator
typedef IReverseIterator < IConstTextIterator , UniChar > IReverseConstTextIterator
IReverseConstTextIterator is the same as IConstTextIterator, except that its ++, --, +=, -=, +, and - operators all move in the opposite of their normal direction. For example, if you have an IConstTextIterator and an IConstReverseTextIterator that refer to the same character, caling ++ on the reverse iterator will point it at the same character as calling -- on the forward iterator. This reversal of direction does not affect the comparison operators, or the - operator that takes two iterators. In other words, if you code the following:
  IReverseConstTextIterator b(a);
  b += 2;
"b < a" would now return true.

The text() and offset() functions are not supported on IReverseConstTextIterator, but an IReverseConstTextIterator can be converted to an IConstTextIterator. Note: IReverseConstTextIterator is currently typedefed as an instantiation of the template class IReverseIterator. Do not use IReverseIterator yourself. It is not considered API and may be replaced with something else in the future.


[view globals]
TokenID
typedef unsigned long TokenID

[view globals]
INativeWindowHandle
typedef void * INativeWindowHandle

[view globals]
ACCEL
typedef struct _ACCEL ACCEL

[view globals]
INativeWindowHandle
typedef _WidgetRec * INativeWindowHandle

[view globals]
Fixed
typedef long Fixed
16.16 Fixed point.

[view globals]
IReverseConstTextIterator
typedef IReverseIterator < IConstTextIterator , UniChar > IReverseConstTextIterator

[view globals]
GIntensity
typedef float GIntensity

[view globals]
IMMSMPTE30DropTime
typedef IMM30FramesPerSecondTime IMMSMPTE30DropTime

[view globals]
ACCEL
typedef struct tagACCEL ACCEL

[view globals]
SIZEL
typedef struct _SIZEL SIZEL

[view globals]
IEventResult
typedef IEventData IEventResult

Use the IEventResult class to encapsulate the message parameter (MPARAM) and message result (MRESULT) data of an event.

IEventResult is an alias of the IEventData class. See IEventData for more information.

In addition, IEventResult is interchangable with the following classes (which are other aliases of the class IEventData):


[view globals]
IFileSize
typedef ILongLong IFileSize

[view globals]
ILongLong
typedef long long ILongLong

[view globals]
INotificationId
typedef const char * INotificationId

[view globals]
IReverseTextIterator
typedef IReverseIterator < ITextIterator , ICharacterReference > IReverseTextIterator

[view globals]
bool
typedef int bool

[view globals]
IReverseTextIterator
typedef IReverseIterator < ITextIterator , ICharacterReference > IReverseTextIterator
IReverseConstTextIterator is the same as IConstTextIterator, except that its ++, --, +=, -=, +, and - operators all move in the opposite of their normal direction. For example, if you have an IConstTextIterator and an IConstReverseTextIterator that refer to the same character, caling ++ on the reverse iterator will point it at the same character as calling -- on the forward iterator. This reversal of direction does not affect the comparison operators, or the - operator that takes two iterators. In other words, if you code the following:
  IReverseConstTextIterator b(a);
  b += 2;
"b < a" would now return true.

The text() and offset() functions are not supported on IReverseConstTextIterator, but an IReverseConstTextIterator can be converted to an IConstTextIterator. Note: IReverseConstTextIterator is currently typedefed as an instantiation of the template class IReverseIterator. Do not use IReverseIterator yourself. It is not considered API and may be replaced with something else in the future.


[view globals]
Fixed
typedef long Fixed

[view globals]
IHighEventParameter
typedef IEventData IHighEventParameter

Use the IHighEventParameter class to encapsulate the message parameter (MPARAM) result (MRESULT) data of an event.

IHighEventParameter is an alias of the IEventData class. See IEventData for more information.

In addition, IHighEventParameter is interchangable with the following classes (which are other aliases of the class IEventData):


[view globals]
GParametric
typedef double GParametric
Parametric value (e.g., of a curve or surface).

[view globals]
]
typedef GParametric BasisMatrix [ 16 ]

[view globals]
HashResult
typedef unsigned long HashResult


Global Variables


[view globals]
gInvalidThreadSlotIndex
const unsigned long gInvalidThreadSlotIndex = 0xFFFFFFFFUL


Global Functions


[view globals]
operator <
bool
  operator <( const ILongLong&,
              unsigned long )

[view globals]
value_type
UniChar*
  value_type( const ITextIterator& )
Returns null. value_type is defined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
operator +
IFastTextIterator
  operator +( const IFastTextIterator& iterator,
              long offset )
Returns an iterator positioned "offset" characters after "iterator." This is the same as IFastTextIterator(iterator) += offset.

[view globals]
operator >=
bool
  operator >=( const IText& a,
               const UniChar* b )
Returns true if a is lexically "greater than or equal to" b. This is the same as IText(a).compare(b) != -1.

[view globals]
operator -
ILongLong
  operator -( const ILongLong&,
              int )

[view globals]
operator /
ILongLong
  operator /( int,
              const ILongLong& )

[view globals]
operator &&
bool
  operator &&( const ILongLong&,
               const ILongLong& )

[view globals]
operator >>
istream&
  operator >>( istream& stream,
               IText& text )
Reads characters from an istream into an IText. The original contents of the IText are replaced with the characters read from the stream, and characters are read from the stream until the stream is exhausted, the size of the IText reaches max_size(), or a whitespace character is detected. The incoming characters are assumed to be in the host character set, and the default host-character-set-to-Unicode transcoder returned by Transcoder::createTranscoder() is used.

[view globals]
operator *
IGPoint2D
  operator *( const IGPoint2D& a,
              const IGPoint2D& b )
Vector multiplication operator.

a
The IGPoint2D to be multiplied.
b
The IGPoint2D by which to multiply the first point.

[view globals]
operator /
ILongLong
  operator /( const ILongLong&,
              long )

[view globals]
copyPointer
AType*
  copyPointer( const AType* source )
Using the user provided copy constructor for the complete class, make a copy of the source object.

[view globals]
operator +
IText
  operator +( const IText& a,
              const UniChar* b )
Concatenates two strings into a new IText. This is the same as IText(a) += b.

[view globals]
operator ^
ILongLong
  operator ^( long,
              const ILongLong& )

[view globals]
operator >
bool
  operator >( const ILongLong&,
              const ILongLong& )

[view globals]
operator <<=
void
  operator <<=( unsigned short& c,
                IDataStream& s )
Read a unsigned short value from an IDataStream. The value is returned to the caller by reference.

[view globals]
value_type
UniChar*
  value_type( const IConstTextIterator& )
Returns null. value_type is defined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
IExcept__assertParameter
void
  IExcept__assertParameter( const char* assertExpression,
                            const IExceptionLocation& location )

[view globals]
operator <<=
void
  operator <<=( short& c,
                IDataStream& s )
Read a short value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator !=
bool
  operator !=( const ILongLong&,
               unsigned long )

[view globals]
operator >=
bool
  operator >=( unsigned long,
               const ILongLong& )

[view globals]
operator <<
ILongLong
  operator <<( const ILongLong&,
               int )

[view globals]
operator ==
bool
  operator ==( const IText& a,
               const UniChar* b )
Returns true if the characters in a exactly match the characters in b. This is the same as IText(a).compare(b) == 0.

[view globals]
operator *
IGPoint2D
  operator *( const GCoordinate num,
              const IGPoint2D& pt )
Scalar multiplication operator.

num
The scalar value.
pt
The IGPoint2D by which to multiply the scalar.

[view globals]
operator +
ILongLong
  operator +( unsigned int,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const ILongLong&,
               unsigned int )

[view globals]
operator +
ILongLong
  operator +( const ILongLong&,
              unsigned long )

[view globals]
operator *
ILongLong
  operator *( unsigned long,
              const ILongLong& )

[view globals]
operator %
ILongLong
  operator %( const ILongLong&,
              unsigned int )

[view globals]
operator &&
bool
  operator &&( unsigned long,
               const ILongLong& )

[view globals]
distance_type
long
  distance_type( const IFastTextIterator& )
Returns 0. distance_type isdefined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
operator <
bool
  operator <( const UniChar* a,
              const IText& b )
Returns true if a is lexically "less than" b. This is the same as IText(a).compare(b) == -1.

[view globals]
operator %
ILongLong
  operator %( const ILongLong&,
              int )

[view globals]
operator &&
bool
  operator &&( long,
               const ILongLong& )

[view globals]
operator ^
ILongLong
  operator ^( const ILongLong&,
              const ILongLong& )

[view globals]
operator *
IGPoint2D
  operator *( const IGPoint2D& pt,
              const GCoordinate num )
Scalar multiplication operator.

pt
The IGPoint2D by which to multiply the scalar.
num
The scalar value.

[view globals]
operator &
ILongLong
  operator &( const ILongLong&,
              int )

[view globals]
operator ==
bool
  operator ==( int,
               const ILongLong& )

[view globals]
operator <<
ostream&
  operator <<( ostream& stream,
               const IText& text )
Writes the characters in an IText out to an ostream. The Unicode character data is translated to the host character set using the default Unicode-to-host-character-set transocder returned by ITranscoder::createTranscoder().

[view globals]
operator >>=
void
  operator >>=( unsigned short c,
                IDataStream& s )
Write a unsigned short value to an IDataStream.

[view globals]
operator ==
bool
  operator ==( const ILongLong&,
               long )

[view globals]
operator >
bool
  operator >( long,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const ILongLong&,
               const ILongLong& )

[view globals]
copy
AType*
  copy( const AType& source )
Using the user provided copy constructor for the complete class, make a copy of the source object.

[view globals]
operator >>=
void
  operator >>=( const ICountedPointerTo < AType >&,
                IDataStream& toStream )

[view globals]
operator >
bool
  operator >( const IText& a,
              const IText& b )
Returns true if a is lexically "greater than" b. This is the same as IText(a).compare(b) == 1.

[view globals]
operator <
bool
  operator <( const ILongLong&,
              int )

[view globals]
operator /
IGPoint2D
  operator /( const IGPoint2D& a,
              const IGPoint2D& b )
Vector division operator.

a
The IGPoint2D to be divided from.
b
The IGPoint2D by which to divide the first point.

[view globals]
operator -
ILongLong
  operator -( const ILongLong&,
              unsigned int )

[view globals]
operator /
ILongLong
  operator /( unsigned int,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const IText& a,
               const UniChar* b )
Returns true if a is lexically "less than or equal to" b. This is the same as IText(a).compare(b) != 1.

[view globals]
operator /
ILongLong
  operator /( const ILongLong&,
              unsigned long )

[view globals]
createStreamTest
IStreamTestOf < AType >*
  createStreamTest( AType* target )
A global function which creates and returns an instance of IStreamTestOf:
             createStreamTest(new ISample(2));
which can be used with the adoptTest method (see the ITestCollection class).

[view globals]
operator ^
ILongLong
  operator ^( unsigned long,
              const ILongLong& )

[view globals]
operator <<=
void
  operator <<=( long& c,
                IDataStream& s )
Read a long value from an IDataStream. The value is returned to the caller by reference.

[view globals]
createComparisonTest
IComparisonTestOf < AType >*
  createComparisonTest( AType* target,
                        AType* unequalTarget )
A global function which creates and returns an instance of IComparisonTestOf:
             createComparisonTest(new ISample(1), new ISample(2));
which can be used with the adoptTest method (see the ITestCollection class).

[view globals]
value_type
UniChar*
  value_type( const IFastTextIterator& )
Returns null. value_type is defined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
swap
void
  swap( IText& a,
        IText& b )
Exchanges the contents of two ITexts. This is the same as a.swap(b).

[view globals]
IExcept__assertState
void
  IExcept__assertState( const char* assertExpression,
                        const IExceptionLocation& location )

[view globals]
operator /
IGPoint2D
  operator /( const IGPoint2D& pt,
              const GCoordinate num )
Scalar division operator.

pt
The IGPoint2D by which to divide the scalar.
num
The scalar value.

[view globals]
operator !=
bool
  operator !=( const ILongLong&,
               int )

[view globals]
operator >=
bool
  operator >=( int,
               const ILongLong& )

[view globals]
operator -
ILongLong
  operator -( const ILongLong&,
              const ILongLong& )

[view globals]
operator >=
bool
  operator >=( const ILongLong&,
               long )

[view globals]
operator <=
bool
  operator <=( long,
               const ILongLong& )

[view globals]
operator +
ILongLong
  operator +( const ILongLong&,
              int )

[view globals]
operator *
ILongLong
  operator *( int,
              const ILongLong& )

[view globals]
operator *
ILongLong
  operator *( const ILongLong&,
              long )

[view globals]
operator %
ILongLong
  operator %( long,
              const ILongLong& )

[view globals]
operator &&
bool
  operator &&( int,
               const ILongLong& )

[view globals]
operator <<=
void
  operator <<=( IStreamablePointer < Element >&,
                IDataStream& )

[view globals]
operator !=
bool
  operator !=( const UniChar* a,
               const IText& b )
Returns true if the characters in a do not exactly match the characters in b. This is the same as IText(a).compare(b) != 0.

[view globals]
operator &
ILongLong
  operator &( const ILongLong&,
              unsigned int )

[view globals]
operator ==
bool
  operator ==( unsigned int,
               const ILongLong& )

[view globals]
operator >>=
void
  operator >>=( long c,
                IDataStream& s )
Write a long value to an IDataStream.

[view globals]
operator ==
bool
  operator ==( const ILongLong&,
               unsigned long )

[view globals]
operator >
bool
  operator >( unsigned long,
              const ILongLong& )

[view globals]
operator <<=
void
  operator <<=( ICountedPointerTo < AType >&,
                IDataStream& fromStream )

[view globals]
IExcept__throwLibraryError
void
  IExcept__throwLibraryError( unsigned long messageId,
                              const IExceptionLocation& location,
                              IBaseErrorInfo::ExceptionType name = IBaseErrorInfo::invalidRequest,
                              IException::Severity severity = IException::recoverable,
                              const char* text = 0 )

[view globals]
operator >>=
void
  operator >>=( const IMStreamable& object,
                IDataStream& s )
Write an IMStreamable object to an IDataStream.

[view globals]
operator <<
bool
  operator <( const ILongLong&,
              unsigned int )

[view globals]
writeAliasedObject
void
  writeAliasedObject( const AType* theObject,
                      IDataStream& theStream )
Polymorphically write an object to an IDataStream. "AType" must descend from IMStreamable and IMRefCounted.

[view globals]
operator -
ILongLong
  operator -( long,
              const ILongLong& )

[view globals]
operator %
ILongLong
  operator %( const ILongLong&,
              const ILongLong& )

[view globals]
operator /
ILongLong
  operator /( const ILongLong&,
              int )

[view globals]
operator &
ILongLong
  operator &( const ILongLong&,
              const ILongLong& )

[view globals]
operator >
bool
  operator >( const IText& a,
              const UniChar* b )
Returns true if a is lexically "greater than" b. This is the same as IText(a).compare(b) == 1.

[view globals]
operator ^
ILongLong
  operator ^( int,
              const ILongLong& )

[view globals]
operator <<=
void
  operator <<=( unsigned long& c,
                IDataStream& s )
Read a unsigned long value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator ^
ILongLong
  operator ^( const ILongLong&,
              long )

[view globals]
operator !=
bool
  operator !=( long,
               const ILongLong& )

[view globals]
operator <
bool
  operator <( const ILongLong&,
              const ILongLong& )

[view globals]
operator +
IText
  operator +( const IText& a,
              const IText& b )
Concatenates two strings into a new IText. This is the same as IText(a) += b.

[view globals]
operator +
ITextIterator
  operator +( long offset,
              const ITextIterator& iterator )
Returns an iterator positioned "offset" characters after "iterator." This is the same as ITextIterator(iterator) += offset.

[view globals]
operator !=
bool
  operator !=( const ILongLong&,
               unsigned int )

[view globals]
operator >=
bool
  operator >=( unsigned int,
               const ILongLong& )

[view globals]
operator >=
bool
  operator >=( const UniChar* a,
               const IText& b )
Returns true if a is lexically "greater than or equal to" b. This is the same as IText(a).compare(b) != -1.

[view globals]
operator <<=
void
  operator <<=( IMStreamable& c,
                IDataStream& s )
Read a IMStreamable value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator >=
bool
  operator >=( const ILongLong&,
               unsigned long )

[view globals]
operator <=
bool
  operator <=( unsigned long,
               const ILongLong& )

[view globals]
operator +
ILongLong
  operator +( const ILongLong&,
              unsigned int )

[view globals]
operator *
ILongLong
  operator *( unsigned int,
              const ILongLong& )

[view globals]
operator +
IText
  operator +( UniChar a,
              const IText& b )
Concatenates two strings into a new IText. This is the same as IText(a) += b.

[view globals]
operator *
ILongLong
  operator *( const ILongLong&,
              unsigned long )

[view globals]
operator %
ILongLong
  operator %( unsigned long,
              const ILongLong& )

[view globals]
operator &&
bool
  operator &&( unsigned int,
               const ILongLong& )

[view globals]
writeObject
void
  writeObject( const AType* theObject,
               IDataStream& theStream )
Polymorphically write an object to an IDataStream. "AType" must descend from IMStreamable.

[view globals]
operator >>=
void
  operator >>=( const IStreamablePointer < Element >&,
                IDataStream& )

[view globals]
operator +
IConstTextIterator
  operator +( long offset,
              const IConstTextIterator& iterator )
Returns an iterator positioned "offset" characters after "iterator." This is the same as IConstTextIterator(iterator) += offset.

[view globals]
operator &&
bool
  operator &&( const ILongLong&,
               long )

[view globals]
operator &
ILongLong
  operator &( long,
              const ILongLong& )

[view globals]
operator !=
bool
  operator !=( const ILongLong&,
               const ILongLong& )

[view globals]
operator ==
bool
  operator ==( const UniChar* a,
               const IText& b )
Returns true if the characters in a exactly match the characters in b. This is the same as IText(a).compare(b) == 0.

[view globals]
operator >>=
void
  operator >>=( unsigned long c,
                IDataStream& s )
Write a unsigned long value to an IDataStream.

[view globals]
operator ==
bool
  operator ==( const ILongLong&,
               int )

[view globals]
operator >
bool
  operator >( int,
              const ILongLong& )

[view globals]
writeObject
void
  writeObject( const ICountedPointerTo < AType >&,
               IDataStream& toStream )

[view globals]
operator >>=
void
  operator >>=( char c,
                IDataStream& s )
Write a char value to an IDataStream.

[view globals]
__applFunc
bool
  __applFunc( void* element,
              void* applicator )

[view globals]
operator +
ILongLong
  operator +( const ILongLong&,
              const ILongLong& )

[view globals]
operator >
bool
  operator >( const ILongLong&,
              long )

[view globals]
operator <
bool
  operator <( long,
              const ILongLong& )

[view globals]
operator <
bool
  operator <( const IText& a,
              const IText& b )
Returns true if a is lexically "less than" b. This is the same as IText(a).compare(b) == -1.

[view globals]
operator -
ILongLong
  operator -( unsigned long,
              const ILongLong& )

[view globals]
operator /
ILongLong
  operator /( const ILongLong&,
              unsigned int )

[view globals]
operator ^
ILongLong
  operator ^( unsigned int,
              const ILongLong& )

[view globals]
operator <
bool
  operator <( const IText& a,
              const UniChar* b )
Returns true if a is lexically "less than" b. This is the same as IText(a).compare(b) == -1.

[view globals]
operator <<=
void
  operator <<=( float& c,
                IDataStream& s )
Read a float value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator ^
ILongLong
  operator ^( const ILongLong&,
              unsigned long )

[view globals]
operator !=
bool
  operator !=( unsigned long,
               const ILongLong& )

[view globals]
operator +
IReverseTextIterator
  operator +( const IReverseTextIterator& iterator,
              long offset )

[view globals]
value_type
UniChar*
  value_type( const IReverseIterator < ARealIterator,
              AReturnType >& )

[view globals]
operator <<=
void
  operator <<=( char& c,
                IDataStream& s )
Read a char value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator >=
bool
  operator >=( const ILongLong&,
               int )

[view globals]
operator <=
bool
  operator <=( int,
               const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const UniChar* a,
               const IText& b )
Returns true if a is lexically "less than or equal to" b. This is the same as IText(a).compare(b) != 1.

[view globals]
operator +
ILongLong
  operator +( long,
              const ILongLong& )

[view globals]
operator /
ILongLong
  operator /( const ILongLong&,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const ILongLong&,
               long )

[view globals]
operator *
ILongLong
  operator *( const ILongLong&,
              int )

[view globals]
operator %
ILongLong
  operator %( int,
              const ILongLong& )

[view globals]
operator +
IFastTextIterator
  operator +( long offset,
              const IFastTextIterator& iterator )
Returns an iterator positioned "offset" characters after "iterator." This is the same as IFastTextIterator(iterator) += offset.

[view globals]
operator &&
bool
  operator &&( const ILongLong&,
               unsigned long )

[view globals]
operator &
ILongLong
  operator &( unsigned long,
              const ILongLong& )

[view globals]
operator >>=
void
  operator >>=( float c,
                IDataStream& s )
Write a float value to an IDataStream.

[view globals]
operator ==
bool
  operator ==( const ILongLong&,
               unsigned int )

[view globals]
operator >
bool
  operator >( unsigned int,
              const ILongLong& )

[view globals]
readObject
void
  readObject( ICountedPointerTo < AType >&,
              IDataStream& fromStream )

[view globals]
operator +
IText
  operator +( const IText& a,
              UniChar b )
Concatenates two strings into a new IText. This is the same as IText(a) += b.

[view globals]
IExcept__throwError
void
  IExcept__throwError( unsigned long messageId,
                       const IExceptionLocation& location,
                       const char* messageFile,
                       IException::ErrorCodeGroup errorGroup,
                       IBaseErrorInfo::ExceptionType name = IBaseErrorInfo::invalidRequest,
                       IException::Severity severity = IException::recoverable,
                       const char* substitutionText = 0 )

[view globals]
operator >>=
void
  operator >>=( signed char c,
                IDataStream& s )
Write a signed char value to an IDataStream.

[view globals]
operator >
bool
  operator >( const ILongLong&,
              unsigned long )

[view globals]
operator <
bool
  operator <( unsigned long,
              const ILongLong& )

[view globals]
operator +
IReverseIterator < ARealIterator , AReturnType >
  operator +( long offset,
              const IReverseIterator < ARealIterator,
              AReturnType >& iterator )

[view globals]
operator -
ILongLong
  operator -( int,
              const ILongLong& )

[view globals]
operator !=
bool
  operator !=( const IText& a,
               const IText& b )
Returns true if the characters in a do not exactly match the characters in b. This is the same as IText(a).compare(b) != 0.

[view globals]
operator -
ILongLong
  operator -( const ILongLong&,
              long )

[view globals]
operator /
ILongLong
  operator /( long,
              const ILongLong& )

[view globals]
operator +
IReverseConstTextIterator
  operator +( const IReverseConstTextIterator& iterator,
              long offset )

[view globals]
operator ==
bool
  operator ==( const ILongLong&,
               const ILongLong& )

[view globals]
copyPointer
AType*
  copyPointer( const ICountedPointerTo < AType >& )

[view globals]
operator <<=
void
  operator <<=( double& c,
                IDataStream& s )
Read a double value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator ^
ILongLong
  operator ^( const ILongLong&,
              int )

[view globals]
operator !=
bool
  operator !=( int,
               const ILongLong& )

[view globals]
operator +
IReverseTextIterator
  operator +( long offset,
              const IReverseTextIterator& iterator )

[view globals]
distance_type
long
  distance_type( const IReverseIterator < ARealIterator,
                 AReturnType >& )

[view globals]
operator <<=
void
  operator <<=( signed char& c,
                IDataStream& s )
Read a signed char value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator >=
bool
  operator >=( const ILongLong&,
               unsigned int )

[view globals]
operator <=
bool
  operator <=( unsigned int,
               const ILongLong& )

[view globals]
operator +
ILongLong
  operator +( unsigned long,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const ILongLong&,
               unsigned long )

[view globals]
operator >
bool
  operator >( const UniChar* a,
              const IText& b )
Returns true if a is lexically "greater than" b. This is the same as IText(a).compare(b) == 1.

[view globals]
operator *
ILongLong
  operator *( const ILongLong&,
              unsigned int )

[view globals]
operator %
ILongLong
  operator %( unsigned int,
              const ILongLong& )

[view globals]
operator +
ITextIterator
  operator +( const ITextIterator& iterator,
              long offset )
Returns an iterator positioned "offset" characters after "iterator." This is the same as ITextIterator(iterator) += offset.

[view globals]
operator +
IReverseIterator < ARealIterator , AReturnType >
  operator +( const IReverseIterator < ARealIterator,
              AReturnType >& iterator,
              long offset )

[view globals]
operator %
ILongLong
  operator %( const ILongLong&,
              long )

[view globals]
operator &&
bool
  operator &&( const ILongLong&,
               int )

[view globals]
operator &
ILongLong
  operator &( int,
              const ILongLong& )

[view globals]
operator >=
bool
  operator >=( const IText& a,
               const IText& b )
Returns true if a is lexically "greater than or equal to" b. This is the same as IText(a).compare(b) != -1.

[view globals]
operator >>=
void
  operator >>=( double c,
                IDataStream& s )
Write a double value to an IDataStream.

[view globals]
operator &
ILongLong
  operator &( const ILongLong&,
              long )

[view globals]
operator ==
bool
  operator ==( long,
               const ILongLong& )

[view globals]
operator >=
bool
  operator >=( const ILongLong&,
               const ILongLong& )

[view globals]
writeAliasedObject
void
  writeAliasedObject( const ICountedPointerTo < AType >&,
                      IDataStream& toStream )

[view globals]
operator >>=
void
  operator >>=( unsigned char c,
                IDataStream& s )
Write a unsigned char value to an IDataStream.

[view globals]
operator !
bool
  operator !( const ILongLong& )

[view globals]
operator >
bool
  operator >( const ILongLong&,
              int )

[view globals]
operator <
bool
  operator <( int,
              const ILongLong& )

[view globals]
readAliasedObject
void
  readAliasedObject( AType *& theResult,
                     IDataStream& theStream )
Polymorphically read an object from an IDataStream. "AType" must descend from IMStreamable and IMRefCounted.

[view globals]
operator +
IText
  operator +( const UniChar* a,
              const IText& b )
Concatenates two strings into a new IText. This is the same as IText(a) += b.

[view globals]
operator *
ILongLong
  operator *( const ILongLong&,
              const ILongLong& )

[view globals]
operator <
bool
  operator <( const ILongLong&,
              long )

[view globals]
operator -
ILongLong
  operator -( unsigned int,
              const ILongLong& )

[view globals]
operator +
IConstTextIterator
  operator +( const IConstTextIterator& iterator,
              long offset )
Returns an iterator positioned "offset" characters after "iterator." This is the same as IConstTextIterator(iterator) += offset.

[view globals]
operator -
ILongLong
  operator -( const ILongLong&,
              unsigned long )

[view globals]
operator /
ILongLong
  operator /( unsigned long,
              const ILongLong& )

[view globals]
operator ==
bool
  operator ==( const IText& a,
               const IText& b )
Returns true if the characters in a exactly match the characters in b. This is the same as IText(a).compare(b) == 0.

[view globals]
operator +
IReverseConstTextIterator
  operator +( long offset,
              const IReverseConstTextIterator& iterator )

[view globals]
operator ^
ILongLong
  operator ^( const ILongLong&,
              unsigned int )

[view globals]
operator !=
bool
  operator !=( unsigned int,
               const ILongLong& )

[view globals]
distance_type
long
  distance_type( const ITextIterator& )
Returns 0. distance_type is defined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
operator !=
bool
  operator !=( const IText& a,
               const UniChar* b )
Returns true if the characters in a do not exactly match the characters in b. This is the same as IText(a).compare(b) != 0.

[view globals]
operator <<=
void
  operator <<=( unsigned char& c,
                IDataStream& s )
Read a unsigned char value from an IDataStream. The value is returned to the caller by reference.

[view globals]
operator !=
bool
  operator !=( const ILongLong&,
               long )

[view globals]
operator >=
bool
  operator >=( long,
               const ILongLong& )

[view globals]
operator >>
ILongLong
  operator >>( const ILongLong&,
               int )

[view globals]
operator +
ILongLong
  operator +( int,
              const ILongLong& )

[view globals]
operator <=
bool
  operator <=( const ILongLong&,
               int )

[view globals]
getline
istream&
  getline( istream& stream,
           IText& text,
           char delimiter = '\n' )
Reads a "line" of characters from a stream into an IText. The original contents of the IText are replaced with the characters read from the stream, and characters are read from the stream until the stream is exhausted, the size of the IText reaches max_size(), or a character matching "delimiter" is read from the stream. The incoming characters are assumed to be in the host character set, and the default host-character-set-to-Unicode transcoder returned by ITranscoder::createTranscoder() is used.

[view globals]
operator +
IGPoint2D
  operator +( const IGPoint2D& a,
              const IGPoint2D& b )
Addition operator.

a
The IGPoint2D to be added.
b
The IGPoint2D to add.

[view globals]
operator +
ILongLong
  operator +( const ILongLong&,
              long )

[view globals]
operator *
ILongLong
  operator *( long,
              const ILongLong& )

[view globals]
operator -
ILongLong
  operator -( const ILongLong& )

[view globals]
readObject
void
  readObject( AType *& theResult,
              IDataStream& theStream )
Polymorphically read an object from an IDataStream. "AType" must descend from IMStreamable.

[view globals]
distance_type
long
  distance_type( const IConstTextIterator& )
Returns 0. distance_type isdefined by STL, which uses it for overload resolution. The actual return value of the function is ignored.

[view globals]
key
const IThreadId&
  key( const INotificationProcessor* object )

[view globals]
operator %
ILongLong
  operator %( const ILongLong&,
              unsigned long )

[view globals]
operator &&
bool
  operator &&( const ILongLong&,
               unsigned int )

[view globals]
operator &
ILongLong
  operator &( unsigned int,
              const ILongLong& )

[view globals]
operator &
ILongLong
  operator &( const ILongLong&,
              unsigned long )

[view globals]
operator ==
bool
  operator ==( unsigned long,
               const ILongLong& )

[view globals]
readAliasedObject
void
  readAliasedObject( ICountedPointerTo < AType >&,
                     IDataStream& fromStream )

[view globals]
operator <=
bool
  operator <=( const IText& a,
               const IText& b )
Returns true if a is lexically "less than or equal to" b. This is the same as IText(a).compare(b) != 1.

[view globals]
operator -
IGPoint2D
  operator -( const IGPoint2D& a,
              const IGPoint2D& b )
Subtraction operator.

a
The IGPoint2D to be subtracted from.
b
The IGPoint2D by which to subtract the first point.

[view globals]
operator >>=
void
  operator >>=( short c,
                IDataStream& s )
Write a short value to an IDataStream.

[view globals]
operator >
bool
  operator >( const ILongLong&,
              unsigned int )

[view globals]
operator <
bool
  operator <( unsigned int,
              const ILongLong& )