# Lazarus Tutorial/zh TW

## 概述

Lazarus 是一個使用 Pascal 編譯器的自由開放原始碼開發工具。Free Pascal 本身也是自由開放軟體。Lazarus IDE (擷圖) 提供一穩定，且專注於強調豐富的程式寫作環境，並用來開發單機的圖形與主控台應用程式。Lazarus 目前可以在 Linux，Mac OS X 與 Win32 下執行。且提供可自訂的原始碼編輯器，並透過套件管理，除錯器與完整的圖形使用介面整合的編譯器做成視覺化的表格創建環境。

## 我們開始吧

(感謝 User:Kirkpatc)

### 你的第一個 Lazarus 程式！

 procedure TForm1.Button1Click(Sender: TObject);
begin
{現在輸入:}    Button1.caption := '再按一次';
{程序於此完結}
end;


 procedure TForm1.Button2Click(Sender: TObject);
begin
{現在輸入:}   Close;
{程序於此完結}
end;


### 改進你的程式

 procedure TForm1.Button1Click(Sender: TObject);
{使用一個標記物，設定它是１或是零}
begin
if Button1.tag = 0 then
begin
Button1.caption := '再按一次';
Button1.tag := 1
end else
begin
Button1.caption := '按我';
Button1.tag := 0
end
end;


## 主選單

#### 檔案子選單 (File)

