Skip to content

Commit

Permalink
Merge b74ed52 into be0ec67
Browse files Browse the repository at this point in the history
  • Loading branch information
Flo-Mueller committed Aug 2, 2021
2 parents be0ec67 + b74ed52 commit f0fef6b
Show file tree
Hide file tree
Showing 20 changed files with 112 additions and 10 deletions.
3 changes: 3 additions & 0 deletions packages/IconAPI-Core.package/HTTPIconFetcher.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
A HTTPIconFetcher is an abstract class which implements the interface of all fetchers that require http protocols to fetch icons from the web.

Instance Variables
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:18",
"instvars" : [
],
"name" : "HTTPIconFetcher",
Expand Down
7 changes: 7 additions & 0 deletions packages/IconAPI-Core.package/IconButton.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
An IconButton is a SimpleButtonMorph with almost the same functionality as specified in the ToolBuilder. Different to the SimpleButtonMorph it has an IconMorph instead of a TextLabel as a submorph.

Instance Variables
iconMorph: <IconMorph>

iconMorph
- the IconMorph displayed within the IconButton
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 17:39",
"instvars" : [
"iconMorph" ],
"name" : "IconButton",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
An IconFetchStrategy is the Strategy interface for every implemented fetcher. It is an abstract class which distributes the handling of fetcher functionality to the different specific fetchers.

Instance Variables
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 17:41",
"instvars" : [
],
"name" : "IconFetchStrategy",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
An IconIconsFetcher is the concrete fetcher for the Icon-Icons library.

Instance Variables
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:19",
"instvars" : [
],
"name" : "IconIconsFetcher",
Expand Down
27 changes: 27 additions & 0 deletions packages/IconAPI-Core.package/IconMorph.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
An IconMorph is the main morph of iconAPI.

Instance Variables
aspectRatio: <Point>
fetcher: <IconFetchStrategy>
iconColor: <Color>
isIconColorSet: <Boolean>
originalForm: <Form>
scaledForm: <Form>

aspectRatio
- determines the width to height ratio of the icon

fetcher
- is the specific fetcher used to fetch the IconMorph, default is MaterialIcons

iconColor
- determines the color of the icon

isIconColorSet
- boolean which is false, when the original icon color was used and true when it got changed manually

originalForm
- is the icon form we get when fetching the icon (the 'reference icon')

scaledForm
- is the icon form we get after scaling (the icon as it is displayed)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:26",
"instvars" : [
"originalForm",
"scaledForm",
Expand Down
15 changes: 15 additions & 0 deletions packages/IconAPI-Core.package/IconPreviewList.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
An IconPreviewList shows a list of all id's of fetchable Icons for a certain fetcher.

Instance Variables
iconFetcher: <IconFetchStrategy>
iconIndex: <Integer>
iconList: <Collection>

iconFetcher
- the icon fetcher we want to show the list of id's for

iconIndex
- the index of the specific icon id

iconList
- list of all the available ids
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:30",
"instvars" : [
"iconList",
"iconIndex",
Expand Down
7 changes: 7 additions & 0 deletions packages/IconAPI-Core.package/LocalFetcher.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
A LocalFetcher is enabling to fetch icons which are stored locally.

Instance Variables
directory: <FileDirectory>

directory
- is the specific directory from which you want to fetch the icons from.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:19",
"instvars" : [
"directory" ],
"name" : "LocalFetcher",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
A MaterialIconsFetcher is the concrete fetcher for the MaterialIcons library.

Instance Variables
useOutlined: <Object>

useOutlined
- is defining whether the fetched icon should have an outline or not
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:20",
"instvars" : [
"useOutlined" ],
"name" : "MaterialIconsFetcher",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
A PluggableIconButtonSpec defines the spec of an IconButton to create a IconButton by a spec.

Instance Variables
action: <Object>
target: <Object>

action
- the specific action the button is supposed to do at click

target
- the target of the IconButtonSpec
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:37",
"instvars" : [
"action",
"target" ],
Expand Down
19 changes: 19 additions & 0 deletions packages/IconAPI-Core.package/PluggableIconSpec.class/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
A PluggableIconSpec is using the pluggableWidgetSpec functionality of the toolBuilder to create an icon by defining its specs.

Instance Variables
aspectRatio: <Object>
iconColor: <Object>
id: <Object>
inverted: <Object>

aspectRatio
- is the width to height ratio of the icon

iconColor
- sets the icon color of the icon

id
- sets the id of the icon

inverted
- determines whether the icon color is inverted or not
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "FM 7/31/2021 21:34",
"instvars" : [
"id",
"iconColor",
Expand Down

0 comments on commit f0fef6b

Please sign in to comment.