From cfa370eb864bb4e040321c47b5ee56476029cbf8 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Thu, 18 Apr 2013 10:32:06 +0100 Subject: Adds a simple Git HowTo document I frequently get asked some Git questions. So hopefully having a quick reference document will help some developers. It also gives me something to quote in emails. :) --- docs/git_howto.txt | 170 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 docs/git_howto.txt (limited to 'docs') diff --git a/docs/git_howto.txt b/docs/git_howto.txt new file mode 100644 index 00000000..ce532d0e --- /dev/null +++ b/docs/git_howto.txt @@ -0,0 +1,170 @@ +> Hi. I'm on develop branch. I commited change, how can I push it to +> you? + +I'll explain the preferred method, instead of the simpler "send me a +patch file". The preferred method has many more benefits for you and me, +and makes integrating other developers changes easier. + +This is a bit long winded, but most of it is actually just about +setting up a new remote repository. This setup process is only done +once. The actual "how to share a branch with others" is answered near +the end. So if you know how to setup a forked Github repository, then +just skip to the end. + + +Using Github +------------ +If you cloned from SourceForge or from my GitHub repository, then you +only have "read" access. So you will not be allowed to push changes. + +Best is to register with Github (it is free, and very quick). Browse to +my fpGUI repository on Github (it is a mirror of the SourceForge one). + + http://github.com/graemeg/fpGUI + +Click the "fork" button. Github will now fork my repository, and you +should end up with a fpGUI repository in your github account. + + NOTE: This fork isn't automatically kept in sync with mine - it is + your repository - you keep it up to date via 'git push'. + +Now back in your Github account, note the read-write URI for the fpGUI +repository. It will be something like... + + git@github.com:/fpGUI.git + +Now on your PC, simply add the remote repository (no need to do a new +clone): + + git remote add github + +Now you can do a 'git fetch github' or 'git pull github'... If your +repository was up to date, nothing will be updated accept for references +to the branches in the 'github' remote. + +If you do a 'git remote' command, you should now see 'origin' and +'github' listed. + + +Lets do some coding (in a separate branch) +------------------------------------------ +Now you can get to the "lets do some programming bit". Create a new +branch off 'develop', which we call a "feature" branch. + + NOTE: Never do development work in 'master' or the 'develop' + branches. This will just cause you unnecessary work, and makes + my job more difficult fetching code from your repository. + + $> git checkout -b myfeature develop + +Now write some code, an make some commits. All the commits will go +into the branch named 'myfeature'. To see a graphical overview of your +repository, type 'gitk --all' + + +Moving local commits out of a wrong branch +------------------------------------------ +Now if you accidentally made commits in 'master' or 'develop', it is +not a problem to fix. This is the huge benefit of Git. Commits are +local at first, so things can be shuffled around before you make them +public. + +The easiest way to fix commits in a wrong branch, is to use the GUI +tool 'gitk'. Run 'gitk --all' + +Find the commit under the 'develop' branch that still references +'origin/develop', then right-click and select "Create new branch". +Give at a meaningful name. We'll call it 'feature-1' just for now: + +Now close gitk, and switch to that new branch. + + git checkout feature-1 + +Now back into gitk via 'gitk --all'. The 'feature-1' branch will be in +bold, indicating it is the current branch. Now we are going to +cherry-pick commits from another branch. This just means we are going +to duplicate commits from one branch into another. + +Find the commit(s) you made in the wrong branch. From oldest to +newest, select a commit, right-click and select "Cherry-pick this +commit". You will now see that commit is duplicated in your +'feature-1' branch. Keep going until you have cherry-picked all your +commits you want to move. + +Now you should have all your commits is the right branch, but +'develop' still has them too. No problem. We will simply tell git +discard those commits, by resetting the 'develop' branch to match +'origin/develop'. + +Select the commit containing the reference 'origin/develop' (this +should be the same commit you branched your 'feature-1' branch from. +Right click on that commit, and select "Reset develop branch to here". + +Now if you refresh the view, F5, or quit and restart gitk, you will +see your local commit history has been fixed, and your local commits +have been moved to the feature branch. + + +How to share my feature branch +------------------------------ +Finally, we want to share the 'myfeature' branch, so we need to push +it to the 'github' remote. + + $> git push github myfeature + + +This will push the 'myfeature' branch to your repository on Github. +Now on the Github website under the 'myfeature' branch, there should +be a button "send a pull request". Click that, and I'll be notified +via email to take a look at your code. + +To keep your repository in sync with the official fpGUI repository, +pull from 'origin' (which will be SourceForge, or my fpGUI mirror on +Github - depending which repository you clone in the beginning). Make +sure you are in say the 'master' branch. Then do the following: + + $> git push github + + +How to delete a remote branch +----------------------------- +Once you are done with a branch you shared - for example if it was +merged into the official fpGUI code, then you can delete the branch +from your Github repository. + + $> git push github :myfeature + + +How to delete a local branch +---------------------------- +Now the 'myfeature' branch is deleted on the remote repository. Now +you can delete it locally on your PC too. Make sure you our in some +other branch, not 'myfeature'. + +eg: $> git checkout master + $> git branch -d myfeature + + + +For any details on any of the commands used above, Git includes +excellent help. Just type: + + $> git help + +eg: + + $> git help remote + $> git help branch + $> git help push + + + +The Github also has some excellent documentation on using Git, and +using the Github services. Here is one such document. + +About Remote Repositories: + https://help.github.com/categories/18/articles + + + --------------------[ end ]--------------------- + -- cgit v1.2.3-70-g09d2 From b1aa8a077758fb52daa537e17a8779fffcf345a5 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Mon, 29 Apr 2013 11:12:02 +0100 Subject: Removes and old (outdated) technical document on fpGUI's design. This document was written for fpGUI v0.4 design. After the v0.4 release the whole fpGUI was rewritten. --- docs/fpGUI_tech_ref.tex | 243 ------------------------------------------------ 1 file changed, 243 deletions(-) delete mode 100644 docs/fpGUI_tech_ref.tex (limited to 'docs') diff --git a/docs/fpGUI_tech_ref.tex b/docs/fpGUI_tech_ref.tex deleted file mode 100644 index b62c959b..00000000 --- a/docs/fpGUI_tech_ref.tex +++ /dev/null @@ -1,243 +0,0 @@ -\documentclass[a4paper,11pt]{report} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Edited: 2010-02-23 -% NOTE: -% THIS DOCUMENT IS OUTDATED. IT WAS BASED ON THE fpGUI v0.4 DESIGN. -% -% This file remains in the repository for historic purposes only. -% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% Define the title -\author{Graeme Geldenhuys} -\title{fpGUI - A technical reference} - -% Some custom settings -\setlength{\parindent}{0pt} -\setlength{\parskip}{1ex plus 0.5ex minus 0.2ex} - -\begin{document} - -% generates the title -\maketitle -\newpage - -% insert the table of contents -\tableofcontents -\newpage - -% ******************************************************************* -\chapter{Introduction} -After developing many cross platform applications with Kylix and Delphi -I started getting very frustrated with the differences between the look and -behavior of the applications under Linux and Windows. The code was also -riddled with IFDEF statements. - -Then I stumbled across the Free Pascal and Lazarus projects. I thought this -is it, the answer to all my cross platform development problems. Unfortunately -after working with Lazarus for a few months I started finding more and more -issues with the widget sets, though the IDE was great. - -The Lazarus LCL is a wrapper for each platforms native widget set. This -brought with it the same issues I experienced with Kylix and Delphi. This got -me thinking about how I could resolve this issue. - -Then it hit me - implement the widget set myself using Free Pascal! Painting -the widgets myself to get a consistent look and implementing a consistent -behaviour. Instead of reinventing the wheel, I thought I would do some searching -to see if there is another project I can contribute to or help by giving me -a head start. - -The first version of my widget set was based around a heavily modified version -of the Light Pascal Toolkit\footnote{http://sourceforge.net/projects/lptk}. -I then discovered the discontinued fpGUI and fpGFX projects. I tried -to contact the original author to no avail. The fpGUI code hasn't been -touched in four years (since early 2002). After studying the code for a -few weeks, I came to the conclusion that fpGUI is much closer to what I strived -to accomplish with my modified LPTK. A lot was still missing from fpGUI though. - -After thinking long and hard, I decided to start my widget set again, but -this time based on the work done in fpGUI and fpGFX. I also added to the -mix some good ideas I saw in Qt 4.1. So far I have completed quite a few things -missing in fpGUI, but I still need to do a lot to get to the point where I -can test drive it in a commercial application. I set myself a list of -things outstanding which should get it to a usable level. I also added a -lot of documentation as I went as there was no documentation included with -the original fpGUI and fpGFX projects. Documentation is important -to attract other developers in using the widget set. - - - -% ******************************************************************* -\chapter{GUI and Events} -This chapter is currently a copy and paste of an email I wrote explaining -how the events work. The difference between the GFX events and the GUI events. -Soon I will rewrite this chapter and add a lot more detail. Here follows the email -text for now. - -The GFX part gets events from the windowing system, be that X11 or -GDI. That means that TFCustomWindow gets all the events from the -windowing system. - -Now the GUI part. Every widget is \emph{not} a TFCustomWindow, so every -widget doesn't have a Handle. The GUI is implemented with only one -handle per Form (TFForm). All widgets are just painted onto the canvas -of the TFForm. - -If you look at the TFCustomForm you will see it has a instance of -TFCustomWindow stored in FWnd. That instance gets all the events from -the windowing system. So to let the widgets also get events we have to -implement our own event system. The TFCustomForm will then send those -custom events (TEventObj descendants) by translating the windowing -events into our custom GUI events. - -For example:\\ -Lets say we have a Form with a Button on it. Now we want to handle a -OnMouseMove event on the Button. The flow of events will go as follows: - -\begin{itemize} - \item TFCustomForm.Wnd will receive the OnMouseMove from the windowing -system and process it in the WndMouseMoved() method. - - \item WndMouseMoved() will translate that windowing system event into -whatever GUI events are needed and start sending them. - - \item Any TWidget descendant handles events in the ProcessEvent() method. -TWidget being the big one. - - \item Because TFCustomForm is a TFContainerWidget descendant, it means it -can contain other widgets. So it starts distributing the GUI events to -the children. Distribution is done by the DistributeEvent() method. - - \item If TFCustomButton needed to do any special processing with the GUI -event, it would handle it in its ProcessEvent() method. -TWidget.ProcessEvent normally does most of the generic work. - - \item As an example of a widget that does custom processing, have a -look at the TFMenuItem.ProcessEvent(). In this case it handles the -TMouseEnterEventObj and TMouseLeaveEventObj events so it can changes -it's look when the mouse enters a menu item or leaves a menu item. -\end{itemize} - -So as a summary:\\ -TFCustomForm contains a instance of a GFX window. Translates all the -GFX events (underlying windowing events) to GUI events (TEventObj -descendants) and distributes them to the children of the Form. - - -% ******************************************************************* -\chapter{Layout Algorithm} - -\section{Initialisation of a window (form)} -If a window presents itself for the first time, and no standard size was - given, then it must compute these. - This is a recursive process, with which the event TCalcSizesEventObj is - set for all children of the window from top to bottom in the Widget tree - (beginning with the window). - TWidget reacts to the receipt of this event as follows (in TWidget.EvCalcSizes): - -\begin{itemize} - \item The event is passed on with TWidget.DistributeEvent to all children. - - \item The virtual protected method TWidget.DoCalcSizes is called. - Again derived Widgets overwrites this method, in order to compute its sizes - of (minimum, maximum, optimum). - - \item The results of DoCalcSizes are if necessary corrected, e.g. - the maximum size may not be smaller than the minimum size. - - \item If the code for the window finished the dispatch of this event, all Widgets - in the window has valid statements of size. - Now it can do its own, initials size sets (this is the before computed - optimum size of the window). - This is accomplished by TWidget.SetBounds. -\end{itemize} - -... to be continued ... - - -% ******************************************************************* -\chapter{Single vs Multi handle decision} - -... to be written ... - -What follows below are just some snippets from the newsgroup and mailing -lists that I want to reorganise into a chapter. These are things that -were discussed that I don't want to forget. - -\section{Notes from the newsgroup} -One handle per Form. Widgets are just painted onto the Form canvas. This -will support the most platforms and give us a consistent behavior. - -See the /prototype/multihandle directory. - -I spoke to Martin Schreiber (MSEgui author) about this as well and the -better way seems to be to have one handle per Form (window) and do you -own custom events. Implementing as much as you can yourself, will give -you a consistent behavior on all platforms and make it more portable. - -Martin also tried to implement one handle per widget and came to the -following conclusion with makes sense. If you want you GUI Framework to -work the same across multiple platforms, you cannot rely on specific -behavior on a platform. With one handle per widget you are relying on -the underling windowing systems event handling and may very well differ -from another platform (which it normally does). This is what Martin -experienced, and the only way to get consistent event handling was to do -if yourself. Clipping regions was another issue Martin mentioned. - -All his points made perfect sense to me, so I continued with the fpGUI -based on one handle per Form and will guarantee that all events, and -clipping regions will work exactly the same on all platforms. Just -creating the simple prototype I already experienced different behaviors -between Windows and Linux. - -See the thread titled "Comments from Martin Schreiber" dated 2006-12-07. -There I posted some of the discussions with Martin. - -But then I remembered a very strong argument for one handle per window: -Some platforms I would like to see fpGUI running on the future simply don't support one window inside another. Like Linux Framebuffer for example. I'm not sure about Symbian OS UIQ 3, but I think too. - - -\section{Email from Martin Schreiber} -Pro's for to have a window handle for every widget: -It is possible to use more code from the operating system (clipping, -focus handling, mouse enter/leave... - -Con's: -The functionality of your widgets depends on the OS. It is not easy to -achieve the same behavior with different systems. -You have less control over the behavior of the widgets. -If there are very much widgets in a application there can be performance -and resource problems (in win95/98 the maximal count of gdi objects and -window handles is limited). -You probably need to implement simplified widgets without handles too -(TGraphicControl) which brakes orthogonality. - -I did three attempts to develop a GUI environment, the first approach -was based on VCL, the second on CLX and now MSEgui which is done from -scratch. -With VCL and CLX I needed very much time to find workarounds to change -their behavior, some things where simply not possible to realize. -With about the same expenditure of time I have reached in MSEgui a -really enjoyable level. -As an example, the implementation of transparent widgets took me weeks -in VCL/CLX, semi-transparency was almost unreachable. -In MSEgui I could implement transparent widgets in 10 minutes because my -self developed clipping handling was flexible enough. - -So my tip is to do as much as possible by your self, at the end you will -need less time and the quality will be much better. -But don't underestimate the expenditure of the project. -For comparison: I invested about 10'000 hours into the development of -MSEide+MSEgui up to now. - -Martin - -% ******************************************************************* -\chapter{Database Components} - -... to be written ... - - -\end{document} -- cgit v1.2.3-70-g09d2 From fd500e73c7bc7053df0d5305094b9948139fc30b Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Mon, 29 Apr 2013 11:20:56 +0100 Subject: Deletes another old and outdated documentation. This too was for v0.4 and earlier. --- docs/layouting_de.html | 129 ------------------------------------------------- 1 file changed, 129 deletions(-) delete mode 100644 docs/layouting_de.html (limited to 'docs') diff --git a/docs/layouting_de.html b/docs/layouting_de.html deleted file mode 100644 index 0d2f5c0c..00000000 --- a/docs/layouting_de.html +++ /dev/null @@ -1,129 +0,0 @@ -fpGUI Layouting - - - - - -

