diff options
| -rwxr-xr-x | docs/build_gfx.sh | 9 | ||||
| -rwxr-xr-x | docs/build_gui.sh | 3 | ||||
| -rwxr-xr-x | docs/new_gui.sh | 1 | ||||
| -rwxr-xr-x | docs/update_docs.sh | 30 | ||||
| -rw-r--r-- | docs/xml/corelib/gfx_utils.xml | 218 | ||||
| -rw-r--r-- | docs/xml/gui/gui_hyperlink.xml | 85 |
6 files changed, 311 insertions, 35 deletions
diff --git a/docs/build_gfx.sh b/docs/build_gfx.sh index 6ebd9cae..943044a9 100755 --- a/docs/build_gfx.sh +++ b/docs/build_gfx.sh @@ -17,9 +17,14 @@ fpdoc --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_stdimages.pas' --descr=xml/corelib/gfx_stdimages.xml \ --input='-Fi../src/corelib ../src/corelib/gfx_utf8utils.pas' --descr=xml/corelib/gfx_utf8utils.xml \ --input='-Fi../src/corelib ../src/corelib/gfx_widget.pas' --descr=xml/corelib/gfx_widget.xml \ - --input='-Fi../src/corelib ../src/corelib/x11/gfx_utils.pas' --descr=xml/corelib/gfx_utils.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_utils.pas' --descr=xml/corelib/gfx_utils.xml \ --input='-Fi../src/corelib ../src/corelib/gfx_popupwindow.pas' --descr=xml/corelib/gfx_popupwindow.xml \ - --input='-Fi../src/corelib ../src/corelib/gfx_wuline.pas' --descr=xml/corelib/gfx_wuline.xml + --input='-Fi../src/corelib ../src/corelib/gfx_wuline.pas' --descr=xml/corelib/gfx_wuline.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_imagelist.pas' --descr=xml/corelib/gfx_imagelist.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_constants.pas' --descr=xml/corelib/gfx_constants.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_pofiles.pas' --descr=xml/corelib/gfx_pofiles.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_translations.pas' --descr=xml/corelib/gfx_translations.xml \ + --input='-Fi../src/corelib ../src/corelib/gfx_stringhashlist.pas' --descr=xml/corelib/gfx_stringhashlist.xml # --input='-Fi../src/corelib ../src/corelib/x11/gfx_.pas' --descr=xml/corelib/gfx_.xml \ diff --git a/docs/build_gui.sh b/docs/build_gui.sh index f6c0c5ec..633360cd 100755 --- a/docs/build_gui.sh +++ b/docs/build_gui.sh @@ -30,7 +30,8 @@ fpdoc --package=GUI \ --descr=xml/gui/gui_iniutils.xml --input='-Fi../src/gui ../src/gui/gui_iniutils.pas' \ --descr=xml/gui/gui_mru.xml --input='-Fi../src/gui ../src/gui/gui_mru.pas' \ --descr=xml/gui/gui_gauge.xml --input='-Fi../src/gui ../src/gui/gui_gauge.pas' \ - --descr=xml/gui/gui_popupcalendar.xml --input='-Fi../src/gui ../src/gui/gui_popupcalendar.pas' + --descr=xml/gui/gui_popupcalendar.xml --input='-Fi../src/gui ../src/gui/gui_popupcalendar.pas' \ + --descr=xml/gui/gui_hyperlink.xml --input='-Fi../src/gui ../src/gui/gui_hyperlink.pas' # --descr=xml/gui/gui_.xml --input='-Fi../src/gui ../src/gui/gui_.pas' \ diff --git a/docs/new_gui.sh b/docs/new_gui.sh index 954619ef..0d0986e7 100755 --- a/docs/new_gui.sh +++ b/docs/new_gui.sh @@ -28,6 +28,7 @@ makeskel --package=GUI --output=xml/gui/gui_iniutils.xml --input='-Fi../src/gui makeskel --package=GUI --output=xml/gui/gui_mru.xml --input='-Fi../src/gui ../src/gui/gui_mru.pas' makeskel --package=GUI --output=xml/gui/gui_gauge.xml --input='-Fi../src/gui ../src/gui/gui_gauge.pas' makeskel --package=GUI --output=xml/gui/gui_popupcalendar.xml --input='-Fi../src/gui ../src/gui/gui_popupcalendar.pas' +# makeskel --package=GUI --output=xml/gui/gui_hyperlink.xml --input='-Fi../src/gui ../src/gui/gui_hyperlink.pas' # makeskel --package=GUI --output=xml/gui/gui_.xml --input='-Fi../src/gui ../src/gui/gui_.pas' diff --git a/docs/update_docs.sh b/docs/update_docs.sh index b514031c..eeb37cc8 100755 --- a/docs/update_docs.sh +++ b/docs/update_docs.sh @@ -1,32 +1,30 @@ #!/bin/sh # fpc/bin must be in your PATH -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfxbase.pas' --descr="xml/corelib/gfxbase.xml" --output="xml/corelib/gfxbase.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/x11/gfx_x11.pas' --descr="xml/corelib/x11/gfx_x11.xml" --output="xml/corelib/x11/gfx_x11.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gdi/gfx_gdi.pas' --descr="xml/corelib/gdi/gfx_gdi.xml" --output="xml/corelib/gdi/gfx_gdi.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/fpgfx.pas' --descr="xml/corelib/fpgfx.xml" --output="xml/corelib/fpgfx.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_cmdlineparams.pas' --descr="xml/corelib/gfx_cmdlineparams.xml" --output="xml/corelib/gfx_cmdlineparams.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_extinterpolation.pas' --descr="xml/corelib/gfx_extinterpolation.xml" --output="xml/corelib/gfx_extinterpolation.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_imgfmt_bmp.pas' --descr="xml/corelib/gfx_imgfmt_bmp.xml" --output="xml/corelib/gfx_imgfmt_bmp.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_stdimages.pas' --descr="xml/corelib/gfx_stdimages.xml" --output="xml/corelib/gfx_stdimages.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_utf8utils.pas' --descr="xml/corelib/gfx_utf8utils.xml" --output="xml/corelib/gfx_utf8utils.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_widget.pas' --descr="xml/corelib/gfx_widget.xml" --output="xml/corelib/gfx_widget.new.xml" -makeskel --update --package=CoreLib \ - --input='-Fi../src/corelib ../src/corelib/x11/gfx_utils.pas' --descr="xml/corelib/x11/gfx_utils.xml" --output="xml/corelib/x11/gfx_utils.new.xml" -makeskel --update --package=CoreLib \ - --input='-Fi../src/corelib ../src/corelib/gdi/gfx_utils.pas' --descr="xml/corelib/gdi/gfx_utils.xml" --output="xml/corelib/gdi/gfx_utils.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ + --input='-Fi../src/corelib ../src/corelib/gfx_utils.pas' --descr="xml/corelib/gfx_utils.xml" --output="xml/corelib/gfx_utils.new.xml" +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_popupwindow.pas' --descr="xml/corelib/gfx_popupwindow.xml" --output="xml/corelib/gfx_popupwindow.new.xml" -makeskel --update --package=CoreLib \ +makeskel --disable-private --update --package=CoreLib \ --input='-Fi../src/corelib ../src/corelib/gfx_wuline.pas' --descr="xml/corelib/gfx_wuline.xml" --output="xml/corelib/gfx_wuline.new.xml" diff --git a/docs/xml/corelib/gfx_utils.xml b/docs/xml/corelib/gfx_utils.xml index dee4090c..6c833f0b 100644 --- a/docs/xml/corelib/gfx_utils.xml +++ b/docs/xml/corelib/gfx_utils.xml @@ -10,8 +10,8 @@ <module name="gfx_utils"> <short>Utility functions.</short> -<descr>Utility functions that need different implementations for each - supported platform. +<descr>Utility functions used throughout fpGUI. Some have common +implementations and some have platform specific implementations. </descr> <!-- unresolved type reference Visibility: default --> @@ -32,12 +32,42 @@ </seealso> </element> +<!-- unresolved type reference Visibility: default --> +<element name="gfxbase"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + +<!-- function Visibility: default --> +<element name="fpgToOSEncoding"> +<short>Converts string from fpGUI to OS specific filesystem encoding</short> +<descr>This function is specific to filesystem strings like Paths, Filenames + and Directories. +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgToOSEncoding.Result"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgToOSEncoding.aString"> +<short></short> +</element> + <!-- function Visibility: default --> -<element name="ExtractTargetSymLinkPath"> -<short>Returns the target symbolic link path</short> -<descr>This functions returns a blank string under Windows because the file - system doesn't support symbolic links. Under Linux it returns the target path - of the symbol link. This function is used in the File Open/Save dialog. +<element name="fpgFromOSEncoding"> +<short>Converts OS specific filesystem encoding to fpGUI string</short> +<descr>This function is specific to filesystem strings like Paths, Filenames + and Directories. </descr> <errors> </errors> @@ -46,21 +76,177 @@ </element> <!-- function result Visibility: default --> -<element name="ExtractTargetSymLinkPath.Result"> +<element name="fpgFromOSEncoding.Result"> <short></short> </element> <!-- argument Visibility: default --> -<element name="ExtractTargetSymLinkPath.ALink"> +<element name="fpgFromOSEncoding.aString"> +<short></short> +</element> + +<!-- procedure Visibility: default --> +<element name="fpgOpenURL"> +<short>Launches the users Web Browser using the specified URL</short> +<descr>On each platform, this function will try and find the appropriate (system + default) web browser. +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- argument Visibility: default --> +<element name="fpgOpenURL.aURL"> +<short>URL address to go to</short> +</element> + +<!-- function Visibility: default --> +<element name="fpgAddTrailingValue"> +<short>If ALine is not '', add the trailing value AValue</short> +<descr>If ALine is not '', add the trailing value AValue +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgAddTrailingValue.Result"> <short></short> </element> +<!-- argument Visibility: default --> +<element name="fpgAddTrailingValue.ALine"> +<short>The source string</short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgAddTrailingValue.AValue"> +<short>The value that must be added</short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgAddTrailingValue.ADuplicates"> +<short>Are duplicate AValue's allowed</short> +</element> + <!-- function Visibility: default --> -<element name="FileIsSymlink"> -<short>Is the file a symbolic link.</short> -<descr>Under Windows this function always returns False, due to the file - system not supporting symbolic links. Under Linux it will return True if the - specified file is a symbolic link. +<element name="fpgFindFirst"> +<short></short> +<descr> +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgFindFirst.Result"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgFindFirst.Path"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgFindFirst.Attr"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgFindFirst.Rslt"> +<short></short> +</element> + +<!-- function Visibility: default --> +<element name="fpgFindNext"> +<short></short> +<descr> +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgFindNext.Result"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgFindNext.Rslt"> +<short></short> +</element> + +<!-- function Visibility: default --> +<element name="fpgGetCurrentDir"> +<short></short> +<descr> +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgGetCurrentDir.Result"> +<short></short> +</element> + +<!-- function Visibility: default --> +<element name="fpgSetCurrentDir"> +<short></short> +<descr> +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgSetCurrentDir.Result"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgSetCurrentDir.NewDir"> +<short></short> +</element> + +<!-- function Visibility: default --> +<element name="fpgExpandFileName"> +<short></short> +<descr> +</descr> +<errors> +</errors> +<seealso> +</seealso> +</element> + +<!-- function result Visibility: default --> +<element name="fpgExpandFileName.Result"> +<short></short> +</element> + +<!-- argument Visibility: default --> +<element name="fpgExpandFileName.FileName"> +<short></short> +</element> + +<!-- function Visibility: default --> +<element name="fpgFileExists"> +<short></short> +<descr> </descr> <errors> </errors> @@ -69,12 +255,12 @@ </element> <!-- function result Visibility: default --> -<element name="FileIsSymlink.Result"> +<element name="fpgFileExists.Result"> <short></short> </element> <!-- argument Visibility: default --> -<element name="FileIsSymlink.AFilename"> +<element name="fpgFileExists.FileName"> <short></short> </element> diff --git a/docs/xml/gui/gui_hyperlink.xml b/docs/xml/gui/gui_hyperlink.xml new file mode 100644 index 00000000..246a3582 --- /dev/null +++ b/docs/xml/gui/gui_hyperlink.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<fpdoc-descriptions> +<package name="GUI"> + <module name="gui_hyperlink"> +<!-- unresolved type reference Visibility: default --> +<element name="Classes"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + +<!-- unresolved type reference Visibility: default --> +<element name="Sysutils"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + +<!-- unresolved type reference Visibility: default --> +<element name="gui_label"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + +<!-- unresolved type reference Visibility: default --> +<element name="fpgfx"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + +<!-- unresolved type reference Visibility: default --> +<element name="gfxbase"> +<short></short> +<descr> +</descr> +<seealso> +</seealso> +</element> + + <element name="TfpgHyperlink"> + <short>TfpgCustomLabel derived class implements a hyperlink. </short> + <descr>This is a class to implement a hyperlink. Of course, such as all the other fpGUI components it is cross platform Windows, Linux but its behaviour can be different because the browser call. Under Windows ShellExecute Windows API is used, so you can have in the hyperlink any URL web compliant, that is, not only a typical http:// hyperlink but also a mailto: will work. +Under Linux you can have just a tipical http:// hyperlink.</descr> + </element> + <element name="TfpgHyperlink.URL"> + <short>String type property that contains the hyperlink to jump.</short> + </element> + <element name="TfpgHyperlink.FontDesc"> + <short>Standard font for this component is Arial-8:antialias=true:underline</short> + </element> + <element name="TfpgHyperlink.HandleLMouseDown"> + <short>This overriden procedure intercepts left mouse keydown, call its inherited method and run GoHyperLink method to jump hyperlink. </short> + </element> + <element name="TfpgHyperlink.GoHyperLink"> + <short>Jump to hyperlink.</short> + </element> + <element name="TfpgHyperlink.Autosize"> + <short>Its default is True, so the hyperlink width is automatically determined.</short> + </element> + <element name="TfpgHyperlink.Text"> + <short>Text description for the hyperlink.</short> + <descr>It can be, of course, different from URL and more descriptive about the hyperlink to reach.</descr> + </element> + <element name="TfpgHyperlink.TextColor"> + <short>Color of Text property.</short> + </element> + <element name="TfpgHyperlink.HotTrackFont"> + <short>This property is the type of font when mouse is over the hyperlink</short> + </element> + <element name="TfpgHyperlink.HotTrackColor"> + <short>Same as HotTrackFont but for TextColor property when the mouse is over the hyperlink.</short> + </element> + </module> + </package> +</fpdoc-descriptions> |