umfacquireparseddata.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 UMFAcquireParsedData;

{Contains a simple page as the main page to acquire parsed data. Via a radio
 group a way to acquire it can be selected and the button "Next" will bring the
 user to the appropriate page to do that. }

interface

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

type
  {A simple page as the main page to acquire parsed data. Via a radio group a
   way to acquire it can be selected and the button "Next" will bring the user
   to the appropriate page to do that.
  ~see SelectNextFrame   for testing
  ~see SelectNextFrame:0 for testing
  ~see SelectNextFrame:1 for testing
  ~see SelectNextFrame:2 for testing }
  TMFAcquireParsedData = class(TMainFormFrame)
    RadioGroup: TRadioGroup;
  private
  protected
  public
    //Creates the components and sets the index of the radio group.
    constructor Create(Parent: TWinControl; State: TJADDState); override;

    //Called sometimes when the frame is to be replaced by another frame.
    procedure SelectNextFrame(var NewFrameClass: TMainFormFrameClass;
                              IsNext: Boolean); overload; override; 

                              
    //Called never, just to test parsing and linking of overloaded functions.
    procedure SelectNextFrame(JustForTesting: Integer); reintroduce; overload; 
  end;


implementation

{$R *.dfm}

uses UMFLoadParsedData, UMFParseMain, UMFKeepSelectData;



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

 RadioGroup.ItemIndex := 1;               //by default parse source code files
end;




{Called sometimes when the frame is to be replaced by another frame. This
 method is ~[em not] always called before the frame is being replaced (and
 freed).
~param NewFrameClass the class of the frame that should replace this one
~param IsNext        if the next frame should be shown (instead of the previous
                     one) in some kind of an order
~see SelectNextFrame:2 for testing }
procedure TMFAcquireParsedData.SelectNextFrame(
                      var NewFrameClass: TMainFormFrameClass; IsNext: Boolean);
begin
 if IsNext then                             //next page should be shown?
  case RadioGroup.ItemIndex of                //go to the appropriate page
    0: NewFrameClass := TMFLoadParsedData;
    1: NewFrameClass := TMFParseMain;
    2: NewFrameClass := TMFKeepSelectData;
  end;
end;


{Called never, just to test parsing and linking of overloaded functions, so I
 link here to the ~[link SelectNextFrame real]
 ~[link SelectNextFrame:1 function].
~param JustForTesting not used }
procedure TMFAcquireParsedData.SelectNextFrame(JustForTesting: Integer);
begin
 //nothing
end;

end.