-Der fpGUI Layouting-Algorithmus -

- -Sebastian Günther, 2001-02-12 - -

- -

-Initialisierung eines Fensters (Forms) -

- -

-Wenn sich ein Fenster zum ersten Mal darstellt, und keine Standardgröße vorgegeben -wurde, dann muß es diese selbst berechnen. Dies ist ein rekursiver Prozeß, bei -dem allen Kindern des Fensters das Ereignis TCalcSizesEventObj von -oben nach unten im Widget-Baum zugestellt wird (beginnend beim Fenster selbst). -TWidget reagiert auf den Empfang dieses Ereignisses folgendermaßen -(in TWidget.EvCalcSizes): - -

- -

    -
  1. Das Ereignis wird mit TWidget.DistributeEvent an alle Kinder weitergeleitet -
  2. -
  3. Die virtuelle geschützte Methode TWidget.DoCalcSizes wird aufgerufen. -Abgeleitete Widgets überschreiben diese Methode, um ihre Größen (Minimum, Maximum, -Optimum) neu zu berechnen. -
  4. -
  5. Die Ergebnisse von DoCalcSizes werden ggf. korrigiert, z.B. darf die -Maximalgröße nicht kleiner als die Minimalgröße sein. -
  6. -
-Wenn der Code für das Fenster den Versand dieses Ereignisses fertiggestellt -hat, haben alle Widgets im Fenster gültige Größenangaben. Nun kann es seine -eigene, initiale Größe setzen (dies ist die vorher berechnete Optimum-Größe -des Fensters). Dies wird per TWidget.SetBounds durchgeführt. - -