• 新單元：建立一個新的單元檔 (Pascal 原始碼)。
• 新表單：建立一個新表單：同時包含圖形視窗與相關聯的 Pascal 原始碼檔案。
• 新增...：彈出一個選單 (擷圖)，裡面有各種各樣的文件可供新增。
• 開啟：彈出一個對話框，讓你可以瀏覽己經存在你的檔案系統裡的檔案來開啟。
• 還原：完全放棄你對現在編輯的檔案所做的變更．把他還原到原來的狀態。
• 開啟先前檔案：列出一份你先前開過檔案的清單，讓你選擇其中一個來開啟。
• 儲存：使用該檔原來的檔案儲存檔案．如果他本來沒有取名，則為出現提示 (則同另存新檔)。
• 另存新檔：讓你選另一個不同的檔名來儲存檔案。
• 儲存全部：儲存所有編輯器開啟的檔案，而非只有目前編輯中的。
• 關閉：關閉目前的檔案，並提示以儲存變更。
• 關閉所有編輯的檔案：關閉所有開啟在編輯器裡的檔案，並提示儲存。
• 清理目錄：用對話框的模式提供給你一些可自訂的篩選器，讓你可以移除一些目錄裡的檔案。例如 .bak 這種檔或舊的 Delphi 專案殘骸。
• 列印：使用系統的印表機列印所選取的檔案，若您不是使用 Windows，選單裡預設並沒有任何項目。你會需要先安裝 $Lazdir/components/printers/design/printers4lazide.pas 這份套件再重新編譯 Lazarus IDE。 • 重新開啟：重開 Lazarus，當你感到你的 Lazarus 已經變的一團亂的時候很有用! • 離開：退出 Lazarus，並提示您是否已儲存所有你編輯的檔案。 #### 編輯子選單 (Edit) • 復原：復原您上一動的編輯，讓編輯器裡回到上一個動作之前的狀態。 • 重做：重新進行上一步已經被你復原回去的動作。 • 剪下：移去您選取的文字（或任何項目）並放置到剪貼簿裡。 • 複製：建立一份所選取的文字的副本，留有原來的文字並將副本放到剪貼簿裡。 • 貼上：將剪貼簿裡的內容置放到你游標目前的位置。如果你目前的游標選取了某些字，則剪貼簿裡的內容會取代這些被選取的字。 • 選取文字縮排：將選取的文字向右移動一個距離，可於［環境］->［編輯器選項］->［一般］->［區塊縮排］設定。這在你撰寫 Pascal 原始碼時用於統一格式，區分區塊結構時很有用。 • 選取文字取消縮排：移除一個階層的縮排，將文字向左移動一個區塊固定的距離。 • 關閉選取文字：彈出一個選單，裡面有幾個選項可以讓你關閉選取文字裡，符合條件的敘述句 (begin ... end; try ... except; try ... finally; repeat ... until; { ... } 等等)。 • 選取文字變大寫：轉換選取的文字成大寫。 • 選取文字變小寫：轉換選取的文字成小寫。 • 選取文字跳格轉空白將選取的文字裡作任跳格字元轉換成固定數量的空白字元，數量可於［環境］->［編輯器選項］->［一般］->［跳格寬度］裡設字。空白字元數量並非固定的，但至少一定會填滿目前跳格字元的寬度。 • 選取文字斷行若有任何選取文字裡單行有超過 80 個字元（或於［環境］->［編輯器選項］->［顯示］->［右邊界］設定寬度）的情況，則將該行在邊界的地方自動斷行並於下一行繼續。 • 註解選取文字: 將選取的文字每一行插入 // 以轉成註解 • 選取文字取消註解：移除註解標記。 • 排序選取文字：將行 (或字或段落) 依字母排列；可選升冪或降冪，區不區分大小寫。總之不管有無意義你覺得有需要就可以這麼做。 • 選取：可以讓你選取一個區段的文字。選項有選取全部，選取括號，選取段落或行等等。 • 從字元表插入字元：讓你可以插入一個鍵盤裡沒有的符號或是外國字，從彈出的字元表選單裡去選。 • 插入文字: 彈出一個選單，讓人可以插入一些標準的文字，如 CVS 關鍵字 (Author, Date, Header 等等) 或是 GPL 警告，使用者名稱或是目前日期與時間。 • 程式碼自動完成：完成目前游標所在處的程式碼。會自動區分前後文的文意以節省你的時間。例如；它會自動加入 private 變數，擷取並設定方法的內容並直接加入方法本體，以完成整個類別。在指派變數 (如 i:=3;) 的敘述裡他會自動加入變數的宣告，在定義程序裡，他會自動加入程式的本體。在觸發事件的指派裡 (OnClick:=) 它則會自動加入方法的定義與方法本體。參見Lazarus IDE 工具. • 建立程序：利用選取的文字 (一段敘述或一連串的敘述) 來建立一個新的程序。 #### 搜尋子選單 • 尋找：功能幾乎與所有圖形介面的文字編輯器一樣：一個彈出的對話框可以輸入要搜尋的字串，有區分大小寫的選項，完整字辭搜尋，起點，命名空間和搜尋方向。 • 尋找下一個，尋找上一個：利用上次輸入的字串，向指定的方向再次搜尋。 • 在檔案裡尋找：在檔案裡搜尋字串：彈出對話框，選項有［所有開啟的檔案］，［所有專案裡的檔案］，［所有目錄］；允許建立遮罩以指定檔案類形。 • 取代：和尋找類似；彈出對話框讓你可以同時輸要搜尋的字串和要取代成的字串，然後有區分大小寫，搜尋方向等等的選項。 • 漸進式尋找：搜尋動作會依你輸入字串一步一步搜尋，例如你選取［漸進式尋找］後，你先按下 "l" ，所有第一個字母是 "l" 的字會被標明出來，然後你若再輸入 "a"，則編輯器會接著尋找 "la"。 • 移至：移動編輯中的游標到指定的行號。 • 跳回：跳到上一個位置。每一次跳躍到錯誤或是宣告處 IDE 會儲存目前原始的位置，這個功能可以讓你再依記錄跳回來。 • 向前跳：跳到下一個位置，復原回上一次跳躍。 • 新增跳躍記錄點：加入目前的位置到跳躍記錄中。 • 檢視跳躍記錄點：檢視跳躍點的清單。(更多) • 跳到下一個錯誤, 跳到上一個錯誤：跳到到上一個或下一個在原始碼檔裡被回報有錯誤的地方。 • 設定書籤：標記目前游標所在行成可以利用 (自由使用) 的書籤並加上編號，然後加入到書籤清單裡。注意彈出的選單 (加原始碼檔案裡在適當的行裡點右鍵取得) 裡書籤的範圍很廣，可以指定編號找到書籤，或是允許使用者指定編號跳到書籤處，而不單只是上一個下一個。 • 跳到下一個書籤, 跳到上一個書籤：依順序跳到上一個或下一個書籤。 • 尋找程式碼區塊的其他結尾：如果目前處在 begin 處，找到相對應的 end 處，反之亦然。 • 尋找程式碼區塊的開始：移動到目前游標所在的程序或函式的 begin 處。 • 尋找游標處的宣告：為目前選取的識別子找到它的宣告處。位置有可能再同一個檔案裡，也可能在另一個編輯器開啟的檔案裡；但若是未開啟的檔案，程式則會自動開啟該檔。(像一個程序或函式在 classesh.inc 裡宣告後，程式則將之開啟)。(更多) • 開啟游標處的檔案：開啟游標選取其檔名的檔案。對於 Include 檔的搜尋或是取得專案裡包含的單元特別有用。 • 移到含括檔指示處：若游標指到的檔名是被 Included 在其他的檔案裡，則移至 Include 所指名稱的檔案裡。 • 尋找參照的識別子：建立一份列出在目前檔案裡，或所有依附於目前專案裡所有識別子的清單。 • 識別子重新命名：可以讓開發者為識別子重新命名。對話框提示開發者看是要針對目前撰寫中的檔案裡改名就好，還是整個專案的，或所有已開啟檔案的都要改。甚至於註解文字裡的識別子都會一起改掉。此功能適用於當編譯時有識別子已經存在了，或你單純想為識別子重新取個名字。 • 程序清單：建立一份目前檔案裡所有程式與函式的清單，並加註他們宣告處所在的行號。 #### 檢視子選單 控制螢幕裡各個視窗與面版的一些顯示。 • 物件檢視器：這個視窗通常都一直佔據在你桌面的左方，顯示您表單的特徵。滑鼠選的所有表單裡的物件，詳細內容都會在物件檢視器裡顯示。上半的面版有一個專案的樹狀圖，分列出表單裡的元件供選取。這和物件檢視器所提供的是一致的。主要的下半面版顯示有兩個籤頁，內容事件。選擇內容會顯示的特徵有如命名，顏色，字型，尺寸等：這部份分成兩欄，左半是寫內容名稱，右半則是與內容關聯的值。選擇事件會出現兩欄文字：左半一樣是事件名稱，如關聯到元件的 MouseClick 或 KeyDown，而右邊就是事件發生後要進行的動作。如果沒有定義任何動作，按一下刪節號 ... 會跳回原始碼編輯器，游標會停在一個空的程序裡，等待你把程式內容寫進去。 • 原始碼編輯器：編輯原始碼程式的主視窗。操作方法與其他的圖形文字煸輯器皆雷同，如滑鼠可以移動游標可在上文字上游走，只要按下左鍵來拖曳就可以反白選取文字。按右鍵會跳出選單，包含有剪下，複製或貼上的功能，尋找宣告處開啟游標處的檔案。原始碼編輯器上方有數個頁籤，分別對應你目前專案中正開啟的檔案；點擊頁籤就可以轉換觀看檔案，讓你在檔案之間編輯內容或是使用複製貼上等功能。原始碼編輯器裡對不同語法可用不同的顏色標明，像標點符號，註解，字串等。它還會自動在行與行之間維持文字縮排的層級，直到你再一次的縮排。原始碼編輯器的功能與外觀都可以在主選單的［環境］-> ［編輯器選項］裡幾個籤頁之間調整設定。 • 程式碼瀏覽器：總是在桌面的右方，以樹狀結構顯示。該結構是指你目前的單元或程式。通常他顯示著單元的名字，下面的分支有 Interface 和 Implementation 的區段，在點任何一個分支左邊的 + 字符號後其下的子分支會再展開出來，直到看到一些獨立的常數，函式與程序的宣告為止。如果你在原始碼編輯器中再去切換檔案，你需要去點擊原始碼瀏覽器上的重整鈕重新顯示新檔案裡的原始碼結構。 • 單元...：開啟彈出對話框視窗，表列目前專案裡的所有單元。用滑鼠點擊檔名來選檔案；再按原始碼編輯器裡的［開啟］鈕顯示檔案內容。注意選取框裡允許同時選取數個檔案，而且也可以都同時在原始碼編輯器裡一同開啟 (但一次只能檢視一個檔案)。［專案］->［專案檢視器］選單裡的選項可以讓你決定是只要列出單元就好，還是能從此列表開啟檔案。 • 表單...：開啟彈出對話框視窗，表列目前專案裡的所有表單，並可以同時選取多個開起來檢視。 • 檢視單元依存性：開啟彈出對話框視窗，顯示一個代表著目前開啟中的單元檔的結構依存性樹狀圖。大多數依存性列表裡的檔案都還有獨立一個 + 字號，可以再展開顯示以下獨立的個體。通常會形成一個迴圈。 • 切換表單 / 單元檢視 F12：在原始碼編輯器與目前編輯中的表單之間做切換。將視窗換至最上層。若目前視窗焦點於原始碼編輯器，那你就可以進行原始碼撰寫；若目前視窗焦點於表單上，你就可以為表單的外觀進行排版。在這兩者之間最簡單的切換方法就是按鍵盤的 F12，只是直接選主選單裡的這選項也能發揮同等功能。 • 訊息：顯示編譯過程中諸多訊息的視窗，編譯過程中的進度是否成功或是表列出檔案裡的錯誤。 • 搜尋結果：一個用來表列出在檔案裡搜尋的結果的視窗。 • 除錯視窗：彈出一視窗，帶有除錯時用的到的選項設定，請參見除錯器 #### 專案子選單 • 新專案：建立一個新專案。會彈出一個的對話框並提供一些建立新專案的選項。 • 從檔案建立新專案：出現個導覽對話視窗，可讓你選取檔案再從中建立新專案。 • 開啟專案：開啟先前儲存的專案檔。導覽對話視窗會列出 Lazarus 專案資訊 (.lpi) 檔案供你選擇。 • 開啟先前專案：彈出一個列出你先前工作過的專案清單，然後讓你選一個打開。 • 儲存專案：相同於［檔案］->［儲存］：儲存所有專案裡的檔案；如果之前還沒存過，會像［另存專案...］一樣跳出提示要你取一個專案名稱。 • 另存專案...：跳出提示為專案取名後儲存。預設的檔名是 Project1.lpi，但你應該自己另取一個檔名。Lazarus 不會允許你使用與專案檔或單元檔相同的名稱 (參見此處)。 • 發佈專案：為整個專案建立一個副本。如果你僅只想要將你的原始碼與編譯設定傳送給某人，那這個功能就是你的好幫手了。一般專案的目錄裡包含了一堆的資訊。但裡面有很多在發佈時並不需要：.lpi 檔包含有會期的資訊 (像是跳脫符號的位置或是未開啟檔案裡的書籤) 而專案目錄裡包含有很多 .ppu 和 .o 的檔案與執行檔。建立 lpi 檔會產生僅包含基本資訊和原始碼程式，然後放在 "Publish Project" 的子目錄裡。對話框中你可以設定和選定要排除或要含括的篩選器，也可以使用壓縮指令令其發佈成單一檔案。參見Lazarus IDE 工具 • 專案檢視器：彈出一對話框，將目前的專案以樹狀結構呈列出，允許你新增，移除或是開啟所選取的檔案，或是變更專案的設定。 • 專案選項...：彈出一帶多頁籤的對話框，針對應用程式 (標題，輸出目標檔名) 設定選項，表單 (可選取多種不同內建的表單讓你在一開啟程式時自動建立等) 和資訊 (指定在關閉檔案時編輯器裡的何種資訊要儲存下來，或是只有專案檔案) 時使用。 • 編譯器選項 ...：(從之前的［執行］選單中移到此)。開啟一多籤頁的視窗用來設定你的編譯器。籤頁包括路徑，定義單元，包含檔或函式庫等的搜尋路徑。也可以選則表單型式的工具 (gtk，gnome，win32)；解析，選取解析原始碼程式的規則，程式碼，選取程式最佳化，或是最快速，最小的取向，選取目標處理器，檢查器選取，雜湊值大小等；連結，可選取是否或如何來使用除錯器，靜態或動態函式庫，或是否穿透連結器傳送的選項；訊息定義在除錯階段時要產生的訊息種類；其他，可決定使用預設組態檔 (fpc.cfg) 或是其他的檔案；繼承，顯示樹狀結構圖來指出如何設定在表單下合併元件要如何繼承；編譯，定義在編譯器執行前後還有哪些指令要執行，也可以使用 Make 檔案。 • 加入編輯器中的檔案進專案：將目前編輯器中使用的檔案加入到專案裡。 • 從專案中移除：彈出一選單，讓你可將專案裡的檔案移除。 • 檢視原始碼：不管你現在在編輯什麼，將你轉回到主程式檔 (.lpr) 或若是沒有 .lpr 檔時轉到主要 .pas 檔。 • 檢視 ToDo 清單：開啟對話框，列出與此專案相關聯的 ToDo 項目。你專案裡的和其他任何你有使用的 Lazarus 單元所有 ToDo 註解都會列出來 (註解行 //TODO)。若要新的 ToDo 項目出現你需要在對話框中重整 (使用工具列的箭頭按鈕) 。ToDo 清單的第一列會指出該註解項所記注之文字；若單純只有註解 //TODO 會顯示為零，但若註解為 //TODO999 (舉例) 則該列即顯示 999。請記住在 //TODO 所在行之前不能有空隔，而且在上一次儲存之後才注計之 ToDo 項目不會顯示出來！ #### 執行子選單 • 建置：Lazarus 進行建置 (或說編譯) 在專案中所有從上次建置到這次中有修改過的檔案。 • 建置所有：專案中所有的檔案都進行建置，無論他有沒有被改過。 • 放棄建置：停止正在執行中的建置 - 像在你發現你可能什麼忘記做了而想要停止建置或發現系統跑太久而明顯是有錯誤的樣子。 • 執行：這大概是最常使用的編譯器的方法，若編譯成功完成，則自動執行起該應用程式。實際上是 Lazarus 將你的檔案另存一個副本，然後開啟編譯器與連結器，然後開始執行最後連結到的二進位程式。 • 暫停：將目前執行中的程式暫停。這可以讓你偵測程式產生的輸出值；再選一次執行程式可以再繼續執行。 • 階段執行：與除錯器同時結合，讓編譯進行時可以一次一步，或是依原始碼內的書籤點一步步地進行。 • 跨躍執行：依定位點先一次執行到該處，然後忽略，然後再繼續執行。當想要找出程式中有邏輯錯誤時很有用。 • 執行到游標點：先以正常情況執行編譯 (不是一次一步)，直到敘述句執行到游標停在的位置時停止。再按一次執行繼續。 • 停止：停止編譯程式。無法再從執行指令來繼續；只能再重新從頭編譯過 (用於有需要重新編譯時)。 • 帶參數執行：彈出一多籤頁的視窗，用來選定程式執行時要下的指令行與參數；可以選程式執行時顯示的選項 (如在 Linux 下使用遠端搖控)；有些系統環境下的變數會被蓋過而失效。 一種很重要的用法是使用此子選單的功能開啟一個遠端視窗來控制傳統 Pascal 主控台中輸入／輸出的顯示。如果你在開發一主控台模式的 Pascal 程式 (就是不使用圖形使用者介面，表單，按鈕和對話盒)，那你應該選取 "使用投放式程式"。如果你是第一次使用這個編譯／執行工作，你可能會得到這樣一個無來由的回應訊息 "xterm: Can't execvp /usr/share/lazarus//tools/runwait.sh: Permission denied". "{無法執行 /usr/share/lazarus//tools/runwait.sh: 權限不足}"。  若真的發生了，你需要為一些檔案變更適當的權限 (舉例使用 chmod +x 檔名，或是用視窗工具變更權限)；也許你會需要 root 的權限來變更。之後，每一次你要發動你的程式的時候，就會彈出一主控台視窗框，所有你的文字輸出／入 (readln, writeln 等) 都會顯示在裡面。 After your program has finished execution, a message "Press enter" appears on the screen. Thus any output your program generated will remain on the screen until you have had a chance to read it; after you press 'enter' the console window closes. Note: as for the current version, there is no prepared console command for Windows users. Until the Lazarus team adressess that, the following line should work (on WinXP -- someone please update for other Windowses) C:\Windows\system32\cmd.exe /C${TargetCmdLine}

