Difference between revisions of "TWebStatusMain"
From Ultibo.org
								
												
				| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>  | |colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>  | ||
|-  | |-  | ||
| − | | <code>constructor Create;</code>  | + | | <code>constructor Create(AListener:THTTPListener; const AHost,AURL:String; ARedirect:Boolean);</code>  | 
| style="width: 50%;"|   | | style="width: 50%;"|   | ||
|-  | |-  | ||
| Line 35: | Line 35: | ||
|    | |    | ||
|-  | |-  | ||
| − | | <code>  | + | | <code>FPages:TStringList;</code>  | 
| + | |    | ||
| + | |-  | ||
| + | | <code>FLoginPage:TWebStatusLogin;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>FLogoutPage:TWebStatusLogout;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>FRedirectPage:THTTPRedirect;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>FHost:String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>FListener:THTTPListener;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>FFontName:String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>FAllowRestart:Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>FAllowShutdown:Boolean;</code>  | ||
|    | |    | ||
|-  | |-  | ||
| Line 50: | Line 78: | ||
|-  | |-  | ||
|colspan="2"|   | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>function GetHost:String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>function GetFontName:String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>procedure SetFontName(const AFontName:String);</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function NormalizedDateToStr(const DateTime:TDateTime):String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function NormalizedTimeToStr(const DateTime:TDateTime):String;</code>  | ||
| + | |    | ||
|-  | |-  | ||
| <code>function NormalizedDateTimeToStr(const DateTime:TDateTime):String;</code>  | | <code>function NormalizedDateTimeToStr(const DateTime:TDateTime):String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>function NormalizedIntervalToStr(const DateTime:TDateTime):String;</code>  | ||
|    | |    | ||
|-  | |-  | ||
| Line 60: | Line 110: | ||
|-  | |-  | ||
| <code>function MakeLink(const AName,ALink:String):String;</code>  | | <code>function MakeLink(const AName,ALink:String):String;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>procedure AddRemoteAction(AResponse:THTTPServerResponse);</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>procedure AddConfirmAction(AResponse:THTTPServerResponse);</code>  | ||
|    | |    | ||
|-  | |-  | ||
| Line 140: | Line 198: | ||
|-  | |-  | ||
| <code>function DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; override;</code>  | | <code>function DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; override;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|   | ||
| + | |-  | ||
| + | | <code>function DoAuthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthenticated:Boolean):Boolean; override;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function DoDeauthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var ADeauthenticated:Boolean):Boolean; override;</code>  | ||
|    | |    | ||
|-  | |-  | ||
| Line 152: | Line 218: | ||
|colspan="2"|     | |colspan="2"|     | ||
|-  | |-  | ||
| − | | <code>  | + | | <code>property Host:String read GetHost;</code>  | 
|    | |    | ||
|-  | |-  | ||
| − | | <code>function   | + | | <code>property Listener:THTTPListener read FListener;</code>  | 
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|    | ||
| + | |-  | ||
| + | | <code>property FontName:String read GetFontName write SetFontName;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>property AllowRestart:Boolean read FAllowRestart write FAllowRestart;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>property AllowShutdown:Boolean read FAllowShutdown write FAllowShutdown;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|    | ||
| + | |-  | ||
| + | | <code>function RegisterPage(APage:TWebStatusPage):Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function DeregisterPage(APage:TWebStatusPage):Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|    | ||
| + | |-  | ||
| + | | <code>function RegisterPages:Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function DeregisterPages:Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |colspan="2"|    | ||
| + | |-  | ||
| + | | <code>function EnableUserAuthentication(AUserAuthenticator:TAuthenticator):Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function EnableSessionAuthentication(AUserAuthenticator,ASessionAuthenticator:TAuthenticator):Boolean;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>function DisableAuthentication:Boolean;</code>  | ||
|    | |    | ||
|-  | |-  | ||
| Line 216: | Line 320: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
<pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.GetCaption:String;</pre>  | <pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.GetCaption:String;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! Note  | ||
| + | | None documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.NormalizedDateToStr(const DateTime:TDateTime):String;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! Note  | ||
| + | | None documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.NormalizedTimeToStr(const DateTime:TDateTime):String;</pre>  | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| Line 228: | Line 356: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
<pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.NormalizedDateTimeToStr(const DateTime:TDateTime):String;</pre>  | <pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.NormalizedDateTimeToStr(const DateTime:TDateTime):String;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! Note  | ||
| + | | None documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function TWebStatusMain.NormalizedIntervalToStr(const DateTime:TDateTime):String;</pre>  | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
Latest revision as of 02:38, 27 October 2025
Return to Unit WebStatus
Description
To be documented
Class definitions
TWebStatusMain = class(THTTPDocument)
public 
 | |
 constructor Create(AListener:THTTPListener; const AHost,AURL:String; ARedirect:Boolean);
 | 
