epoc32/include/txtfrmat.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
TBool TTabStop::operator!=(const TTabStop& aTabStop)const
williamr@2
    21
/** Compares two tab stops for inequality. They are different if the twips 
williamr@2
    22
position or alignment is different.
williamr@2
    23
williamr@2
    24
@param aTabStop The tab stop to compare with the current tab stop 
williamr@2
    25
@return ETrue if the objects' twips position or alignment differs. EFalse if 
williamr@2
    26
equal. */
williamr@2
    27
	{return !(*this==aTabStop);}
williamr@2
    28
williamr@2
    29
williamr@2
    30
TBool TParaBorder::operator!=(const TParaBorder& aParaBorder)const
williamr@2
    31
/**  Compares two paragraph border sides for inequality. Two paragraph border 
williamr@2
    32
sides are different if any of their data members are different.
williamr@2
    33
williamr@2
    34
@param aBorder The paragraph border to compare with the current border.
williamr@2
    35
@return ETrue if the two paragraph border sides are different, 
williamr@2
    36
EFalse if not. */
williamr@2
    37
	{return !(*this==aParaBorder);}
williamr@2
    38
williamr@2
    39
 
williamr@2
    40
TBool TBullet::operator!=(const TBullet& aBullet)const
williamr@2
    41
/** Compares two bullet points for inequality. Two bullet points are unequal if 
williamr@2
    42
any of their data members are different.
williamr@2
    43
williamr@2
    44
@param aBullet The bullet point to compare. 
williamr@2
    45
@return ETrue if the two bullet points are different, EFalse if not. */
williamr@2
    46
	{return !(*this==aBullet);}
williamr@2
    47
williamr@2
    48
williamr@2
    49
 
williamr@2
    50
void CParaFormat::RemoveAllTabs()
williamr@2
    51
/** Removes all tab stops from the object. */
williamr@2
    52
	{
williamr@2
    53
	if (iTabList)
williamr@2
    54
		{
williamr@2
    55
		delete iTabList;
williamr@2
    56
		iTabList = NULL;
williamr@2
    57
		}
williamr@2
    58
	}
williamr@2
    59
williamr@2
    60
 
williamr@2
    61
TInt CParaFormat::TabCount()const
williamr@2
    62
/** Gets a count of the total number of tab stops in the object's tab list. If 
williamr@2
    63
the object has no tab list, returns zero.
williamr@2
    64
williamr@2
    65
@return The number of tab stops. */
williamr@2
    66
	{return (iTabList)?iTabList->Count():0;}
williamr@2
    67
williamr@2
    68
williamr@2
    69
 
williamr@2
    70
williamr@2
    71
TParaFormatMask::TParaFormatMask()
williamr@2
    72
	:iGuard(0)
williamr@2
    73
/** The default C++ constructor constructs a paragraph format mask, initialising 
williamr@2
    74
all bits to zero. */
williamr@2
    75
	{}
williamr@2
    76
williamr@2
    77
 
williamr@2
    78
void TParaFormatMask::SetAttrib(TTextFormatAttribute aAttribute)
williamr@2
    79
/** Sets a single attribute flag in the paragraph format mask.
williamr@2
    80
williamr@2
    81
@param aAttribute The attribute flag to set. */
williamr@2
    82
	{iGuard|=(1<<aAttribute);}
williamr@2
    83
williamr@2
    84
 
williamr@2
    85
williamr@2
    86
void TParaFormatMask::ClearAttrib(TTextFormatAttribute aAttribute)
williamr@2
    87
/** Clears a single attribute flag in the paragraph format mask.
williamr@2
    88
williamr@2
    89
@param aAttribute The attribute flag to clear. */
williamr@2
    90
	{iGuard&=~(1<<aAttribute);}
williamr@2
    91
williamr@2
    92
 
williamr@2
    93
williamr@2
    94