See the separate tutorial on Console Mode Pascal programming.
• Reset debugger: Restores the debugger to its original state, so that breakpoints and values of variables etc are forgotten.
• Build file: Compile (build) just the file that is currently open in the Editor.
• Run file: Compile, link and execute just the currently open file.
• Configure Build + Run File: Opens a multi-page tabbed window with options to allow for build of just this file when Build Project is selected, allows selection of the working directory, the use of various Macros, etc. Then Builds and Runs the file.
These last three options enable you to open (and maintain) a test project. Use File -> Open to open an .lpr file, pressing cancel on the next dialog to open this file as "normal source" file.

• Open Package: Displays a list of installed packages, with an invitation to open one or more of them, or to select various general or compiler options.
• Open Package File: Open one of the files in the selected package.
• Open Recent Package: Open a package that was opened recently.
• Add Active Unit to Package: Place the unit file (currently in the editor) into a package.
• Package Graph: Displays a graph showing the relationships of the packages currently being used (if you aren't using any other packages, the Lazarus package and the FCL and LCL will be displayed).
• Configure custom components: If you have created some components, allows you to configure them.

• Configure custom tools: Allows the user to add various external tools (usually macros) to the toolkit
• Quick syntax check: Perform a quick check of the syntax in your source file without actually compiling anything. Essential step in developing long or complicated programs, where you don't want to waste time compiling if the code is wrong.
• Guess unclosed block: useful utility if you have a complex nested block structure and you have left out an 'end' somewhere
• guess misplaced IFDEF/ENDIF: useful if there is a complex or nested macro structure and you think you have left out an ENDIF directive
• Make resource string: Makes the selected string a resource string by placing it in the resourcestrings section. An advantage of resource strings is you can change them without the need to recompile your project!
• Diff: Allows comparison between two files (or, usually, two versions of the same file) to find differences. Options to ignore white space at beginning or end of lines or differences in line termination: CR+LF versus LF). Useful for checking if there have been changes since last CVS update etc.
• Check LFM file in editor: Allows inspection of the LFM file which contains the settings that describe the current form
• Convert Delphi unit to Lazarus unit: Helps in porting Delphi applications to Lazarus; makes the necessary changes to the source file. See Lazarus For Delphi Users and Code Conversion Guide.
• Convert DFM file to LFM: For porting from Delphi to Lazarus: converts the Form Description files from Delphi to Lazarus. See Lazarus For Delphi Users and Code Conversion Guide.
• Build Lazarus: Launches a re-build of Lazarus from the most recently downloaded or updated SVN files. Hit the button and sit back to watch it happen! (track the process on your Messages window).
• Configure "Build Lazarus": Allows the user to determine which parts of Lazarus should be re-built, and how. For example, you could select to have just the LCL re-built, or to have everything except the examples built; you can select which LCL interface to use (ie which set of widgets), and you can select the target operating system and specify a different target directory.

