umfwelcome.pas

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

{  JADD - Just Another DelphiDoc: Documentation from Delphi Source Code

Copyright (C) 2002-2008   Gerold Veith

This file is part of JADD - Just Another DelphiDoc.

DelphiDoc is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as
published by the Free Software Foundation.

DelphiDoc is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
}


unit UMFWelcome;

{Contains a simple page welcoming the user to the program and two buttons to
 show further information. }

interface

uses Classes, Forms, Controls, StdCtrls, ExtCtrls,
     UMainFormFrame,
     UJADDState;

type
  {A simple page welcoming the user to the program and two buttons for further
   information. }
  TMFWelcome = class(TMainFormFrame)
    ButtonDocumentation: TButton;
    ButtonProjectSite: TButton;
    procedure ButtonDocumentationClick(Sender: TObject);
    procedure ButtonProjectSiteClick(Sender: TObject);
  private
  protected
  public

{$IFDEF LINUX}

    //Creates the components and hides the buttons.
    constructor Create(Parent: TWinControl; State: TJADDState); override;

{$ENDIF}
  end;


implementation

{$R *.dfm}


uses UCommandParameters;



{$IFDEF LINUX}

{Creates the components and hides the buttons.
~param Parent the component to show the frame in, preferably a TPanel or a
              similar component
~param State  the state of the program }
constructor TMFWelcome.Create(Parent: TWinControl; State: TJADDState);
begin
 inherited Create(Parent, State);         //create the page

 ButtonDocumentation.Visible := False;    //no default browser, so hide buttons
 ButtonProjectSite.Visible := False;
end;

{$ENDIF}



{Called when the button to show the documentation is clicked.
~param Sender the sender of the event, the ~[link ButtonDocumentation] }
procedure TMFWelcome.ButtonDocumentationClick(Sender: TObject);
begin                                   //show the manual
 ShowDocumentation(ButtonDocumentation.HelpContext, 'manual.html');
end;

{Called when the button to show the DelphiDoc's homepage is clicked.
~param Sender the sender of the event, the ~[link ButtonProjectSite] }
procedure TMFWelcome.ButtonProjectSiteClick(Sender: TObject);
begin                                   //show home page
 ShowDelphiDocProjectPage(ButtonProjectSite.HelpContext);
end;

end.