- -

-Zuweisung einer neuen Position und Größe mit TWidget.SetBounds -

- -

-SetBounds dient zwei Zwecken: Dem Setzen einer neuen Position, und -dem Setzen einer neuen Größe für ein Widget. Zunächst werden die neuen Daten -ins Widget übernommen. SetBounds überprüft anschließend, ob eine Größenänderung -vorliegt - wenn ja, wird ein TApplySizeEventObj-Ereignis ausgelöst. -Der Default-Handler in TWidget führt nun zwei einfache Schritte durch: - -

- -

    -
  1. Aufruf der virtuellen geschützten Methode TWidget.DoApplySize -
  2. -
  3. Weiterleitung des Ereignisses an alle Kinder per TWidget.DistributeEvent -
  4. -
-DoApplySize dürfte von allen Widgets überschrieben werden, die Kinder -besitzen - denn dies ist der einzig richtige Ort, um die Kinder zu layouten -(also ihre Position und Größe festzulegen.) - -

-Das TApplySizeEventObj-Ereignis führt ein wichtiges Flag mit: ForcedSize -gibt an, ob die nun folgende Größenänderung 'erzwungen' ist oder nicht. Erzwungen -bedeutet, daß Änderungen an untergeordneten Widgets (s.u.) keinen erneuten -Layout-Vorgang auslösen sollen. Dies wird beispielsweise in folgenden Fällen -genutzt: - -