#### 環境子選單

• 環境選項：顯示一個代多個標籤頁的視窗
• 檔案 - allowing the user to specify path to default directory, compiler, source directory and temporary directory for compilation;
• 桌面 - options for Language, Auto save behaviour, saving desktop properties, hints for component palette and speed buttons;
• 視窗, to allow specification of size and behaviour of the various windows;
• 表單編輯器 - choose colours for editing forms;
• 物件檢視器 - choose colour and height of items;
• 備份 - specify how to backup files when editing;
• 命名 - specify what extension to use in naming pascal files ('.pp' or '.pas'), whether to save files with names in lowercase, whether to perform auto-delete or auto-rename.
• 編輯器選項: Multi-page window, with tabs for
• 一般 - determines behaviour like auto-indent, bracket highlighting, drag-drop editing, scrolling, syntax highlighting, showing hints, size of block indent and tabs, limit of Undo;
• 顯示 - options for showing line numbers, presence of gutters, size and type of font for editor, and contains a preview panel showing the colours of the various syntax features such as comments, directives, punctuation, errors and breakpoints;
• 按鍵對應 - options to select Lazarus or Turbo Pascal scheme;
• 顏色 - allows choice of colour scheme for text features, for a number of language types such as Object Pascal, C++, Perl, HTML, XML and shell scripts. It shows preview panel again (for whichever language is selected);
• Code Tools - allows selection of features like Identifier Completion, tooltips, specification of template file names, specific templates for code completion.
• Debugger Options: Multi-page window with tabs for
• General - choose debugger: none, GNU debugger (gdb) or gdb through SSH, specify search paths for debuggers,and specific options for chosen debugger;
• Event log - specify whether to clear log on run, and which messages to display;
• Language Exceptions - select which exceptions can be ignored;
• OS Exceptions - allows user to add certain signals which apply to current operating system (not implemented).
• Code Tool Options: Multi-page window, tabs for
• General - Allows entry of additional source search paths, specify Jumping Method;
• Code Creation - determines whether created code is added before or after certain features;
• Words - determines whether Pascal keywords are to be entered in upper or lower case, or as Capitalised Words;
• Line Splitting - establish rules about where lines are allowed to be split (before or after punctuation, after keywords etc);
• Space - decide whether a space is to be added automatically before or after certain syntactic features such as keywords or punctuation marks.
• Code Tools Defines Editor: Here you can see all IDE internal definitions to parse sources. You will see all the defines, unit, source, include paths for all source directories. Beginning with the settings of the current FPC, the defines for the Lazarus Source directory, all package directories and project directories.