|
 destructor Destroy; override;
 | 
|
private 
 | |
 FTitle:String;
 | 
|
 FCaption:String;
 | 
|
 FPages:TStringList;
 | 
|
 FLoginPage:TWebStatusLogin;
 | 
|
 FLogoutPage:TWebStatusLogout;
 | 
|
 FRedirectPage:THTTPRedirect;
 | 
|
 FHost:String;
 | 
|
 FListener:THTTPListener;
 | 
|
 FFontName:String;
 | 
|
 FAllowRestart:Boolean;
 | 
|
 FAllowShutdown:Boolean;
 | 
|
 function GetTitle:String;
 | 
|
 procedure SetTitle(const ATitle:String);
 | 
|
 function GetCaption:String;
 | 
|
 function GetHost:String;
 | 
|
 function GetFontName:String;
 | 
|
 procedure SetFontName(const AFontName:String);
 | 
|
 function NormalizedDateToStr(const DateTime:TDateTime):String;
 | 
|
 function NormalizedTimeToStr(const DateTime:TDateTime):String;
 | 
|
 function NormalizedDateTimeToStr(const DateTime:TDateTime):String;
 | 
|
 function NormalizedIntervalToStr(const DateTime:TDateTime):String;
 | 
|
protected 
 | |
 function MakeBold(const AName:String):String;
 | 
|
 function MakeLink(const AName,ALink:String):String;
 | 
|
 procedure AddRemoteAction(AResponse:THTTPServerResponse);
 | 
|
 procedure AddConfirmAction(AResponse:THTTPServerResponse);
 | 
|
 function AddBlank(AResponse:THTTPServerResponse):Boolean;
 | 
|
 function AddBlankEx(AResponse:THTTPServerResponse; AColumns:LongWord):Boolean;
 | 
|
 function AddItem(AResponse:THTTPServerResponse; const AName,AValue:String):Boolean;
 | 
|
 function AddItemEx(AResponse:THTTPServerResponse; const AName,AValue:String; AIndent:LongWord):Boolean;
 | 
|
 function AddItemSpan(AResponse:THTTPServerResponse; const AValue:String; AColumns:LongWord; ABreak:Boolean = True):Boolean;
 | 
|
 function AddItemSpanEx(AResponse:THTTPServerResponse; const AValue:String; AColumns,AIndent:LongWord; ABreak:Boolean = True):Boolean;
 | 
|
 function AddItem3Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2:String):Boolean;
 | 
|
 function AddItem4Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3:String):Boolean;
 | 
|
 function AddItem5Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3,AValue4:String):Boolean;
 | 
|
 function AddBold(AResponse:THTTPServerResponse; const AName,AValue:String):Boolean;
 | 
|
 function AddBoldEx(AResponse:THTTPServerResponse; const AName,AValue:String; AIndent:LongWord):Boolean;
 | 
|
 function AddBold3Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2:String):Boolean;
 | 
|
 function AddBold4Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3:String):Boolean;
 | 
|
 function AddBold5Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3,AValue4:String):Boolean;
 | 
|
 function AddHeader(AResponse:THTTPServerResponse; const ATitle:String; ASub:TWebStatusSub):Boolean;
 | 
|
 function AddHeaderEx(AResponse:THTTPServerResponse; const ATitle,ACaption:String; ASub:TWebStatusSub; AColumns:LongWord):Boolean;
 | 