- -

    -
  • Der Anwender hat ein Fenster manuell auf eine bestimmte Größe gebracht -
  • -
  • Eine ScrollBox löscht üblicherweise dieses Flag für ihre Kinder auf jeden Fall, -da der Inhalt der ScrollBox meist unabhängig von dem 'Drumherum' ist. -
  • -
-Der aktuelle 'Gezwungenheits-Zustand' wird über das Flag wsSizeIsForced -in TWidget.WidgetState angezeigt. - -

-Forms behandeln dieses Ereignis auf etwas andere Art und Weise: Der Wunsch nach -einer Größenänderung wird an das unterliegende fpGFX-Fenster weitergeleitet; -dieses liefert irgendwann die Nachricht, daß nun die neue Größe aktiv ist. Als -Reaktion ruft es nun TWidget.SetBounds für sich selbst auf - -also die geerbte Methode. Diese sorgt dann, wie bei anderen Widgets auch, für -ein korrektes Layouting. - -

- -

-Änderungen eines Widgets -

- -

-Wenn sich bestimmte Eigenschaften eines Widgets ändern, kann sich dadurch auch -dessen Größe ändern. Bei Verdacht auf Größenänderung sollten Widgets intern -immer die Methode TWidget.Update aufrufen. Ist die Größe des aktuellen -Widgets erzwungen, so bricht diese Methode sofort ab. Ansonsten wird zunächst -eine neue Berechnung der Größen per TCalcSizesEventObj-Ereignis veranlaßt. -Sollten diese nun von den alten Größen abweichen, so wird das Ereignis TUpdateEventObj -ausgelöst. Dieses wird nicht an Kinder weitergeleitet, stattdessen -ruft der Default-Handler in TWidget die Update-Methode des -Eltern-Widgets auf. Der Handler für Forms reagiert auf dieses Ereignis allerdings -mit einer Anpassung der Fenstergröße mit Hilfe der SetBounds-Methode. - -

