DCFactory API Specification v0.2

This document is a work-in-progress. This is up to date with v0.9.1
[ Back to Index ]

TOC/Quick Reference [* Signifies Outgoing Parameter]

Internal API (startup.bas)

DeleteFile (FileName)
CopyFile (From, To)
MoveFile (From, To)

OBJECT: DCFACTORY

Misc Functions:
DCFactory.SetStatusBar (Text)
DCFactory.GetDir (WhatDir, *Out)
DCFactory.ConsoleWrite (Line)
DCFactory.UnZip (FileName, Destinaton, Flags, *Result)
DCFactory.HtmlToText (In, *Out)
DCFactory.ShowURL (URL)
DCFactory.SaveSetting (Section, Name, Value)
DCFactory.LoadSetting (Section, Name, *Value)

Script Maintence Functions (called from *_[un]install Sub):
DCFactory.RegisterTask (Title, Category, DescriptionSub, TaskSub)
DCFactory.RegisterNews (URL, NewsParserSub)
DCFactory.RegisterScript (Type, Name, Version, Description, Install, Uninstall)
DCFactory.RegisterStartup (StartupSub)
DCFactory.UnRegisterNews (URL)
DCFactory.UnRegisterStartup (StartupSub)

Task Functions (usually called from DescriptionSub):
DCFactory.TaskMemoClear
DCFactory.TaskMemoAdd (Line)
DCFactory.SetTaskUrls (DownloadURL, VisitURL)

News-Related Functions (called from NewsParserSub)
DCFactory.NewsAddArticle (Date, Author, Title, *ID)
DCFactory.NewsArticleText (ID, Text)

DLL-Related functions (v0.9.1 only, really beta)
DCFactory.RegisterDLL (PathToDLL, name)
DCFactory.CallDLL (name, Method, Params, *Return)

OBJECT: Wizard

Misc Functions:
Wizard.Show
Wizard.Hide
Wizard.SetTitle (Title)
Wizard.SetCallback (CallbackSub)
Wizard.SetPageNum (Num)
Wizard.SetButtonCaptions (Cancel, Back, Next)
Wizard.SetButtonEnabled (Cancel, Back, Next)
Wizard.SetSidebar (Filename)

Pre-defined Page Manipulation (usually called from CallbackSub)
Wizard.SetPageWelcome (Heading, Text)
Wizard.SetPageDirectory (Heading)
Wizard.SetPageFilename (Heading, DialogCaption, DialogFilter, DefaultFilename, Manditory)
Wizard.SetPageOutput (Nero, ISO, CDRWin)
Wizard.SetPageProgress (Action, Percent)
Wizard.SetPageSaveFile (Heading, Caption, Filter)
Wizard.GetPageDirectory (*Directory)
Wizard.GetPageFilename (*Filename)
Wizard.GetPageOutput(*Filename, *Format, *Autolaunch)
Wizard.GetPageSaveFile (*Filename)

Custom Page Manipulation
Wizard.SetPageCustom (Clear)
Wizard.AddCustomObject (objtype, parentID, top, left, width, height, *ID)
Wizard.RemoveCustomObject (ID)
Wizard.COSetProperty (ID, name, value)
Wizard.COGetProperty (ID, name, value*)