Implements a Gopher menu item.

TIdGopherMenuItem = class(TCollectionItem)

TIdGopherMenuItem implements an Internet Gopher menu item as described in the Internet Standards document:

• RFC 1436 - The Internet Gopher Protocol (http://www.rfc-editor.org/rfc/rfc1436.txt)

TIdGopherMenuItem also implements support for the Gopher+ item block as described in the document:

• Gopher+, Upward-Compatible Enhancements to the Internet Gopher protocol (http://boombox.micro.umn.edu/pub/gopher/gopher_protocol/Gopher+/Gopher+.txt)

Summary for the Gopher item.

property AAbstract: TStringList;

AAbstract is a read-only TStringList property that contains a summary for the Gopher item; e.g. "Read about our great products". AAbstract is available if you use the GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

We had to name this property AAbstract because Abstract is a reserved word.

E-Mail address of the gopher item maintainer.

property AdminEMail: TIdEMailAddressItem;

AdminEMail is a read-only String property that identifies the E-Mail address of the person responsible for maintaining the gopher item. AdminEMail is available only when you use the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Values used to prompt the user for specific actions.

property Ask: TIdHeaderList;

Ask is a read-only TIdHeaderList property that contains Gopher+ information used to prompt users for query values. TIdGopher does not support ASK block usage. Ask is available if you use the GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Geographic coordinates for the Gopher server.

property Geog: String;

Geog is a read-only String property used to identify the latitude and longitude of the Gopher server, and is normally found on the Root item. Geog is available if you use the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

The Gopher+ information block.

property GopherBlock: TIdHeaderList;

GopherBlock is a read-only TIdHeaderList property that contains complete extended Gopher+ information block. GopherBlock is available only when using the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Indicates the item is on a Gopher+ server.

property GopherPlusItem: Boolean;

GopherPlusItem is a Boolean property that indicates if the item is on a Gopher+ server. When GopherPlusItem is True, use TIdGopher.GetExtendedMenu to access the Gopher menus.

Indicates the Gopher menu type.

property ItemType: Char;

ItemType is a Char property that indicates the Gopher menu item type. The menu item types are defined in the IdGopherConsts unit are usually the following:

• IdGopherItem_Document - Item is a file

• IdGopherItem_Directory - Item is a directory

• IdGopherItem_CSO - Item is a CSO phone-book server

• IdGopherItem_Error - Error

• IdGopherItem_BinHex - Item is a BinHexed Macintosh file.

• IdGopherItem_BinDOS - Item is DOS binary archive of some sort.

• IdGopherItem_UUE - Item is a UNIX UUEncoded file.

• IdGopherItem_Search - Item is an Index-Search server.

• IdGopherItem_Telnet - Item points to a text-based telnet session.

• IdGopherItem_Binary - Item is a binary file.

• IdGopherItem_Redundant - Item is a redundant server

• IdGopherItem_TN3270 - Item points to a text-based tn3270 session.

• IdGopherItem_GIF - Item is a GIF format graphics file.

• IdGopherItem_Image - Item is some kind of image file.

• IdGopherItem_Image2 - Item is some kind of image file

• IdGopherItem_Sound - An audio file

• IdGopherItem_Sound2 - An audio file

• IdGopherItem_Movie - A movie file

• IdGopherItem_Movie2 - A movie file

• IdGopherItem_HTML - Item is a link to the web-site

• IdGopherItem_MIME - Item is a Base64 encoded file or occasionally, a movie

• IdGopherItem_Information - Item is just some information

Date the Gopher item was last modified.

property LastModified: String;

LastModified is a read-only String property that indicates the date that the Gopher item was last modified. LastModified is available if you use the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Location of the Gopher item.

property Location: String;

Location is a read-only String property that identifies the location of the Gopher item, and is normally found in the Root item. Location is only available if you use the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Organization hosting the Gopher item.

property Organization: String;

Organization is a read-only String property that indicates the organization running the Gopher server for the Gopher item. Organization is normally found in the Root item. Organization is only available if you use the GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Port number for the Gopher item.

property Port: Integer;

Port is an Integer property that indicates the port number to use when requesting the Gopher item. Set the TIdGopher.Port property to this value to retrieve the item.

Value used to select the Gopher item.

property Selector: String;

Selector is a String property that indicates the Gopher query to use when retrieving the Gopher item. Set the TIdGopher.Selector property to this value to retrieve the Gopher item.

For telnet (IdGopherItem_Telnet) and Telnet 3270 (IdGopherItem_TN3270) menu items, this is text which should be displayed to the user because it can provide information for logging into those systems such as a User ID and Password.

Server hosting the Gopher item.

property Server: String;

Server is a String property that identifies the Gopher server that is hosting the Gopher item. Set the Host property to this value when retrieving the Gopher item.

Gopher item title.

property Title: String;

Title is a String property that represents the title for the Gopher item. Title is used to display Gopher item information to the user. Use AAbstract to get a summary of the Gopher item.

HTTP resource location.

property URL: String;

URL is a String property that represents the HTTP Universal Resource Locator (URL) provided in the Gopher+ information block. URL is available if you use the TIdGopher.GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Alternate representations of the GOpher item.

property Views: TStringList;

Views is a read-only TStringList property that contains the Gopher views available for the Gopher item. Gopher Views are alternative forms of a document for different languages or in different formats. Views can be used when requesting the Gopher item with GetFile or GetMenu.

Views are available if you use the GetExtendedMenu method and the Gopher Server supports the Gopher+ protocol.

Constructor for the object instance.

constructor Create(ACollection: TCollection); override;

Owner of the collection item.

Create is the constructor for the object instance, and adds the new TIdGopherMenuItem instance to the collection specified by the ACollection parameter. Create is used internally in TIdGopher.GetMenu and TIdGopher.GetExtendedMenu methods.

Frees the object instance.

destructor Destroy; override;

Destroy is the destructor for the object instance. Destroy is responsible for freeing and releasing properties of the Gopher menu item including AdminEmail, Ask, Abstract, GopherBlock, and Views. Destroy calls the inherited Destroy method to complete destruction of the object instance.

Updates the Gopher menu item after adding information blocks.

procedure DoneSettingInfoBlock; virtual;

DoneSettingInfoBlock is a procedure used to update internal TIdGopherMenuItem variables dealing with Gopher+ Information blocks. These Gopher+ blocks supported are '+VIEWS', '+ABSTRACT', and '+ASK'.

DoneSettingInfoBlock should be called only when all data has been added. This is an internal method used by TIdGopher and should not be used outside of that component.