THelpViewer class
Base class for help viewers used in the LCL help system.
Declaration
THelpViewer = class(TComponent)Inheritance
- THelpViewer
- TComponent
- TPersistent
- TObject
Descends from it: THTMLBrowserHelpViewer
Description
THelpViewer is a
TComponent descendant that provides
the interface used for help viewers in the LCL help system. THelpViewer
provides properties and methods used to access and display help topics using
their corresponding help nodes, including a Table of Contents. Most methods
are declared as virtual and should be overridden in descendent class that
handle specific MIME types.
Methods are provided to register and unregister the help viewer for a specific MIME type. The AutoRegister property controls whether the viewer is automatically registered at run-time.
Use classes like TCHMHelpViewer, THTMLHelpViewer, THTMLBrowserHelpViewer, and THelpConnector for help databases that use the specific MIME types for the respective classes.
See also
Properties
SupportedMimeTypes | public | Contains MIME types supported in the help viewer. |
ParameterHelp | public | Contains a help message describing how parameters are used in the help viewer. |
StorageName | public | Indicates the storage used for configuration settings in the help viewer. |
AutoRegister | public | Indicates if the help viewer is automatically registered at run-time. |
Methods
SetSupportedMimeTypes | protected | Sets the value in the SupportedMimeTypes property. |
AddSupportedMimeType | protected | Adds the specified MIME type to the SupportedMimeTypes property. |
Create | public | Constructor for the class instance. |
Destroy | public | Destructor for the class instance. |
SupportsTableOfContents | public | Indicates if the help viewer can display a table of contents for the specified help node. |
ShowTableOfContents | public | Displays the table of contents for the specified help node. |
SupportsMimeType | public | Indicates if the specified MIME type exists in the SupportedMimeTypes property. |
ShowNode | public | Displays the help topic for the specified help node. |
Hide | public | Hides the help viewer. |
Assign | public | Assigns property values from the specified source to the current class instance. |
Load | public | Loads configuration settings for the help viewer from the specified storage. |
Save | public | Saves configuration settings to the specified storage. |
GetLocalizedName | public | Gets the localized name for the help viewer. |
RegisterSelf | public | Registers the help viewer for use in the LCL help system. |
UnregisterSelf | public | Unregisters the help viewer in the LCL help system. |
Inherited
From TComponent (74)
_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState
From TPersistent (4)
AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers
From TObject (37)
AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.