Most of these settings are auto generated and read only.

• Re-scan FPC Source directory Looks through the directory again. Lazarus uses the fpc sources to generate correct event handlers and while looking for declarations. If somebody changes the directory in the environment options, then this directory is rescanned, to make sure Lazarus uses the version stored in that location. But if this directory has changed without Lazarus noticing, then you may get some errors when designing forms or doing "Find declaration". If you get such an error, you can do two things:
1. Check the fpc source directory setting in the environment option.
2. Re-scan FPC source directory.

Contains a list of the currently opened files and the available windows such as 原始碼編輯器, 物件檢視器 and Project Inspector. Clicking on the name of one of the windows brings it to the foreground and gives it focus.

At present this has three selections:

• Online Help which at present opens a browser window that contains a picture of the running cheetah and a few links to the Lazarus, Free Pascal and Wiki websites
• Reporting a bug opens the wiki page, which describe the bug reporting procedure
• Configure Help which opens a pop-up menu with options to select viewers and databases from which to read Help information. This option allows the user to specify either the on-line documents section of the Lazarus-CCR website, some other website containing the documents, or a local store for the documentation (this would eventually become the default, when the Help system is fully developed).

At present by default, if you place your Editor cursor over any keyword from the Free Pascal Components Library FCL, the RunTime Library RTL or the Lazarus Components Library LCL, and then press F1 you will be taken by your default browser to the appropriate definition on the website. Be aware that your browser may be located on another desktop on your machine (eg in Linux), and you may not see the information immediately; of course if you are not connected to the internet you cannot get this information.

There are alternative help options which gives the end-user off-line help. For example, if you have a copy of Kylix, you can reuse the help files supplied with it, inside Lazarus IDE. See the Adding Kylix Help page for details.

• About Lazarus Displays a pop-up box with some information about Lazarus.

Eventually there will be a full on-line Help service, with information about Pascal syntax, the use of the IDE, how to use, modify or create Components, and hints on how to perform certain tasks. This part of the Documentation section (the thing you are currently reading) represents the beginning of the process. We need contributions from anyone who feels able to provide them: the WiKi is very easy to edit.

## The Button bar

A small toolbar area on the left of the main editor window, just below the Main Menu and to the left of the Component Palette, contains a set of buttons which replicate frequently-used Main Menu selections:

New unit, Open (with a down-arrow to display a drop-down list of recently used files), Save, Save all, New Form, Toggle Form/Unit (ie show either form or source code of Unit), View Units, View Forms, Run (ie compile and Run), Pause, Step Into, Step over (the last two are Debugger functions).

## The Component Palette

A Tabbed toolbar which displays a large number of icons representing commonly used components for building Forms.

Each tab causes the display of a different set of icons, representing a functional group of components. The left-most icon in each tabbed group is an obliquely leftward-facing arrow, called the Selection Tool.

If you allow the mouse cursor to hover over any of the icons on the Component Palette, without clicking on the icon, the title of that component will pop-up. Note that each title begins with a 'T' - this signifies 'Type' or more accurately 'Class' of the component. When you select a component for inclusion in a form, the Class is added to the type section of the interface part of the Unit (usually as part of the overall TForm1), and an instance of that class is added to the var section (usually as the variable Form1). Any Methods that you design to be used by the Form or its Components (ie Procedures or Functions) will be placed in the implementation part of the Unit.

#### How To Use the Palette

