


WEBGIF
Version 0.95

A Component to do Webbing...






















(C) 1995 By E. Cipolloni 
Preliminary Version - NOT to be released
The WEBGIF component has the capability to retrieve and display GIF files retrieved from a give URL from whatever WEB server by using very simple properties and method, without taking care of the underlying TCP/IP connection.

The current version support connections under TCP/IP and  support downloading from a file.

Also, before starting the Delphi environment, make sure that your TCP/IP software and stack is up and running (or better, that your networking protocols are running). WEBGIF support the Microsft WINSOCK DLL, since I'm using standard Winsock calls this should work under other stacks, but I'm not sure. Please report about this.

I've no time to produce a better documentation than a mere list of Properties and Method, final release will have a more decent one.

Properties:

Address
*BasePath
*BeClear
*BevelType
*ButtonLook
Bitmap
ByteLeft
*Color
Completed
Description
*DocumentName
DocClass
DocDateTime
DocLen
DocType
FileName
*FillColor
HttpResponse
HttpVersion
MimeVersion
*JustLoad
Palette
*ProgressiveFill
*Proxy
*ProxyPort
SaveToFile
ServerDateTime
Service
*SkipLines
Surface
*Thickness
*URL
*UseProxy
*Visible
Warning
*WebHost
*WebPort
*WebService


* These properties are modifiable using the Object Inspector

Methods:

Abort
Retrieve

Event handlers:

OnClick
OnConnect
OnDisconnect
OnDragDrop
OnDragOver
OnEnter
OnExit
OnInfo
OnKeyDown
OnKeyPress
OnKeyUp
OnMouseDown
OnMouseMove
OnMouseUp
OnPaint
OnRead
OnSurface




Properties Description


Property Name: Address
Description: Retrieve or sets the address for the Web server in dotted notation
Parameters: On Read/Write: the string containing the address
Read: string variable
Write: string variable

Property Name: BasePath
Description: Retrieve or sets the Base Path for the current document
Parameters: On Read/Write: the string containing the base path
Read: string variable
Write: string variable

Property Name: BeClear
Description: Retrieve or sets the behaviour of the component with transparent GIFS
Parameters: a member of TClearType: Auto, No, Yes
Read: enumerated variable 
Write: enumerated variable

Property Name: BevelType
Description: Retrieve or sets the bevel appearance of the component
Parameters: a member of TBevelType: bsNone, bsRaised, bsLowered
Read: enumerated variable 
Write: enumerated variable

Property Name: ButtonLook
Description: give the component a button-like appearance
Parameters: a True or False value
Read: boolean variable
Write: boolean variable

Property Name: Bitmap
Description: give access to the bitmap maintaned internally by the component
Parameters: none
Read: All permitted by Tbitmap objects 
Write: All permitted by Tbitmap objects

Property Name: BytesLeft
Description: Retrieve the num of bytes that are left  to read from the current doc
Parameters: None
Read: longint variable
Write: Not available


Property Name: Color
Description: Retrieve or sets the canvas color for the component
Parameters: a TColor variable or constant
Read: Tcolor variable 
Write: Tcolor variable

Property Name: Completed
Description: Retrieve the percentage of document reading completed
Parameters: None
Read: integer variable
Write: Not available

Property Name: Description
Description: Retrieve the description of the current WINSOCK.DLL
Parameters: None
Read: string variable
Write: Not available

Property Name: DocClass
Description: Retrieve the class of the current document (first part of MIME field) 
Parameters: None
Read: string variable
Write: Not available

Property Name: DocDateTime
Description: Retrieve the date/time creation of the current document (from Header)
Parameters: None
Read: string variable
Write: Not available

Property Name: DocLen
Description: Retrieve the length (in bytes) fo the current document
Parameters: None
Read: longint variable
Write: Not available

Property Name: DocType
Description: Retrieve the type of the current document (second part of MIME field)
Parameters: None
Read: string variable
Write: Not available

Property Name: DocumentName
Description: Retrieve or Sets the name of the current document or the one to retrieve
Parameters: On Read: NONE; On Write: string variable
Read: string variable
Write: string variable


Property Name: FileName
Description: Retrieve or Sets the name of the file where to document must be saved to
Parameters: On Read: NONE; On Write: string variable
Read: string variable
Write: string variable

Property Name: FillColor
Description: Retrieve or sets the color to fill the canvas of the component
Parameters: On read / write: Tcolor variable
Read: Tcolor variable
Write: Tcolor variable

Property Name: HttpResponse
Description: Retrieve the response of the HTTP daemon returned in the Header
Parameters: None
Read: string variable
Write: Not available

Property Name: HttpVersion
Description: Retrieve the version of HTTP specification followed by the document
Parameters: None
Read: real variable
Write: Not available

Property Name: MimeVersion
Description: Retrieve the version of MIME specification followed by the document
Parameters: None
Read: real variable
Write: Not available

