[Classes] [Prev] [Next] [Methods]

NListEdit

Protected Data Members

: Constructor, Destructor, and Initializer Methods
: Command Settings
: Inherited Methods

NListEdit

Heritage

Superclass: CNativeList

Subclasses: None

Description

NListEdit is a class that maps to XVT's list edit. NListEdit provides a text field with a small button beside it. Pressing the button invokes a pop-up list box of text items; selecting one of these items and releasing the mouse button causes the selected item to be inserted into the text field.

Usage

Create an instance of this class and initialize it as you would any other native view.

This class does not use the commands set by SetCommand or SetDoubleCommand.

Environment

There are no environment settings for classes that inherit from CNativeView. The drawing properties of native views are system-defined.

Protected Data Members

long itsKeyFocusCmd; The command generated when the keyboard gains focus on the edit field
long itsKeyLostFocusCmd; The command generated when the keyboard loses focus on the edit field
long itsTextCmd; The command generated when the textual contents of the edit field change

Public Methods

Constructor, Destructor, and Initializer Methods

NListEdit(CSubview* theEnclosure, 
	const CRect& theRegion, 	 
	const CStringCollection& theItems, 
	const CStringRW& theTitle = NULLString);

A constructor. theEnclosure is a pointer to the subview that will contain the list edit. theRegion is the size of the control when the list is displayed (not the size of the edit portion of the control). theItems is a list of the strings that the list edit will contain. theTitle is the string that will serve as the title of the native list. This title is the actual item in the edit field that has been selected from the pop-up list of items.

NListEdit(CSubview* theEnclosure, 
	long theContainerId, long theId);

A constructor to instantiate the object from resources.

NListEdit(const NListEdit& theNativeList);

A copy constructor. It duplicates the attributes of a list edit. The items inside the list edit are currently not being copied.

BOOLEAN IListEdit(
	const CStringCollection& theItems, 
	const CStringRW& theTitle = NULLString);

Clears out any text items present in the list, inserts the strings given to theItems, and sets the title.

NListEdit& operator=(const NListEdit& theNativeList);

An assignment operator. It duplicates the attributes of a list edit. The items inside the list edit are currently not being copied.

virtual ~NListEdit();

The destructor.

Command Settings

virtual void SetFocusCommands(
	long theKeyFocusCommand, 
	long theKeyLostFocusCommand);

Within the edit field of the list edit, the keyboard can either gain or lose focus, and commands can be generated in either case. This method sets the commands that are generated when the keyboard gains or loses focus. In each case, a command is sent using the normal DoCommand chain of events.

virtual void SetTextCommand(long theTextCommand);

Allows you to set the command that is generated when the textual contents in the edit field change.

long GetKeyFocusCommand(void) const;

Returns a list edit's keyboard focus command, that is, the command that is generated when the keyboard gains focus on the edit field of the list edit.

long GetKeyFocusLostCommand(void) const;

Returns the command that is generated when the keyboard loses focus on the edit field of the list edit.

long GetTextCommand(void) const;

Returns the command that is generated when the textual contents in the edit field change.

Inherited Methods

virtual void DoHit(CONTROL_INFO theControlInfo);

When the button of the list edit receives a mouse event, this method translates the event into one of three commands that are sent through the DoCommand chain: theKeyFocusCommand, theKeyLostFocusCommand or theTextCommand

virtual CRect GetVisibleFrame(void) const;

Returns the visible frame in coordinates that are relative to the given view.

virtual void Activate(void);

Sets the state of the list edit to active. This means that it is the list edit that will currently receive user input through keyboard or mouse events.

virtual void Deactivate(void);

Sets the state of the list edit to inactive, which means that it is currently not the list edit that will receive user input through keyboard or mouse events.

void GetTextSelection(int *theFirstIndex,
	int *theLastIndex) const;

Returns the indices of the selected text.

void SetTextSelection(int theFirstIndex,
	int theLastIndex);

Selects text starting with the character specified by theFirstIndex and ending with the character specified by theLastIndex.

[Classes] [Prev] [Next] [Methods]

support@xvt.com

Visit our online help desk for tech support

Copyright © 2009, Providence Software Solutions Inc. All rights reserved.