- -

-Widget ändert seine Sichtbarkeit -

- -

-Wenn ein normales Widget sichtbar oder unsichtbar wird, und diese Änderung vom -Widget selbst (und nicht seinem Eltern-Widget) ausgelöst wurde, dann wird für -das Eltern-Widget die TWidget.Update-Methode aufgerufen. Dieses prüft -nun den Einfluß dieser Änderung auf das Layout, und löst ggf. ein Relayouting -aus. - - -

\ No newline at end of file -- cgit v1.2.3-70-g09d2 From a2bf93f0a9f6ffe838a5263b4891284115e3a462 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Mon, 29 Apr 2013 12:15:44 +0100 Subject: some API documentation updates --- docs/xml/corelib/fpg_base.xml | 20 ++++++++++++++------ docs/xml/corelib/fpg_extinterpolation.xml | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index 05a1f72f..48c30abb 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -79,8 +79,8 @@ means no titlebar or window borders are going to be created. - This windows type is similar to wtWindow, but grabs focus. - This windows is the same as wtWindow, but grabs the input focus until it has closed. This window normally doesn't appear in the taskbar. + This windows type is similar to wtWindow, but grabs focus. + This windows is the same as wtWindow, but grabs the input focus until it has closed. This window normally doesn't appear in the taskbar. @@ -831,6 +831,10 @@ consecutive lines being drawn without overlapping pixels. Allows you to draw a bitmap, stretched or shrunken from its original size +. Default +interpolation is TfpgMitchelInterpolation, +but others (found in fpg_extinterpolation.pas) can +be used too, by using the InterpolationFilter property of the Canvas. @@ -1038,18 +1042,22 @@ for more information.

-aoeu - +Base class for the fpgApplication variable +This is the base class of TfpgApplication. All fpGUI-based applications +will contain a instance of TfpgApplication. It encapsulates the application as +a whole, and also supplies many useful functions and events. Specify a help file for the application -bla bla bla +This property is used to assign the help file (normally an INF file) which +contains the help for the application. Run the help viewer -bla bla bla +This method will invoke the defined help viewer, passing it the HelpContext +or HelpKeyword as parameter. The default help viewer is fpGUI's DocView. diff --git a/docs/xml/corelib/fpg_extinterpolation.xml b/docs/xml/corelib/fpg_extinterpolation.xml index af129a1f..81d66e83 100644 --- a/docs/xml/corelib/fpg_extinterpolation.xml +++ b/docs/xml/corelib/fpg_extinterpolation.xml @@ -4,7 +4,7 @@ Extra interpolation filter declarations. -

Some more interpolation filters for TfpgCanvasBase.StretchDraw:
+

This unit defines more interpolation filters for TfpgCanvasBase.StretchDraw:
Bessel, Gaussian and Sinc are infinite impulse response (IIR), the others are finite impulse response (FIR). The implementation of Bessel and Sinc are windowed with Blackman filter.