Property Name: JustLoad
Description: If Set to True just retriueve and decompress without displaying
Parameters:On Read / write: boolean value 
Read: boolean value
Write: boolean value

Property Name: Palette
Description: Retrieve or set the palette for rendering the corrent dowloading image
Parameters:On Read / write: Hpal pointer 
Read: Hpal pointer
Write: Hpal pointer

Property Name: ProgressiveFill
Description: Imitate the interlace filling method of NetScape(tm)
Parameters:On Read / write: boolean value 
Read: boolean value
Write: boolean value


Property Name: Proxy
Description: Retrieve or Sets the Proxy Address or Name
Parameters: On Read: name/address of  Proxy; On Write: name/address of Proxy
Read: string variable
Write: string variable
Note: the control can discern automatically from ADDRESS and NAME

Property Name: ProxyPort
Description: Retrieve or Sets the port to be used when connecting to Proxy gateway
Parameters: On Read: the port number; On Write: the port number
Read: integer variable
Write: integer variable

Property Name: SaveToFile
Description: If Set to True save to a file (FileName prop.) the downloaded image 
Parameters:On Read / write: boolean value
Read: boolean value
Write: boolean value

Property Name: ServerDateTime
Description: retrieve the Date and Time from the HTTP server (taken from Header)
Parameters: None
Read: string variable
Write: Not available

Property Name: SkipLines
Description: Teel the component how many lines to  skip befeore begin rendering
Parameters: On Read/write: integer variable
Read: integer variable
Write: integer variable

Property Name: Surface
Description: Same as Bitmap, except that give access BEFORE beginning to rend
Parameters: On Read/write: Tbitmap object
Read: All Tbitmap available methods
Write: All Tbitmap available methods

Property Name: Thickness
Description: Set the thickness of button-like appearance
Parameters: On Read/write: integer variable
Read: integer value
Write: integer value

Property Name: URL
Description: Retrieve or Sets the URL for the current document
Parameters: On Read: a string with the URL; On Write: same as On Read;
Read: string variable
Write: string variable

Property Name: UseProxy
Description: Retrieve or Sets the use of a Proxy gateway
Parameters: On Read: a boolean value; On Write: a boolean value
Read: boolean value;
Write: boolean value

Property Name: Visible
Description: Turn OFF/ON visibility of the component
Parameters: On Read/ Write: a boolean value  
Read: boolean value
Write: boolean value

Property Name: Warning
Description: Retrieve returned warning from the HTTPD server
Parameters: None
Read: string variable
Write: Not available

Property Name: WebHost
Description: Retrieve or Sets the name of the Host Web 
Parameters: On Read: Name/Address of Host; On Write: Name/Address of Host
Read: string variable
Write: string variable

Property Name: Webport
Description: Retrieve or Sets the port of the Host Web 
Parameters: On Read: port of Host; On Write: port of Host
Read: integer variable
Write: integer variable

Property Name: WebService
Description: Retrieve or Sets the name of the service you request from the Web Server 
Parameters: On Read/Write: service name ('FILE', 'HTTP', 'GOPHER', 'FTP')
Read: string variable
Write: string variable


Methods Description:


Method Name: Abort
Description: Stops immediately reading from the Host and shuts down 
Parameters: None
Read: Not available
Write: Not Available

Method Name: Retrieve
Description: Open connection to Host and apply the method you request
Parameters: None
Read: Not available
Write: Not available


Event Handlers Description:

The OnClick, OnDragDrop, OnDragOver, OnEnter, OnExit, OnKeyDown, OnKeyUp, OnKeyPress, OnMouseDown, OnMouseMove, OnMouseUp and OnPaint are like all the other standard event built on many Delphi components. Please refere to Delphi docs for more detailed explanations.

Event Name: OnConnect
Description: This event is called whenever the control has logged to the Host.
                     May be useful to give feedback to the user

Event Namae: OnDisconnect
Description: This event is executed when the Host shuts down the communcation
                     channel. This usually means that the transmission of the document\
                     is finished.

Event Name: OnInfo
Description: This event is executed whenever the WebGif control has info about the
                     document to be retrieved. Some Host send this before sending the
                     actual document, other not (you should use a HEAD method first).
                     The WebGif control is designed to actually control both situations.

Event Name: OnRead
Description: This event is executed whenever the WebGif control begin effectively to
                     read effective document data (Header is excluded from document). This
                     event is usel to give feedback to user, to read data from the control

Event Name: OnSurface
Description: This event is executed whenever the WebGif control is about to begin 	         rendering on the canvas, so you can do more initialization at this point




Sorry for this really brief explanation, but I've not really much time to write documentaion. Attached to this you will find an example Program which, I hope, will give you better chances to understands the working with the Web Component.


Please report bugs and suggestion to:

Emanuele Cipolloni

Leviathan@dlep1.itg.ti.com


Thank you, and enjoy webbing !!!!!!!!!