|
 function AddFooter(AResponse:THTTPServerResponse):Boolean;
 | 
|
 function AddFooterEx(AResponse:THTTPServerResponse; AColumns:LongWord):Boolean;
 | 
|
 function AddContent(AResponse:THTTPServerResponse; const AContent:String):Boolean;
 | 
|
 function DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; override;
 | 
|
 function DoAuthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthenticated:Boolean):Boolean; override;
 | 
|
 function DoDeauthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var ADeauthenticated:Boolean):Boolean; override;
 | 
|
public 
 | |
 property Title:String read GetTitle write SetTitle;
 | 
|
 property Caption:String read GetCaption;
 | 
|
 property Host:String read GetHost;
 | 
|
 property Listener:THTTPListener read FListener;
 | 
|
 property FontName:String read GetFontName write SetFontName;
 | 
|
 property AllowRestart:Boolean read FAllowRestart write FAllowRestart;
 | 
|
 property AllowShutdown:Boolean read FAllowShutdown write FAllowShutdown;
 | 
|
 function RegisterPage(APage:TWebStatusPage):Boolean;
 | 
|
 function DeregisterPage(APage:TWebStatusPage):Boolean;
 | 
|
 function RegisterPages:Boolean;
 | 
|
 function DeregisterPages:Boolean;
 | 
|
 function EnableUserAuthentication(AUserAuthenticator:TAuthenticator):Boolean;
 | 
|
 function EnableSessionAuthentication(AUserAuthenticator,ASessionAuthenticator:TAuthenticator):Boolean;
 | 
|
 function DisableAuthentication:Boolean;
 | 
|
Function declarations
constructor TWebStatusMain.Create;
Description: To be documented
| Note | None documented | 
|---|
destructor TWebStatusMain.Destroy;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.GetTitle:String;
Description: To be documented
| Note | None documented | 
|---|
procedure TWebStatusMain.SetTitle(const ATitle:String);
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.GetCaption:String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.NormalizedDateToStr(const DateTime:TDateTime):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.NormalizedTimeToStr(const DateTime:TDateTime):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.NormalizedDateTimeToStr(const DateTime:TDateTime):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.NormalizedIntervalToStr(const DateTime:TDateTime):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.MakeBold(const AName:String):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.MakeLink(const AName,ALink:String):String;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBlank(AResponse:THTTPServerResponse):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBlankEx(AResponse:THTTPServerResponse; AColumns:LongWord):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItem(AResponse:THTTPServerResponse; const AName,AValue:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItemEx(AResponse:THTTPServerResponse; const AName,AValue:String; AIndent:LongWord):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItemSpan(AResponse:THTTPServerResponse; const AValue:String; AColumns:LongWord; ABreak:Boolean):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItemSpanEx(AResponse:THTTPServerResponse; const AValue:String; AColumns,AIndent:LongWord; ABreak:Boolean):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItem3Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItem4Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddItem5Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3,AValue4:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBold(AResponse:THTTPServerResponse; const AName,AValue:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBoldEx(AResponse:THTTPServerResponse; const AName,AValue:String; AIndent:LongWord):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBold3Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBold4Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddBold5Column(AResponse:THTTPServerResponse; const AName,AValue1,AValue2,AValue3,AValue4:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddHeader(AResponse:THTTPServerResponse; const ATitle:String; ASub:TWebStatusSub):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddHeaderEx(AResponse:THTTPServerResponse; const ATitle,ACaption:String; ASub:TWebStatusSub; AColumns:LongWord):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddFooter(AResponse:THTTPServerResponse):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddFooterEx(AResponse:THTTPServerResponse; AColumns:LongWord):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.AddContent(AResponse:THTTPServerResponse; const AContent:String):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.RegisterSubPage(ASub:TWebStatusSub):Boolean;
Description: To be documented
| Note | None documented | 
|---|
function TWebStatusMain.DeregisterSubPage(ASub:TWebStatusSub):Boolean;
Description: To be documented
| Note | None documented | 
|---|
Return to Unit Reference