TBool TParaFormatMask::AttribIsSet(TTextFormatAttribute aAttribute)const
williamr@2
    95
/** Tests whether an attribute flag is set.
williamr@2
    96
williamr@2
    97
@param aAttribute The paragraph format attribute to test for. 
williamr@2
    98
@return ETrue if the flag is set, EFalse if not. */
williamr@2
    99
	{return (iGuard&(1<<aAttribute));}
williamr@2
   100
williamr@2
   101
 
williamr@2
   102
williamr@2
   103
TBool TParaFormatMask::IsNull()const
williamr@2
   104
/** Tests whether the mask is NULL, indicating that no flags have been set.
williamr@2
   105
williamr@2
   106
@return ETrue if mask is NULL, EFalse if not NULL. */
williamr@2
   107
	{return !iGuard;}
williamr@2
   108
williamr@2
   109
 
williamr@2
   110
TBool TParaFormatMask::operator!=(const TParaFormatMask& aMask)const
williamr@2
   111
/** Compares two paragraph format masks for inequality.
williamr@2
   112
williamr@2
   113
@param aMask The mask to compare. 
williamr@2
   114
@return ETrue if any flags are different. EFalse if all flags are the same. */
williamr@2
   115
	{return !(*this==aMask);}
williamr@2
   116
williamr@2
   117
williamr@2
   118
 
williamr@2
   119
williamr@2
   120
TCharFormatMask::TCharFormatMask()
williamr@2
   121
	:iGuard(0)
williamr@2
   122
/** The default C++ constructor constructs a character format mask, initialising 
williamr@2
   123
all bits to zero. */
williamr@2
   124
	{}
williamr@2
   125
williamr@2
   126
 
williamr@2
   127
williamr@2
   128
void TCharFormatMask::SetAttrib(TTextFormatAttribute aAttribute)
williamr@2
   129
/** Sets a single attribute flag in the character format mask.
williamr@2
   130
williamr@2
   131
@param aAttribute The attribute flag to set. */
williamr@2
   132
	{iGuard|=(1<<((aAttribute-KMaxParaAttributes)-1));}
williamr@2
   133
williamr@2
   134
 
williamr@2
   135
void TCharFormatMask::ClearAttrib(TTextFormatAttribute aAttribute)
williamr@2
   136
/** Clears a single attribute flag in the character format mask.
williamr@2
   137
williamr@2
   138
@param aAttribute The attribute flag to clear. */
williamr@2
   139
	{iGuard&=~(1<<((aAttribute-KMaxParaAttributes)-1));}
williamr@2
   140
williamr@2
   141
 
williamr@2
   142
williamr@2
   143
TBool TCharFormatMask::AttribIsSet(TTextFormatAttribute aAttribute)const
williamr@2
   144
/** Tests whether an attribute flag is set.
williamr@2
   145
williamr@2
   146
@param aAttribute The character format attribute to test for. 
williamr@2
   147
@return ETrue if the flag is set, EFalse if not. */
williamr@2
   148
	{return iGuard&(1<<((aAttribute-KMaxParaAttributes)-1));}
williamr@2
   149
williamr@2
   150
 
williamr@2
   151
TBool TCharFormatMask::IsNull()const
williamr@2
   152
/** Tests whether the mask is NULL, indicating that no flags have been set.
williamr@2
   153
williamr@2
   154
@return ETrue if mask is NULL, EFalse if not NULL. */
williamr@2
   155
	{return !iGuard;}
williamr@2
   156
williamr@2
   157
 
williamr@2
   158
TBool TCharFormatMask::operator!=(const TCharFormatMask& aMask)const
williamr@2
   159
/** Compares two paragraph format masks for inequality.
williamr@2
   160
williamr@2
   161
@param aMask The mask to compare. 
williamr@2
   162
@return ETrue if any flags are different. EFalse if all flags are the same. */
williamr@2
   163
	{return !(*this==aMask);}
williamr@4
   164
williamr@4
   165