Skip to content

Commit

Permalink
New build with updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gary Criblez committed Jun 26, 2020
1 parent a74473e commit 514b56c
Show file tree
Hide file tree
Showing 22 changed files with 340 additions and 209 deletions.
Binary file modified AJUI_Tip.4dbase/AJUI_Tip.4DZ
Binary file not shown.
41 changes: 29 additions & 12 deletions AJUI_Tip.4dbase/Documentation/Methods/AJUI_Tip.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,40 @@
<!-- AJUI_Tip ( ) -> Tip class -->
<!-- AJUI_Tip.new ( {template} ) -> instance of Tip class -->

# AJUI_Tip

## Parameters

* none
## Description

## Return value
Exposes the Tip class at the host base. Replace New AJUI_tip since V18R3.It is possible to pass an object as a parameter to it in order to import an AJUI_Tip template

(object) Tip class
```4d
AJUI_Tip.new ( {template} ) -> instance
```

## Description
| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| template | object | in | Properties :<br> - (text) templateName : Name of the folder containing the JSON file to import (template). If the file is not found, the method will return a new instance of AJUI BreadCrumb.<br> - (text) (optional) templatePath : You can specify a path to retrieve the file otherwise, the component will search in the default folder located in the resources (.../Resources/AJUI_Tip_Templates/). |
| instance | object | out | instance of AJUI_Tip with all the member functions |

Exposes the Tip class at the host base.

## Example

```
C_Object ($tipClass)
```4d
C_Object($myTip;$template_obj)
//load a template and set the tip with a blink animation
$template_obj:=New object("templateName";$yourTemplateName;"templatePath";$yourPath)
Form.tip:=AJUI_Tip.new ($template_obj)
Form.tip.TargetName("info")
Form.tip.TipName("tipInfo")
Form.tip.TipPosition("top")
Form.tip.BackgroundColor("yellow")
Form.tip.TipboxMaxWidth(150)
Form.tip.TextLabel("Blink on set to 50%")
Form.tip.BlinkNumber(3)
Form.tip.BlinkDuration(1000)
Form.tip.BlinkOn(50)
Form.tip.Show()
$tipClass:=AJUI_Tip
```
15 changes: 5 additions & 10 deletions AJUI_Tip.4dbase/Documentation/Methods/AJUI_Tip_clearCache.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
<!-- AJUI_Tip_clearCache ( ) -->

# AJUI_Tip_clearCache

## Parameters

* none

## Return value

none

## Description

This method allows you to clean up instances stored internally in an interprocess variable. **This is important** in order to free up memory. We recommend that you use this method when you close the process that contains the form(s) that display tooltips. This method cleans only the instances of the current process.

```4d
AJUI_Tip_clearCache ( )
```

## Example

```
```4d
$evt:=Form event code
Case of
Expand Down
21 changes: 10 additions & 11 deletions AJUI_Tip.4dbase/Documentation/Methods/AJUI_Tip_info.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<!-- AJUI_Tip_info ( ) -> version -->

# AJUI_Tip_info

## Parameters

* none

## Return value

(text) version

## Description

Show the version info of the component.

```4d
AJUI_Tip_info ( ) -> version
```

| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| version | text | out | version info of the component |

## Example

```
```4d
C_String($version)
$version:= AJUI_Tip_info ()
$version:= AJUI_Tip_info () //AJUI Tip (v18) : 1.6.1-Build42
```
22 changes: 11 additions & 11 deletions AJUI_Tip.4dbase/Documentation/Methods/AJUI_Tip_loadTemplates.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<!-- AJUI_Tip_loadTemplates ( ) -> templates -->
<!-- JUI_Tip_loadTemplates ( {folderPath} ) -> templates -->

# AJUI_Tip_loadTemplates

## Parameters

* (text) (optional) folderPath

## Return value

(collection) content of the template files

## Description

This method allows you to load all the templates files contained in a directory. It returns all the content of the files as a collection of Tip objects. It is possible to define a target folder path as a parameter, if not, the method will use the default path : resources/AJUI_Tip_Templates/ .

```4d
AJUI_Tip_loadTemplates ( {folderPath} ) -> templates
```

| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| folderPath | text | in | where to find the template json files |
| templates | collection | out | content of the template files  |

## Example

```
```4d
$folder:=Folder($path;fk platform path)
If ($folder.exists)
Expand Down
41 changes: 27 additions & 14 deletions AJUI_Tip.4dbase/Documentation/Methods/New AJUI_Tip.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,40 @@
<!--New AJUI_Tip ( {template_obj} ) -> AJUI Tip instance -->

# New AJUI_Tip

## Parameters
## Description

* (object) (optional) template :
* (text) templateName : Corresponds to the name of the JSON file to import (template). If the file is not found, the method will return a new instance of AJUI Tip.
* (text) (optional) templatePath : You can specify a path to retrieve the file otherwise, the component will search in the default folder located in the resources
This method returns an object variable that represents an instance of AJUI Tip. It contains all the properties and their default values as well as the formulas (member functions) to manipulate them. It is possible to pass an object as a parameter to it in order to import an AJUI_Tip template

## Return value
```4d
New AJUI_Tip ( {template} ) -> instance
```