-- cgit v1.2.3-70-g09d2 From 384d75d14735a111bf96bc3054d8a40c0601f53d Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Mon, 29 Apr 2013 17:13:27 +0100 Subject: updates fpdoc project file. Just made it slightly simpler to copy & paste options when switching between output formats (IPF, HTML etc). --- docs/fpgui-docs-project.xml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/fpgui-docs-project.xml b/docs/fpgui-docs-project.xml index c4758228..59d15c6b 100644 --- a/docs/fpgui-docs-project.xml +++ b/docs/fpgui-docs-project.xml @@ -133,15 +133,20 @@ and value as on the actual command-line. Boolean options must have a value of 'true', '1' or 'yes' -->
it brings a window to the front - above all other windows of the application. Note that this only changes the z-order, it doesn't actually change window focus. - + @@ -728,7 +728,7 @@ it makes the target window the active window. Note that depending on the operati and Window Manager, the active window could still be obscured by other windows. Under Windows, it seems that the active window is always brought to the front too. - + @@ -1041,8 +1041,7 @@ goes counter-clockwise, and a negative values goes clockwise. A record structure holding the RGBA values of a color. This is the same declaration as the one found in FPImage (included with the -Free Pascal Compiler). In future when FPImage is integrated with fpGUI, this declaration -will be removed. +Free Pascal Compiler). Except the fpGUI version uses Byte values and not Word values. This is now marked as "deprecated". Please use TRGBTripple instead. -- cgit v1.2.3-70-g09d2 From b0c9f165ee385f085c2f1086510daf8002f6fc51 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Sun, 23 Feb 2014 14:51:47 +0000 Subject: documentation scripts update Updated the scripts by removing missing fpdoc XML files. --- docs/build_html.sh | 8 -------- docs/build_ipf.sh | 8 -------- docs/build_rtf.sh | 9 +-------- 3 files changed, 1 insertion(+), 24 deletions(-) (limited to 'docs') diff --git a/docs/build_html.sh b/docs/build_html.sh index fd36b7bf..b43cdd63 100755 --- a/docs/build_html.sh +++ b/docs/build_html.sh @@ -15,20 +15,12 @@ $app \ --input='-Fi../src/corelib ../src/corelib/x11/fpg_x11.pas' --descr=xml/corelib/x11/fpg_x11.xml \ --input='-Fi../src/corelib ../src/corelib/gdi/fpg_gdi.pas' --descr=xml/corelib/gdi/fpg_gdi.xml \ --input='-Fi../src/corelib -Fi../src ../src/corelib/fpg_main.pas' --descr=xml/corelib/fpg_main.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_cmdlineparams.pas' --descr=xml/corelib/fpg_cmdlineparams.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_extinterpolation.pas' --descr=xml/corelib/fpg_extinterpolation.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_imgfmt_bmp.pas' --descr=xml/corelib/fpg_imgfmt_bmp.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stdimages.pas' --descr=xml/corelib/fpg_stdimages.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringutils.pas' --descr=xml/corelib/fpg_stringutils.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_widget.pas' --descr=xml/corelib/fpg_widget.xml \ --input='-Fi../src/corelib -Fi../src/corelib/x11 ../src/corelib/fpg_utils.pas' --descr=xml/corelib/fpg_utils.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_popupwindow.pas' --descr=xml/corelib/fpg_popupwindow.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_wuline.pas' --descr=xml/corelib/fpg_wuline.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_imagelist.pas' --descr=xml/corelib/fpg_imagelist.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_constants.pas' --descr=xml/corelib/fpg_constants.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_pofiles.pas' --descr=xml/corelib/fpg_pofiles.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_translations.pas' --descr=xml/corelib/fpg_translations.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringhashlist.pas' --descr=xml/corelib/fpg_stringhashlist.xml \ --input='-Fi../src -Fu../src/corelib/x11/ -Fi../src/corelib/x11/ -Fu../src/gui/ -Fu../src/corelib/ ../src/corelib/fpg_command_intf.pas' --descr=xml/corelib/fpg_command_intf.xml \ --input='-Fi../src/gui ../src/gui/fpg_dialogs.pas' --descr=xml/gui/fpg_dialogs.xml \ --input='-Fi../src/gui ../src/gui/fpg_hyperlink.pas' --descr=xml/gui/fpg_hyperlink.xml \ diff --git a/docs/build_ipf.sh b/docs/build_ipf.sh index 14b0693c..bdb841b1 100755 --- a/docs/build_ipf.sh +++ b/docs/build_ipf.sh @@ -14,20 +14,12 @@ $app \ --input='-Fi../src/corelib ../src/corelib/x11/fpg_x11.pas' --descr=xml/corelib/x11/fpg_x11.xml \ --input='-Fi../src/corelib ../src/corelib/gdi/fpg_gdi.pas' --descr=xml/corelib/gdi/fpg_gdi.xml \ --input='-Fi../src/corelib -Fi../src ../src/corelib/fpg_main.pas' --descr=xml/corelib/fpg_main.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_cmdlineparams.pas' --descr=xml/corelib/fpg_cmdlineparams.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_extinterpolation.pas' --descr=xml/corelib/fpg_extinterpolation.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_imgfmt_bmp.pas' --descr=xml/corelib/fpg_imgfmt_bmp.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stdimages.pas' --descr=xml/corelib/fpg_stdimages.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringutils.pas' --descr=xml/corelib/fpg_stringutils.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_widget.pas' --descr=xml/corelib/fpg_widget.xml \ --input='-Fi../src/corelib -Fi../src/corelib/x11 ../src/corelib/fpg_utils.pas' --descr=xml/corelib/fpg_utils.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_popupwindow.pas' --descr=xml/corelib/fpg_popupwindow.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_wuline.pas' --descr=xml/corelib/fpg_wuline.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_imagelist.pas' --descr=xml/corelib/fpg_imagelist.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_constants.pas' --descr=xml/corelib/fpg_constants.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_pofiles.pas' --descr=xml/corelib/fpg_pofiles.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_translations.pas' --descr=xml/corelib/fpg_translations.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringhashlist.pas' --descr=xml/corelib/fpg_stringhashlist.xml \ --input='-Fi../src -Fu../src/corelib/x11/ -Fi../src/corelib/x11/ -Fu../src/gui/ -Fu../src/corelib/ ../src/corelib/fpg_command_intf.pas' --descr=xml/corelib/fpg_command_intf.xml \ --input='-Fi../src/gui ../src/gui/fpg_dialogs.pas' --descr=xml/gui/fpg_dialogs.xml \ --input='-Fi../src/gui ../src/gui/fpg_hyperlink.pas' --descr=xml/gui/fpg_hyperlink.xml \ diff --git a/docs/build_rtf.sh b/docs/build_rtf.sh index eb879f05..33b1825e 100755 --- a/docs/build_rtf.sh +++ b/docs/build_rtf.sh @@ -13,20 +13,13 @@ $app \ --input='-Fi../src/corelib ../src/corelib/x11/fpg_x11.pas' --descr=xml/corelib/x11/fpg_x11.xml \ --input='-Fi../src/corelib ../src/corelib/gdi/fpg_gdi.pas' --descr=xml/corelib/gdi/fpg_gdi.xml \ --input='-Fi../src/corelib -Fi../src ../src/corelib/fpg_main.pas' --descr=xml/corelib/fpg_main.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_cmdlineparams.pas' --descr=xml/corelib/fpg_cmdlineparams.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_extinterpolation.pas' --descr=xml/corelib/fpg_extinterpolation.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_imgfmt_bmp.pas' --descr=xml/corelib/fpg_imgfmt_bmp.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stdimages.pas' --descr=xml/corelib/fpg_stdimages.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringutils.pas' --descr=xml/corelib/fpg_stringutils.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_widget.pas' --descr=xml/corelib/fpg_widget.xml \ --input='-Fi../src/corelib -Fi../src/corelib/x11 ../src/corelib/fpg_utils.pas' --descr=xml/corelib/fpg_utils.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_popupwindow.pas' --descr=xml/corelib/fpg_popupwindow.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_wuline.pas' --descr=xml/corelib/fpg_wuline.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_imagelist.pas' --descr=xml/corelib/fpg_imagelist.xml \ --input='-Fi../src/corelib ../src/corelib/fpg_constants.pas' --descr=xml/corelib/fpg_constants.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_pofiles.pas' --descr=xml/corelib/fpg_pofiles.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_translations.pas' --descr=xml/corelib/fpg_translations.xml \ - --input='-Fi../src/corelib ../src/corelib/fpg_stringhashlist.pas' --descr=xml/corelib/fpg_stringhashlist.xml \ + --input='-Fi../src -Fu../src/corelib/x11/ -Fi../src/corelib/x11/ -Fu../src/gui/ -Fu../src/corelib/ ../src/corelib/fpg_command_intf.pas' --descr=xml/corelib/fpg_command_intf.xml \ --input='-Fi../src/gui ../src/gui/fpg_dialogs.pas' --descr=xml/gui/fpg_dialogs.xml \ --input='-Fi../src/gui ../src/gui/fpg_hyperlink.pas' --descr=xml/gui/fpg_hyperlink.xml \ --input='-Fi../src/gui ../src/gui/fpg_colormapping.pas' --descr=xml/gui/fpg_colormapping.xml \ -- cgit v1.2.3-70-g09d2 From c216e838de70ff2eec6223434627773a27a1262b Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Mon, 24 Mar 2014 05:48:58 +0000 Subject: fpc_lang_ref.ipf: minor fix to diagram Also placed a note of where I should continue from. --- docs/fpc_lang_ref.ipf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/fpc_lang_ref.ipf b/docs/fpc_lang_ref.ipf index c6440957..abe951e9 100644 --- a/docs/fpc_lang_ref.ipf +++ b/docs/fpc_lang_ref.ipf @@ -5003,7 +5003,7 @@ internally to denote 'nodefault'. :p. aoeu .* START HERE !!!!!!!!!!!!!!!!!!!!!! - +:h5.*** START HERE *** .* ============================================================== :h2 name=interfaces.Interfaces @@ -5156,7 +5156,7 @@ used by a program or another unit. The syntax for a unit is as follows: &ra.─────┬────────────────────────────────────────────┬─ :hp2.end:ehp2. ── . ─────────────────&ra.&la. ├─ initialization part ─┬───────────────────┬┤ │ └ finalization part ┘│ - └─ :hp2.begin:ehp2. ─── statement ─┬───────────────────┘ + └─ :hp2.begin:ehp2. ─┬─ statement ─┬───────────────────┘ ^───── ; ─────┘ &ra.&ra.─── unit header ── :hp2.unit:ehp2. ── unit identifier ── ; ──────────────────────────────&ra.&la. -- cgit v1.2.3-70-g09d2 From 6ffa508e88ae69d78361903c7334e58f8d520710 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Sun, 27 Apr 2014 01:24:22 +0100 Subject: docs: Updated fpg_tree unit documentation with new TfpgTreeNode.TreeView info --- docs/xml/gui/fpg_tree.xml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs') diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml index 6a69fd64..da1c631f 100644 --- a/docs/xml/gui/fpg_tree.xml +++ b/docs/xml/gui/fpg_tree.xml @@ -10,6 +10,20 @@ You can include icons with items' text labels and display different icons to indicate whether a node is expanded or collapsed.