To use the Palette, there must be an open form on view in the editor (if there isn't one, select File -> New Form). Click on the icon in the appropriate tab of the Palette for the component you want to use, then click on the Form, near where you want the component to appear. When the desired component appears, you can select it by clicking with the mouse. Once selected on the form, the object is also selected in the 物件檢視器 window, where you can edit its properties and events.

Adjustments to the visual appearance of an object can be made either by altering the picture itself on the Form using the mouse, or by changing the relevant Property in the Object Editor for that component.

If you install additional components, either those you have written yourself, or some coming as a package from some other source, then extra tabs with the relevant icons will appear in your Component Palette. These new components can be selected and used on your forms in the same way as those supplied by default.

In the following list of the Components, you will find links to files that contain descriptions of the Units in which they are found. If you want to find out about the properties of a particular component, it is often worth looking at the Inheritance of that component and then inspecting the properties of the base type from which it is derived. For example, to understand TMaskEdit it is also useful to examine TCustomMaskEdit.

#### Standard

(See Standard tab for components description)

(See Additional tab for components description)

More, often-used components: TBitBtn, TSpeedButton, TStaticText, TImage, TShape, TBevel, TPaintBox, TNotebook, TLabeledEdit, TSplitter, TTrayIcon, TMaskEdit, TCheckListBox, TScrollBox, TApplicationProperties, TStringGrid, TDrawGrid, TPairSplitter, TColorBox, TColorListBox, TChart

#### Common Controls

(See Common Controls tab for components description)

TTrackBar, TProgressBar, TTreeView, TListView, TStatusBar, TToolBar, TUpDown, TPageControl, TTabControl, THeaderControl, TImageList, TPopupNotifier

#### Dialogs

(See Dialogs tab for components description)

TOpenDialog, TSaveDialog, TSelectDirectoryDialog, TColorDialog, TFontDialog, TFindDialog, TReplaceDialog, TOpenPictureDialog, TSavePictureDialog, TCalendarDialog, TCalculatorDialog, TPrinterSetupDialog, TPrintDialog, TPageSetupDialog

Several useful Dialog procedures or functions don't appear on the Palette, but are easily used as direct calls from your source program.

For several good examples of the use of Components see the LazarusPath/lazarus/examples subdirectory of your source installation. Many of the programs show how to use dialogs and other components directly without using the IDE and component palette or having a separate form definition file: all the components are fully and explicitly defined in the main Pascal program. Other example programs make full use of the IDE. Remember to open these examples as projects, with the .lpi file. Opening the .pas source code file and hitting RUN will just append this source file to whatever project you opened last. Some examples don't work straight away: you may need to play about with paths and permissions of files or directories. If you want to compile any of the examples, make sure that you have read/write/execute permissions for the files and directories, or copy the files to a directory where you do have the appropriate permissions. Try running the 'testall' program to see a menu of the available components together with small example test forms for most of them; then inspect the code to find out how they work! #### Misc TColorButton, TSpinEdit, TFloatSpinEdit, TArrow, TCalendar, TEditButton, TFileNameEdit, TDirectoryEdit, TDateEdit, TCalcEdit, TFileListBox, TXMLPropStorage, TIniPropStorage, TBarChart, TButtonPanel, TIDEDialogLayoutStorage #### Data Controls Data-aware components, which largely replicate the Standard and Additional groups but are applicable to Databases: TDBNavigator, TDBText, TDBEdit, TDBMemo, TDBImage, TDBListBox, TDBComboBox, TDBCheckBox, TDBRadioGroup, TDBCalendar, TDBGroupBox, TDBGrid #### Data Access TDatasource, TMemDataset, TSdfDataSet, TFixedFormatDataSet, TDbf #### System TTimer, TIdleTimer, TLazComponentQueue, THtmlHelpDatabase, THtmlBrowserHelpViewer, TProcessUTF8, TAsyncProcess, TProcess, TSimpleIPCClient, TSimpleIPCServer, TXMLConfig, TEventLog #### SynEdit SynEdit is an advanced multi-line edit control, which is integrated into the Lazarus. It is the code editor of the Lazarus IDE and is available in the directory "lazarus/components/synedit". It supports Syntax Highlighting, code completion, code folding and includes exporters for html, tex and rtf. It is a fully custom drawn component, meaning that it doesn't wrap native controls of each platform and that no external library is required; this make SynEdit a crossplatform component. Note that the SynEdit available with Lazarus is a fork of the original SynEdit for Borland Delphi, Kylix and C++Builder which can be found in synedit at sourceforge. : TSynEdit, TSynAutoComplete, TSynExporterHTML, TSynMacroRecorder, TSynMemo, TSynPasSyn, TSynFreePascalSyn, TSynCppSyn, TSynJavaSyn, TSynPerlSyn, TSynHTMLSyn, TSynXMLSyn, TSynLFMSyn, TSynUNIXShellScriptSyn, TSynCssSyn, TSynPHPSyn, TSynTeXSyn, TSynSQLSyn, TSynPythonSyn, TSynVBSyn, TSynAnySyn, TSynMultiSyn ## How to use Common Controls The Units StdCtrls, ComCtrls and ExtCtrls contain definitions and descriptions of many of the most commonly used controls for constructing Forms and other Objects in Lazarus Applications. Many of the final target controls that the application developer wants to use, such as TButton, TMemo, TScrollBar etc, have a corresponding ancestor class such as TCustomButton, TCustomMemo or TCustomScrollBar. Several of the properties and methods relevant to the final target control are defined (and explained) more fully in the TCustomXXX class, and are inherited by the final target control. If you drop a component on the form editor you don't need to add code explicitly to create it. The component is automatically created by the IDE together with the form, and destroyed when the form is destroyed. However, if you create the component yourself by code don't forget to free it when it is no longer needed. #### Ways to Set Properties If you place a component on the Form Designer and look at the 物件檢視器, you can observe the properties change as you move the component around. For example, if you place a button (TButton) on the form, click on it to select it, then move it around the form with the mouse, you can watch the values of Top and Left change in the 物件檢視器 to reflect the new position. If you use the object's re-sizing bars to adjust its size, you can watch the Height and Width properties change as well. On the other hand, by using the 物件檢視器, you can select the value associated with a property such as height, and type in a new value; you can watch the size of the object on the form change to reflect the new value. You can also explicitly change the properties of the object in code by typing (in the appropriate Implementation section of the 原始碼編輯器), for example Form1.Button1.Height := 48; If you type this new value into the 原始碼編輯器 and then look back at the Form Designer, you will see that the button on the Form has taken the new size. The new value will also be shown in the 物件檢視器. In summary, there are usually about three different ways to determine each property of an object: • by using the mouse on the form, • by setting the values in the 物件檢視器, • or explicitly by writing code in the editor. #### Common Properties The components defined in these Units have several properties that are common to most of them, and other properties that are specific to the individual components. We shall describe the most common ones here. Unusual or control-specific properties will be described for the individual controls. Additional Help can always be obtained by selecting a property or keyword, in either the 物件檢視器 or the 原始碼編輯器, and pressing F1. You will be taken by your Help browser to the appropriate page in the documentation. If the description of a property on that page is insufficient, you can navigate to the corresponding description in the ancestor classes, by selecting the links in the Inheritance listing or by selecting the ancestor Type in the declaration of the object.  Property Meaning Action The main action or event associated with the object. For example selecting an 'Exit' Button might cause the 'Close' action Align Defines the way in which an object is to be lined up with the parent object. Possible values are alTop (placed at the top and using the full available width), alBottom, alLeft (placed at the left and using the full available height), alRight. alNone (place anywhere on parent control) or alClient (takes all available space next to controls aligned to top, bottom, left or right) Anchor Used to keep a control a certain distance from the defined edges of a parent control, when the parent is resized. For example [akBottom, akRight] will keep the control a fixed distance from the bottom right corner. AutoSelect When True, an editing control will select all its text when it receives focus or when the Enter key is pressed. AutoSelected True indicate that the edit or combobox control has just performed an AutoSelect operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text. BorderSpacing The space around the edge between an Anchored control and its parent. Caption The text that is displayed on or near the control; it should preferably give some clue as to the function of the control, or an instruction such as 'Close' or 'Execute'. By default Caption is set to be the same as the 'Name' property, and the application programmer should substitute meaningful text instead of the default values. CharCase Indicates how text is displayed in a text editing control: Normal (retaining the case of the letters typed by the user), converted to uppercase, or converted to lowercase Constraints Sets the minimum and maximum sizes for a control. If a control is resized the new dimensions are always within the ranges given here. You should take care when setting these options that they do not conflict with the Anchors and Align settings. Color The Colour to be used to draw the control or to write the text it contains. Enabled A Boolean property to determine whether or not a control is capable of being selected and performing an action. If it is not Enabled, it is often Grayed out on the Form. Font The Font to be used for writing the text associated with the control - either the caption or label, or the text-strings contained within the control. The entry on the 物件檢視器 usually has a (+) box on the left, and selecting this box reveals further options such as character set, colour and size. Hint A short piece of informative pop-up text that appears if the mouse-cursor hovers over the control. Items The list of 'Things' that the object contains, such as a group of images, a series of lines of text, a number of actions in an actionlist, etc Lines An array of strings, containing the textual data in controls with more than a single line of data, such as an Edit-Box or a Combo-Box. The array is zero-indexed, ie the lines are numbered [0..numLines-1] Name The identifier by which the control is known in the program. The IDE gives it a default name based on the underlying type, for example successive instances of TBitButton would be named Form1.BitBitton1 and Form1.BitButton2; it is up to the application programmer to give them more meaningful names such as ExitButton or OKButton. By default the Name of the control is applied to the Caption for the control, but the text of the Caption may be changed separately. PopUpMenu A window containing context-sensitive menu information that pops up when the right mouse button is clicked on the object. Position (or Top, Left) Determines where the control is located on the parent form or window ReadOnly Boolean property which, if True, signifies that the contents of the control can be read by the user or the calling routine, but cannot be written or changed. ShowHint Allows a small window containing a context-sensitive Help or other description to be displayed when the mouse cursor 'hovers' over the control. Size (or Height and Width) The dimensions of the control Style The options available for Style depend upon the sort of Control being considered: for instance the Style may be defined by TFormStyle, TBorderStyle, TButtonStyle etc. TabOrder Integer defining where in the sequence of tabs on the Form this control is to lie TabStop Boolean property which if True places this control in the sequence of objects that the user can reach by successively pressing the Tab key Text The String of Text that represents the actual data that this control contains. Applies particularly to Text, Memo and StringList types of object. Most of the editing operations (such as Select, Clear, Cut, Copy) are performed in this part of the object, which holds the actual string being edited. If the control contains more than a single line of text, for example TMemo or TComboBox, then the textual elements are arranged as an array of strings (zero-indexed, ie numbered from [0..numLines-1]) in Lines. Visible If true, the object can be seen on the Form; if False, object is hidden WordWrap Logical flag to show whether or not word-wrap is enabled, ie if a word comes close to the end of a line and is going to be too long for the line, it is wrapped down to the next line. #### Event Actions Many actions are commonly listed in the 'Events' tab of the 物件檢視器. If you select an entry in the list, a ComboBox appears with a DropDown list showing any actions that have aleady been defined, and allowing you to choose one to be associated with this event. Alternatively you can select the ellipsis (three dots ...) and you will be taken to an area of the 原始碼編輯器 where you can begin typing your own action instructions for the selected event. While a large number of events is available for any given control, in practice it is only necessary to populate a few of them. For most controls, it is sufficient to provide coding for 'OnClick'; for more complex controls it may be necessary also to provide for 'OnEntry' (when the mouse cursor enters the Control and gives it focus) and 'OnExit' (when the mouse cursor leaves the Control; or you may need to write an event handler for 'OnChange' or 'OnScroll', depending on the nature of the particular control with which you are dealing. The pop-up menu that appears when you right-click an object in the Form Designer has, as its first item: 'Create default event' and selecting this option will have the same effect as selecting the ellipsis in the 物件檢視器 for the default event, usually OnClick: you are taken to the Implementation area of the 原始碼編輯器 where you can type the code for the event handler. A common strategy in Object-Oriented programming is to provide an ActionList with the facility for entering, removing or editing a number of pre-defined actions from which the most appropriate can be selected to use in any particular instance.  Action Meaning OnChange Action to be taken if any change is detected (eg mouse move, mouse click, key press, edit text, alter picture, etc) OnClick Action to be taken when the (first, usually left) mouse button is clicked. This is commonly the main or default action of the control; for example clicking on a button or checkbox initiates the action associated with the checkbox. It may alternatively initate a process of selection, for instance in a TextBox or Memo, or signal the beginning of painting with a Pen or Brush. Click A method to emulate in code the effect of clicking on a control. This method is most often found in Button-type controls (TButton, TBitBtn, TSpeedButton etc). A procedure can be written that calls the same code as the OnClick action. This facility can be particularly useful if the activation of one control by clicking causes a cascade of other controls to be activated, and the Click method can be used to initiate the action rather than having the user explicitly click on a lot of controls. OnDragDrop Action to be taken during Drag-Drop manoeuvres, ie when the mouse is used to 'capture' an item or some text etc and move it around the screen to a new location. OnEntry Action to be taken when the mouse cursor enters the area occupied by the object, usually transfering focus to that object. This might include changes in the appearance of the object such as highlighting or raising the border. OnExit Action to be taken when the mouse moves out of the area of the object, usually transferring focus out of the object. OnKeyPress Action to be taken for any key-press. Subtly different from OnKeyDown, which simply responds to a key being down, whether or not it was already down when focus was given to this control. OnKeyPress requires that a key becomes pressed while focus is in this control. OnKeyDown Action to be taken if a key is down while focus is in this control. Subtly different from OnKeyPress - for example the key might already have been down when focus entered this control, whereas OnKeyPress requires the key to become pressed while focus is in the control. OnKeyUp Action to be taken if a key is up (ie not pressed) while focus is in this control. OnMouseMove Action to be taken if the mouse cursor moves while focus is in this control. OnMouseDown Action to be taken if the mouse button is down while focus is in this control. OnMouseUp Action to be taken if the mouse button is up while the cursor is over this control. Implies that the mouse button was previously down and has been released. The case where the cursor enters the control but the mouse button has not yet been pressed is covered by OnEntry or OnMouseEnter. OnResize Action to be taken when the control is resized. Might include re-alignment of text or selection of a different font size etc. #### Contructors & Destructors These are two special methods associated with each control: • Constructors: such as Create allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class. • Destructors: remove the object and de-allocate memory and other resources. If you call Destroy for an object which hasn't being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it checks whether an object's value is nil before invoking Destroy. Take the following precautions when creating your own Destroy method: • Declare Destroy with the override directive, because it is a virtual method. • Always call 'inherited Destroy;' as the last thing on the destructor code. • Be aware that an exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called when you weren't expecting it, so your destructor must check if the resources were really allocated before disposing of them. • Remember to call Free for all objects created on the constructor. ## How to use Menu Controls Hints for creating Menus for your Forms TMainMenu is the Main Menu that appears at the top of most forms; form designers can customise by choosing various menu items. TPopupMenu is a menu window that pops up with pertinent, usually context-sensitive, details and choices when the right mouse button is clicked near a control Main Menu is a non-visible component : that is, if the icon is selected from the Component Palette and placed on the Form, it will not appear at Run-time. Instead, a Menu bar with a structure defined by the Menu Editor will appear. Popup menus, placed on the form by selecting the icon from the Component Palette, do not appear at all unless the right mouse button is clicked on a control that owns such a menu. To see the Menu Editor, right-click on the Main Menu or Popup Menu icon on your Form. A pop-up box appears, that invites you to enter items into the Menu bar. An Edit box is displayed, containing a Button labelled New Item1. If you right-click on that box, a pop-up menu is displayed that allows you to add a new item before or after (along the same level) or create a sub-menu with the opportunity to add further items below (or above) the new item in a downward column. Any or all of the MenuItems that you add can be configured using the 物件檢視器. At the least you should give each item a Caption which will appear on the Menu Bar (you may also wish to give it a more meaningful Name). The caption should indicate the activity to be selected, such as "File Open" or "Close", "Run" or "Quit" If you want a particular letter in the Caption to be associated with a shortcut key, that letter should be preceded by an ampersand. The Menu item at run-time will appear with the shortcut letter underlined, and hitting that letter key will have the same effect as selecting the menu item. Alternatively you can choose a shortcut key sequence (such as Ctrl+C for Copy or Ctrl+V for Paste - the standard Keyboard shortcuts) with the ShortCut property of the MenuItem. It is often helpful to use the Menu controls in conjuction with an ActionList which contains a series of standard or customised Actions. Menu Items can be linked in the 物件檢視器 to Actions on the list, and the same actions can be linked to Buttons, ToolBar Buttons, SpeedButtons etc. It is obviously economic of effort to re-use the same code to respond to the various events, rather than writing separate OnClick event handlers for each individual control. By default a number of standard actions is pre-loaded from StdActns or, if DataAware controls are being used, from DBActns, and these can be chosen using the ActionList editor which appears when you right-click on the ActionList icon on the Form Designer. ## 除錯器 撰寫中. 可參見 IDE 視窗－除錯 ## The Lazarus files  (Thanks to Kevin Whitefoot.) (Additions by Giuseppe Ridino, User:Kirkpatc and Tom Lisjac)  When you save you will actually be saving two files:  xxx.pas and yyy.lpr  (You save more than that but those are the ones you get to name). The project file (lpr) and the unit file (pas) must not have the same name because Lazarus will helpfully rename the unit (inside the source code) to the same as the unit file name and the program to the name of the project file (it needs to do this or the compiler will probably not be able to find the unit later when referred to in the project file). Of course to be consistent it changes all the occurrences of unit1 to xxx. So if you are saving a project called again, trying to save again.pas and again.lpr fails because unit names and program names are in the same name space resulting in a duplicate name error. So here is what I ended up with: e:/lazarus/kj/lazhello: total 4740 free 76500 -rwxrwxrwx 1 kjwh root 4618697 Mar 24 11:19 again.exe -rw-rw-rw- 1 kjwh root 3002 Mar 24 11:21 again.lpi -rw-rw-rw- 1 kjwh root 190 Mar 24 11:18 again.lpr -rw-rw-rw- 1 kjwh root 506 Mar 24 11:08 againu.lfm -rw-rw-rw- 1 kjwh root 679 Mar 24 11:08 againu.lrs -rw-rw-rw- 1 kjwh root 677 Mar 24 11:08 againu.pas -rw-rw-rw- 1 kjwh root 2124 Mar 24 11:08 againu.ppu -rwxrwxrwx 1 kjwh root 335 Mar 24 11:07 ppas.bat  Note that there are many more files than the two that I thought I was saving. Here is a brief note about each file: again.exe: The main program binary executable. Win32 adds an "exe" extension. Linux has none (just the name of the program). This file will be huge in Linux due to the inclusion of debugging symbols. Run the "strip" utility to remove them and substantially shrink the executable size. again.lpi: (Lazarus Project Information). This is the main information file of a Lazarus project; the equivalent Delphi main file of an application will be the .dpr file. It is stored in an XML format and contains instructions about all the libraries and units required to build the executable file. again.lpr: The main program source file or master file. Despite its lazarus specific extension it is in fact a perfectly normal Pascal source file. It has a uses clause that lets the compiler find all the units it needs. Note that the program statement does not have to name the program the same as the file name. This file is usually fairly small, with just a few statements to initialise, build the forms, run and close the application. Most of the work is done in the unit source files, with suffix '.pas' againu.lfm: This is where Lazarus stores the layout of the form unit, in human readable form. It reflects the properties of the various components, as set in the 物件檢視器. Each object description starts with a line: object xxxx then there follows a list of properties (including embedded or nested objects) then an end  line. Lazarus uses this file to generate a resource file (.lrs) that is included in the initialisation section of the againu.pas unit. Delphi dfm files can be converted to lfm format in the Lazarus IDE using the Tools->Convert DFM file to LFM utility. againu.lrs: This is the generated resource file which contains the instructions to the program for building the form (if you look in the main Unit file, you will see in the initialization section the line {i againu.lrs}


which instructs the program to load the resource file). Note that it is not a Windows resource file.

againu.pas: The unit that contains the code for the form; this is usually the only file that the application programmer needs to edit or inspect, and contains any code specifically supplied by the programmer (especially event handlers).

againu.ppu: This is the compiled unit which gets linked into the executable file together with any other units named in the Uses section.

ppas.bat: This is a simple script that links the program to produce the executable. If compilation is successfull, it is deleted by the compiler.