(object) instance of an AJUI Tip
| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| template | object | in | Properties :<br> - (text) templateName : Name of the folder containing the JSON file to import (template). If the file is not found, the method will return a new instance of AJUI BreadCrumb.<br> - (text) (optional) templatePath : You can specify a path to retrieve the file otherwise, the component will search in the default folder located in the resources (.../Resources/AJUI_Tip_Templates/). |
| instance | object | out | instance of AJUI_Tip with all the member functions |

## Description

This method returns an object variable that represents an instance of AJUI Tip. It contains all the properties and their default values as well as the formulas (member functions) to manipulate them. It is possible to pass an object as a parameter to it in order to import an AJUI

## Example

```
```4d
C_Object($myTip;$template_obj)
C_String($path;$templateName)
$template_obj:=New object("templateName";$templateName;"templatePath";$path)
$myTip:=New AJUI_Tip ($template_obj)
//load a template and set the tip with a blink animation
$template_obj:=New object("templateName";$yourTemplateName;"templatePath";$yourPath)
Form.tip:=New AJUI_Tip ($template_obj)
Form.tip.TargetName("info")
Form.tip.TipName("tipInfo")
Form.tip.TipPosition("top")
Form.tip.BackgroundColor("yellow")
Form.tip.TipboxMaxWidth(150)
Form.tip.TextLabel("Blink on set to 50%")
Form.tip.BlinkNumber(3)
Form.tip.BlinkDuration(1000)
Form.tip.BlinkOn(50)
Form.tip.Show()
```
Binary file modified AJUI_Tip_Lab.4dbase/Components/AJUI_Banner.4dbase/AJUI_Banner.4DZ
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
<!-- AJUIB_Info ( ) -> version -->

# AJUIB_Info

## Parameters

* none
## Description

## Return value
Show the version info of the component.

(text) version
```4d
AJUIB_Info ( ) -> version
```

## Description
| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| version | text | out | version info of the component |

Show the version info of the component.

## Example

```
```4d
C_String($version)
$version:= AJUIB_Info ()
$version:= AJUIB_Info () //AJUI Banner (v18) : 1.7.2-Build21
```
Original file line number Diff line number Diff line change
@@ -1,23 +1,42 @@
<!-- AJUI_Banner ( ) -> Banner class -->

# AJUI_Banner

## Parameters

* none

## Return value

(object) Banner class

## Description

Exposes the Banner class at the host base.

```4d
AJUI_Banner ( ) -> banner
```

| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| banner | object | out | instance of the Banner class |

## Example

```
C_Object ($bannerClass)
```4d
C_Object ($banner)
//window banner with text
$banner:=AJUI_Banner.new ()
$banner("window")
$banner.isPicture(False)
$banner.Message("You're welcome")
$banner.DrawBanner()
//window banner with picture
$banner:=AJUI_Banner.new ()
$banner.Banner("window")
$banner.isPicture(True)
$banner.PicturePath("Images"+Folder separator+"yourPicture.png")
$banner.DrawBanner()
//corner ribbon
$banner:=AJUI_Banner.new ()
$banner.Banner("cornerRibbon")
$banner.Message("Corner Ribbon")
$banner.BannerPosition("bottom-right")
$banner.DrawBanner()
$bannerClass:=AJUI_Banner
```
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
<!-- Launch_HDI_AJUI_Banner ( ) -->

# Launch_HDI_AJUI_Banner

## Parameters

* none

## Return value

none

## Description

Launch HDI (How do I) example.

## Example
```4d
Launch_HDI_AJUI_Banner ( )
```
Launch_HDI_AJUI_Banner ( )

## Example

```4d
$evt:=Form event code
Case of
: ($evt=On Clicked)
Launch_HDI_AJUI_Banner ( )
End Case
```

Original file line number Diff line number Diff line change
@@ -1,23 +1,42 @@
<!-- New AJUI_Banner ( ) -> AJUI Banner instance -->

# New AJUI_Banner

## Parameters

* none

## Return value

(object) banner object

## Description

This method creates an instance of the banner object with his default properties values and formulas.

## Example

```4d
New AJUI_Banner ( ) -> banner
```
C_Object ($myBanner)

$myBanner:= New AJUI_Banner ()
| Parameter | Type | In/Out | Description |
| --------- | ---- | ------ | ----------- |
| banner | object | out | instance of AJUI_Banner with all the member function |

## Example

```4d
C_Object ($banner)
//window banner with text
$banner:=New AJUI_Banner
$banner("window")
$banner.isPicture(False)
$banner.Message("You're welcome")
$banner.DrawBanner()
//window banner with picture
$banner:=New AJUI_Banner
$banner.Banner("window")
$banner.isPicture(True)
$banner.PicturePath("Images"+Folder separator+"yourPicture.png")
$banner.DrawBanner()
//corner ribbon
$banner:=New AJUI_Banner
$banner.Banner("cornerRibbon")
$banner.Message("Corner Ribbon")
$banner.BannerPosition("bottom-right")
$banner.DrawBanner()
```
Binary file modified AJUI_Tip_Lab.4dbase/Components/AJUI_Button.4dbase/AJUI_Button.4DZ
Binary file not shown.
Loading

0 comments on commit 514b56c

Please sign in to comment.