+ +TfpgTreeNdoe describes an individual node in a tree view widget. +Each node in a tree view control consists of a label and an optional +bitmapped image. Each item can be the parent of a list of subitems. By clicking +an item, the user can expand or collapse the associated list of subitems. + + TfpgTreeView + + + + +Specifies the tree view widget that displays the node. +Use TreeView to determine the tree view associated with the tree node. + Represents a window that displays a hierachy list of items @@ -21,6 +35,9 @@ in a tree view control consists of a label and a number of optional bitmapped im Each node can have a list of subnodes associated with it. By clicking on a node, the user can expand or collapse the associated list of subnodes.

There is basic column support, but this is still very experimental. + + TfpgTreeNode +
-- cgit v1.2.3-70-g09d2 From 790a5909884d394f2b461a69239d60874850b656 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Thu, 17 Jul 2014 23:37:23 +0100 Subject: Bump the version number of various files --- docs/fpGUIHelpIntegration.lpk | 2 +- docs/manifest.xml | 4 ++-- docview/src/docview.rc | 8 ++++---- src/VERSION_FILE.inc | 2 +- src/corelib/fpg_constants.pas | 2 +- src/corelib/gdi/fpgui_toolkit.lpk | 2 +- src/corelib/x11/fpgui_toolkit.lpk | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/fpGUIHelpIntegration.lpk b/docs/fpGUIHelpIntegration.lpk index 7d02a4e4..81c16ce8 100644 --- a/docs/fpGUIHelpIntegration.lpk +++ b/docs/fpGUIHelpIntegration.lpk @@ -24,7 +24,7 @@ "/> - + diff --git a/docs/manifest.xml b/docs/manifest.xml index d89f8ec5..addb40c3 100644 --- a/docs/manifest.xml +++ b/docs/manifest.xml @@ -1,8 +1,8 @@ - - fpgui-0.6.3-0.zip + + fpgui-1.2.0-0.zip Graeme Geldenhuys Modified LGPL graemeg@gmail.com diff --git a/docview/src/docview.rc b/docview/src/docview.rc index 64d63286..749a08de 100644 --- a/docview/src/docview.rc +++ b/docview/src/docview.rc @@ -1,8 +1,8 @@ MAINICON ICON "../images/docview-48x48.ico" 1 VERSIONINFO -FILEVERSION 1, 1, 0, 0 -PRODUCTVERSION 1, 1, 0, 0 +FILEVERSION 1, 2, 0, 0 +PRODUCTVERSION 1, 2, 0, 0 FILEFLAGSMASK 0 FILEOS 0x40000 FILETYPE 1 @@ -13,12 +13,12 @@ FILETYPE 1 { VALUE "CompanyName", "fpGUI Toolkit" VALUE "FileDescription", "fpGUI's INF Documentation Viewer" - VALUE "FileVersion", "1.1.0" + VALUE "FileVersion", "1.2.0" VALUE "InternalName", "docview" VALUE "LegalCopyright", "GNU Public License" VALUE "OriginalFilename", "docview" VALUE "ProductName", "fpGUI Toolkit" - VALUE "ProductVersion", "1.1.0" + VALUE "ProductVersion", "1.2.0" } } BLOCK "VarFileInfo" diff --git a/src/VERSION_FILE.inc b/src/VERSION_FILE.inc index b47293e2..b0593919 100644 --- a/src/VERSION_FILE.inc +++ b/src/VERSION_FILE.inc @@ -1 +1 @@ -FPGUI_VERSION = '1.1'; +FPGUI_VERSION = '1.2'; diff --git a/src/corelib/fpg_constants.pas b/src/corelib/fpg_constants.pas index 37b3f135..60bd18e7 100644 --- a/src/corelib/fpg_constants.pas +++ b/src/corelib/fpg_constants.pas @@ -1,7 +1,7 @@ { fpGUI - Free Pascal GUI Toolkit - Copyright (C) 2006 - 2010 See the file AUTHORS.txt, included in this + Copyright (C) 2006 - 2014 See the file AUTHORS.txt, included in this distribution, for details of the copyright. See the file COPYING.modifiedLGPL, included in this distribution, diff --git a/src/corelib/gdi/fpgui_toolkit.lpk b/src/corelib/gdi/fpgui_toolkit.lpk index c4e4958e..dfe56c14 100644 --- a/src/corelib/gdi/fpgui_toolkit.lpk +++ b/src/corelib/gdi/fpgui_toolkit.lpk @@ -30,7 +30,7 @@ - + diff --git a/src/corelib/x11/fpgui_toolkit.lpk b/src/corelib/x11/fpgui_toolkit.lpk index 96af53ed..ec8c841f 100644 --- a/src/corelib/x11/fpgui_toolkit.lpk +++ b/src/corelib/x11/fpgui_toolkit.lpk @@ -28,7 +28,7 @@ - + -- cgit v1.2.3-70-g09d2 From eb3ed0f901e78397c6f58921d569d305e1d7cc00 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Wed, 20 Aug 2014 00:42:15 +0100 Subject: Adds new units to the documentation project file --- docs/fpgui-docs-project.xml | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs') diff --git a/docs/fpgui-docs-project.xml b/docs/fpgui-docs-project.xml index 59d15c6b..48395aba 100644 --- a/docs/fpgui-docs-project.xml +++ b/docs/fpgui-docs-project.xml @@ -45,6 +45,8 @@ + + @@ -69,14 +71,18 @@ + + + + -- cgit v1.2.3-70-g09d2 From 4a592d3edbc488d50e9e58b67e789902e3d88bc0 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Wed, 20 Aug 2014 00:42:34 +0100 Subject: docs: fixes a minor spelling mistake --- docs/xml/corelib/fpg_base.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index 82a83f25..f052e2f0 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -722,7 +722,7 @@ this only changes the z-order, it doesn't actually change window focus. -This makse the target window the active window +This makes the target window the active window This doesn't have much meaning at the widget level, but at the TfpgForm level, it makes the target window the active window. Note that depending on the operating system and Window Manager, the active window could still be obscured by other windows. Under Windows, -- cgit v1.2.3-70-g09d2