Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

NameDialogParam Class Reference

Allows a string (the Name) to enter and emerge from a NameDialog, and tells us if the dialog was cancelled. More...

#include <namedlg.h>

Inheritance diagram for NameDialogParam:

OpParam CCObject SimpleCCObject List of all members.

Public Member Functions

 NameDialogParam ()
BOOL DialogCancelled ()
void SetDialogCancelled ()
BOOL SetNameGiven (const StringBase &StringEntered)
 Data access.
const StringBase & GetNameEntered () const
StringBase & GetNameEntered ()

Private Member Functions

 CC_DECLARE_MEMDUMP (NameDialogParam)

Private Attributes

String_256 m_StringEntered
BOOL m_Cancelled

Detailed Description

Allows a string (the Name) to enter and emerge from a NameDialog, and tells us if the dialog was cancelled.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from MarkN)
Date:
20/07/97
See Also: NameDialog::Invoke()

Definition at line 121 of file namedlg.h.

Constructor & Destructor Documentation

NameDialogParam::NameDialogParam (   )  [inline]
 

Definition at line 126 of file namedlg.h.

00126 : m_Cancelled(FALSE)    {}

Member Function Documentation

NameDialogParam::CC_DECLARE_MEMDUMP (  NameDialogParam   )  [private]
 

BOOL NameDialogParam::DialogCancelled (   )  [inline]
 

Definition at line 128 of file namedlg.h.

00128 {   return m_Cancelled; }

StringBase& NameDialogParam::GetNameEntered (   )  [inline]
 

Definition at line 133 of file namedlg.h.

00133 {   return m_StringEntered; }

const StringBase& NameDialogParam::GetNameEntered (   )  const [inline]
 

Definition at line 132 of file namedlg.h.

00132 {   return m_StringEntered; }

void NameDialogParam::SetDialogCancelled (   )  [inline]
 

Definition at line 129 of file namedlg.h.

00129 {   m_Cancelled = TRUE; }

BOOL NameDialogParam::SetNameGiven (  const StringBase &  StringEntered  ) 
 

Data access.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from MarkN)
Date:
13/07/97
Returns:
TRUE if the whole string were copied, FALSE if not

Definition at line 148 of file namedlg.cpp.

00149 {
00150     BOOL AllCopied = TRUE;      // return this
00151 
00152     UINT32 LengthToCopy = 0;
00153     if (StringEntered.Length() <= m_StringEntered.MaxLength())
00154     {
00155         LengthToCopy = StringEntered.Length();
00156     }
00157     else
00158     {
00159         AllCopied = FALSE;
00160         LengthToCopy = m_StringEntered.MaxLength();
00161     }
00162 
00163     StringEntered.Left(&m_StringEntered, LengthToCopy);
00164 
00165     return AllCopied;
00166 }

Member Data Documentation

BOOL NameDialogParam::m_Cancelled [private]
 

Definition at line 137 of file namedlg.h.

String_256 NameDialogParam::m_StringEntered [private]
 

Definition at line 136 of file namedlg.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:56:23 2007 for Camelot by  doxygen 1.4.4