mirror of
https://github.com/HeidiSQL/HeidiSQL.git
synced 2025-08-06 18:24:26 +08:00
Move *.pas, *.dfm and *.inc files from root directory to a new "source" subdirectory. Leaving just the readme in the root to give all newbies a very clear and unique starting point.
This commit is contained in:
Ansgar Becker
330
source/sqlhelp.pas
Normal file
330
source/sqlhelp.pas
Normal file
@ -0,0 +1,330 @@
|
||||
unit sqlhelp;
|
||||
|
||||
interface
|
||||
|
||||
uses
|
||||
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
|
||||
Dialogs, StdCtrls, ComCtrls, ExtCtrls, ShellApi, Buttons, Registry,
|
||||
childwin;
|
||||
|
||||
type
|
||||
TfrmSQLhelp = class(TForm)
|
||||
pnlLeft: TPanel;
|
||||
StatusBar1: TStatusBar;
|
||||
Splitter1: TSplitter;
|
||||
treeTopics: TTreeView;
|
||||
pnlRight: TPanel;
|
||||
lblTopics: TLabel;
|
||||
pnlRightTop: TPanel;
|
||||
lblKeyword: TLabel;
|
||||
lblDescription: TLabel;
|
||||
memoDescription: TMemo;
|
||||
Splitter2: TSplitter;
|
||||
pnlRightBottom: TPanel;
|
||||
lblExample: TLabel;
|
||||
MemoExample: TMemo;
|
||||
ButtonClose: TButton;
|
||||
ButtonSearchOnline: TBitBtn;
|
||||
procedure treeTopicsExpanding(Sender: TObject; Node: TTreeNode;
|
||||
var AllowExpansion: Boolean);
|
||||
procedure treeTopicsChange(Sender: TObject; Node: TTreeNode);
|
||||
procedure FormShow(Sender: TObject);
|
||||
procedure memosKeyDown(Sender: TObject; var Key: Word;
|
||||
Shift: TShiftState);
|
||||
procedure ButtonOnlinehelpClick(Sender: TObject);
|
||||
procedure ButtonCloseClick(Sender: TObject);
|
||||
function ShowHelpItem: Boolean;
|
||||
procedure fillTreeLevel( ParentNode: TTreeNode );
|
||||
procedure findKeywordInTree;
|
||||
|
||||
private
|
||||
{ Private declarations }
|
||||
m : TMDIChild;
|
||||
public
|
||||
{ Public declarations }
|
||||
Keyword: String;
|
||||
end;
|
||||
|
||||
const
|
||||
DEFAULT_WINDOW_CAPTION : String = 'Integrated SQL-help' ;
|
||||
ICONINDEX_CATEGORY_CLOSED : Integer = 96;
|
||||
ICONINDEX_CATEGORY_OPENED : Integer = 97;
|
||||
ICONINDEX_HELPITEM : Integer = 98;
|
||||
|
||||
var
|
||||
frmSQLhelp : TfrmSQLhelp;
|
||||
|
||||
implementation
|
||||
|
||||
uses ZDataset, helpers, main, db;
|
||||
|
||||
{$I const.inc}
|
||||
|
||||
{$R *.dfm}
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Startup
|
||||
}
|
||||
procedure TfrmSQLhelp.FormShow(Sender: TObject);
|
||||
begin
|
||||
m := Mainform.Childwin;
|
||||
|
||||
// Set window-layout
|
||||
Top := Mainform.GetRegValue( 'SQLHelp_WindowTop', Top );
|
||||
Left := Mainform.GetRegValue( 'SQLHelp_WindowLeft', Left );
|
||||
Width := Mainform.GetRegValue( 'SQLHelp_WindowWidth', Width );
|
||||
Height := Mainform.GetRegValue( 'SQLHelp_WindowHeight', Height );
|
||||
pnlLeft.Width := Mainform.GetRegValue( 'SQLHelp_PnlLeftWidth', pnlLeft.Width );
|
||||
pnlRightTop.Height := Mainform.GetRegValue( 'SQLHelp_PnlRightTopHeight', pnlRightTop.Height );
|
||||
Caption := DEFAULT_WINDOW_CAPTION;
|
||||
|
||||
MemoDescription.Font.Name := m.SynMemoQuery.Font.Name;
|
||||
MemoDescription.Font.Size := m.SynMemoQuery.Font.size;
|
||||
MemoExample.Font.Name := m.SynMemoQuery.Font.Name;
|
||||
MemoExample.Font.Size := m.SynMemoQuery.Font.size;
|
||||
|
||||
// Gather help contents for treeview with SQL: HELP "CONTENTS"
|
||||
fillTreeLevel( nil );
|
||||
|
||||
if ShowHelpItem then
|
||||
findKeywordInTree;
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Fills exactly one level of the folder-tree
|
||||
Call with NIL to generate the root folders,
|
||||
then call recursively to iterate through all folders and fill them
|
||||
@param TTreeNode Parent node to fill (or NIL)
|
||||
}
|
||||
procedure TfrmSQLhelp.fillTreeLevel( ParentNode: TTreeNode );
|
||||
var
|
||||
tnode : TTreeNode;
|
||||
i : integer;
|
||||
ds : TDataSet;
|
||||
topic : String;
|
||||
begin
|
||||
if ParentNode = nil then
|
||||
begin
|
||||
treeTopics.Items.Clear;
|
||||
topic := 'CONTENTS';
|
||||
end
|
||||
else
|
||||
begin
|
||||
ParentNode.DeleteChildren;
|
||||
topic := ParentNode.Text;
|
||||
end;
|
||||
try
|
||||
Screen.Cursor := crHourglass;
|
||||
ds := m.GetResults( 'HELP "'+topic+'"' );
|
||||
for i:=1 to ds.RecordCount do
|
||||
begin
|
||||
tnode := treeTopics.Items.AddChild( ParentNode, ds.FieldByName('name').AsString );
|
||||
if (ds.FindField('is_it_category') <> nil) and (ds.FieldByName('is_it_category').AsString = 'Y') then
|
||||
begin
|
||||
tnode.ImageIndex := ICONINDEX_CATEGORY_CLOSED;
|
||||
tnode.SelectedIndex := ICONINDEX_CATEGORY_OPENED;
|
||||
// Add a dummy item to show the plus-button so the user sees that there this
|
||||
// is a category. When the plus-button is clicked, fetch the content of the category
|
||||
treeTopics.Items.AddChild( tnode, DUMMY_NODE_TEXT );
|
||||
end
|
||||
else
|
||||
begin
|
||||
tnode.ImageIndex := ICONINDEX_HELPITEM;
|
||||
tnode.SelectedIndex := tnode.ImageIndex;
|
||||
end;
|
||||
ds.Next;
|
||||
end;
|
||||
finally
|
||||
FreeAndNil( ds );
|
||||
Screen.Cursor := crDefault;
|
||||
end;
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Show selected keyword in Tree
|
||||
}
|
||||
procedure TfrmSQLhelp.findKeywordInTree;
|
||||
var
|
||||
tnode : TTreeNode;
|
||||
i : Integer;
|
||||
tmp : Boolean;
|
||||
begin
|
||||
i := 0;
|
||||
while i < treeTopics.Items.Count do
|
||||
begin
|
||||
tnode := treeTopics.Items[i];
|
||||
inc(i);
|
||||
if tnode.Text = Keyword then
|
||||
begin
|
||||
tnode.MakeVisible;
|
||||
treeTopics.Selected := tnode;
|
||||
break;
|
||||
end;
|
||||
treeTopicsExpanding( self, tnode, tmp );
|
||||
end;
|
||||
treeTopics.SetFocus;
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Selected item in treeTopics has changed
|
||||
}
|
||||
procedure TfrmSQLhelp.treeTopicsChange(Sender: TObject; Node: TTreeNode);
|
||||
procedure OpenFolderIcons( ANode: TTreeNode );
|
||||
begin
|
||||
if ANode = nil then
|
||||
exit;
|
||||
if ANode.ImageIndex = ICONINDEX_CATEGORY_CLOSED then
|
||||
begin
|
||||
ANode.ImageIndex := ICONINDEX_CATEGORY_OPENED;
|
||||
end;
|
||||
// Recursively update ANode's parent node
|
||||
OpenFolderIcons( ANode.Parent );
|
||||
end;
|
||||
|
||||
var
|
||||
i : Integer;
|
||||
tNode : TTreeNode;
|
||||
begin
|
||||
// 1. Show corresponding help-text
|
||||
if Node.ImageIndex = ICONINDEX_HELPITEM then
|
||||
begin
|
||||
Keyword := Node.Text;
|
||||
ShowHelpItem;
|
||||
end;
|
||||
|
||||
// 2. Ensure the icons in the preceding tree-path of the selected item
|
||||
// show opened folders on each level
|
||||
i := 0;
|
||||
while i < treeTopics.Items.Count do
|
||||
begin
|
||||
tNode := treeTopics.Items[i];
|
||||
if tNode.ImageIndex = ICONINDEX_CATEGORY_OPENED then
|
||||
begin
|
||||
tNode.ImageIndex := ICONINDEX_CATEGORY_CLOSED;
|
||||
end;
|
||||
inc(i);
|
||||
end;
|
||||
OpenFolderIcons( Node );
|
||||
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Get topics from category
|
||||
}
|
||||
procedure TfrmSQLhelp.treeTopicsExpanding(Sender: TObject; Node: TTreeNode;
|
||||
var AllowExpansion: Boolean);
|
||||
begin
|
||||
if (Node.getFirstChild <> nil) and (Node.getFirstChild.Text = DUMMY_NODE_TEXT) then
|
||||
begin
|
||||
fillTreeLevel( Node );
|
||||
end;
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Fetch and show text of help-item in synmemo's
|
||||
@return boolean Was the keyword found?
|
||||
}
|
||||
function TfrmSQLhelp.ShowHelpItem: Boolean;
|
||||
var
|
||||
ds : TDataSet;
|
||||
begin
|
||||
lblKeyword.Caption := Copy(Keyword, 0, 100);
|
||||
MemoDescription.Lines.Clear;
|
||||
MemoExample.Lines.Clear;
|
||||
Caption := DEFAULT_WINDOW_CAPTION;
|
||||
result := false; // Keyword not found yet
|
||||
|
||||
if Keyword <> '' then
|
||||
try
|
||||
Screen.Cursor := crHourglass;
|
||||
ds := m.GetResults( 'HELP "'+lblKeyword.Caption+'"' );
|
||||
if ds.RecordCount = 1 then
|
||||
begin
|
||||
// We found exactly one matching help item
|
||||
lblKeyword.Caption := ds.FieldByName('name').AsString;
|
||||
Keyword := lblKeyword.Caption;
|
||||
if lblKeyword.Caption = '&' then
|
||||
lblKeyword.Caption := '&&'; // Avoid displaying "_" as alt-hotkey
|
||||
Caption := Caption + ' - ' + Keyword;
|
||||
MemoDescription.Text := fixNewlines(ds.FieldByName('description').AsString);
|
||||
MemoExample.Text := fixNewlines(ds.FieldByName('example').AsString);
|
||||
result := true;
|
||||
end;
|
||||
finally
|
||||
FreeAndNil( ds );
|
||||
Screen.Cursor := crDefault;
|
||||
end;
|
||||
|
||||
// Show the user if topic is (not) available
|
||||
with MemoDescription do
|
||||
begin
|
||||
Enabled := Text <> '';
|
||||
if not Enabled then
|
||||
Text := 'No help available for this keyword or no keyword was selected.';
|
||||
end;
|
||||
with MemoExample do
|
||||
begin
|
||||
Enabled := Text <> '';
|
||||
if not Enabled then
|
||||
Text := 'No example available or no keyword was selected.';
|
||||
end;
|
||||
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Save layout and close window
|
||||
}
|
||||
procedure TfrmSQLhelp.ButtonCloseClick(Sender: TObject);
|
||||
begin
|
||||
Mainform.SaveRegValue( 'SQLHelp_WindowLeft', Left );
|
||||
Mainform.SaveRegValue( 'SQLHelp_WindowTop', Top );
|
||||
Mainform.SaveRegValue( 'SQLHelp_WindowWidth', Width );
|
||||
Mainform.SaveRegValue( 'SQLHelp_WindowHeight', Height );
|
||||
Mainform.SaveRegValue( 'SQLHelp_PnlLeftWidth', pnlLeft.Width );
|
||||
Mainform.SaveRegValue( 'SQLHelp_PnlRightTopHeight', PnlRightTop.Height );
|
||||
|
||||
Close;
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Link/redirect to mysql.com for further help
|
||||
@see http://www.heidisql.com/sqlhelp.php
|
||||
}
|
||||
procedure TfrmSQLhelp.ButtonOnlinehelpClick(Sender: TObject);
|
||||
begin
|
||||
ShellExec( 'http://www.heidisql.com/sqlhelp.php?mysqlversion='+inttostr(m.mysql_version)+
|
||||
'&keyword='+urlencode(keyword) );
|
||||
end;
|
||||
|
||||
|
||||
|
||||
{***
|
||||
Esc pressed - close form.
|
||||
Seems that if we're in a memo, the ButtonClose.Cancel=True doesn't have an effect
|
||||
}
|
||||
procedure TfrmSQLhelp.memosKeyDown(Sender: TObject; var Key: Word;
|
||||
Shift: TShiftState);
|
||||
begin
|
||||
if Key = VK_ESCAPE then
|
||||
ButtonCloseClick(self);
|
||||
end;
|
||||
|
||||
|
||||
|
||||
end.
|
||||
Reference in New Issue
Block a user