Copyright (c) Hyperion Entertainment and contributors.

Difference between revisions of "AmiDock and Dockies"

From AmigaOS Documentation Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
= Introduction =
 
= Introduction =
   
= What is AmiDock =
+
= What is Dock and Docky =
 
= What is Dock and Dockie =
 
   
 
== Dock ==
 
== Dock ==
A Dock is an area/a window (currently provided by the "AmiDock" commodity) where the user can put some icons and other stuff. Some may call it "Panels".
+
A Dock is an area/a window (currently provided by the "AmiDock" commodity) where the user can put some icons and other stuff. Some may call it "Panels". Docks can be used and as launcher panels, and as tray-bar docs, to have tray bar functionality, i.e. like:
  +
[[File:Tray_doc.jpg|center]]
  +
  +
And as anything else anyone can come up with: you can put everything inside of panels of any size, structure and design it as you wish.
   
== Dockie ==
+
== Docky ==
   
A Dockie cat be of 3 types:
+
In general, A Docky is what you place in the Dock. Dockies can be of 2 main types:
   
 
1. "Standalone Dockies": is a special type of program which is made to show an icon in a Dock, delivering some functionality to the user.
 
1. "Standalone Dockies": is a special type of program which is made to show an icon in a Dock, delivering some functionality to the user.
 
2. "Standard AppDockIcon Dockies" which is a modern incarnation of AppIcon of some kind.
 
2. "Standard AppDockIcon Dockies" which is a modern incarnation of AppIcon of some kind.
3. "Tray-bar AppDockIcon Dockies" which is special case of AppDockIcon Dockies, just done in mind to be in "tray".
 
   
 
To sum up in "standalone dockies" the docky itself is the application (the only reason of existence of the application is the docky) while for "AppDockIcon dockies" the docky is just a graphical representation of a bigger application (the docky is just here to add user friendliness or visual feedback of the surrounding application)
 
To sum up in "standalone dockies" the docky itself is the application (the only reason of existence of the application is the docky) while for "AppDockIcon dockies" the docky is just a graphical representation of a bigger application (the docky is just here to add user friendliness or visual feedback of the surrounding application)
   
= AmiDock's API =
+
= What is AmiDock =
   
  +
== Inbuild Dockies with AmigaOS4 ==
= Different types of Dockies =
 
== Standalone Dockies ==
 
   
== AppDockIcon Dockies ==
+
=== Access.docky ===
=== Standard AppDockIcon Dockies ===
 
=== Tray-bar AppDockIcon Dockies ===
 
   
  +
Single click with the left mouse button on this docky to open a list of screens and windows. Select a window and it will be activated and come to front (optionally). This docky especially is cool when using a hotkey - this way you can use the popup on EVERY screen. Just specify the hotkey like you do it with normal icons, too. Use the context menu to toggle to-front mode
- This part is under development, and even no standard is done. All of this subject to change and just a first attempts -
 
   
  +
=== Anim.docky ===
[[File:Tray_doc.jpg|center]]
 
   
  +
On a empty Anim.docky (no Animation assigned yet), drop a GIF-Animation (e.g. Boing#?.gif) on this dockie to change the current animation(in a selected dock) point with the mouse pointer over the docky and press the "+"/"-"-Keys to change animation speed. Use the context menu to specify a tool which shall be combined with this docky. You can also change the used animation here.
If you as developer want to make a tray-bar kind dockie, then you should follow some rules:
 
 
1. You always should provide a 24x24 icon (which can be as standard size of the tray-bar icons). You should do so to avoid auto-scaling of tray-kind doc and make it look as intended.
 
   
  +
=== Button.docky ===
2.
 
   
  +
On a empty Button.docky (no Picture assigned yet), drop a picture on this docky to change the current image. Use the context menu to specify a tool which shall be combined with this docky. You can also change the used picture here.
3.
 
   
  +
=== Clock.docky ===
= How to make a good Dockie =
 
   
  +
A analog clock in the dock. This docky changes automatically to a digital clock if you change to name or button style docks. Double click the docky or use the context menu to open the system time preferences.
= FAQ =
 
   
  +
=== Debugger.docky ===
= Final Words =
 
   
  +
This docky opens a window and shows debugging information for docky-programmers. Needed only for people developing third-party dockies. Single-click it to enable/disable debug mode. Debugger.docky saves its state in its preferences. Use the context menu to toggle between single-dock and global (all docks) debugging.
= Links =
 
   
  +
=== Lens.docky ===
1. Sys:Documentation/Commodities/AmiDock_Arexx.doc
 
   
  +
Double click this docky to switch between normal or maximized view
= Misc =
 
   
  +
Note: Normal and maximized view do have their own settings. Do that in a selected dock:
   
  +
point with the mouse pointer over the docky and press the key "x" - this will toggle between "cross-hair" mode and non-cross-hair mode.
  +
point with the mouse pointer over the docky and press the "+"/"-"-Keys to change the used magnification
  +
point with the mouse pointer over the docky and press the key "c" to enable coordinates
  +
point with the mouse pointer over the docky and press the key "v" to enable RGB values output (only available in a maximized lens!!)
  +
point with the mouse pointer over the docky and press the key "g" to enable/disable the grid.
   
  +
You can also use the context menu to change all the above described settings.
*******************************************
 
***** Welcome to AmiDock *****
 
***** for AmigaOS 4 *****
 
*******************************************
 
   
  +
=== Minimizer.docky ===
This Archive contains a beta version of AmiDock.
 
Please refer to the amidock_relnotes for more information
 
about the internal changes.
 
   
  +
As soon as this docky was added to a dock (to make the docky "invisible" use another category for placing the docky), the dock will shrink to the minimized state after some time. As soon as the pointer is placed over the drag-bar, it expands to normal size. You can change the delay time until this docky minimizes the dock using the contextual menu.
---
 
   
  +
=== Online.docky ===
The usage of AmiDock should be self-explanory.
 
Some important things:
 
   
  +
Allows you to go on- and offline with RoadShow. Not fully implemented yet!!!
- The "Dockies"-drawer should be located in "Sys:Tools/"
 
   
  +
=== Rainbow.docky ===
- If the Minimizeable-Checkbox is checked, you can minimize a dock
 
by double-clicking it's drag-bar.
 
   
  +
This docky shows a colorful rainbow with alpha channel (!) - but nothing more. Double click it to toggle between icon and image view. This dock needs screen depth >8Bit. AmiDock will deny it on screen depths below 8Bit.
- Bring to front/send to back can be done by double clicking on an
 
empty area in a dock (SHIFT together with a dobule click will send
 
it to back).
 
   
  +
=== Seperator.docky ===
- (in a selected dock) shift+click+hold on a icon and move around to
 
interactively change the icon-position
 
   
  +
This docky is nothing more than just a seperator line. It automatically adjusts itself to the size and orientation of a dock.
- to interactively delete a icon or a whole dock: click+hold the object,
 
press the Backspace or Delete key
 
   
  +
=== SubDocks.docky ===
   
  +
Use the shortcut Amiga+U to place it in the current dock or throw it in the dock which shall contain it...
Docky-Descriptions:
 
   
  +
- drag&drop a icon on it to configure its icon in AmiDock
  +
- if you delete the subdock, the docky will remove itself automatically
  +
- if you delete the docky, the docky will remove the subdock itself automatically
  +
- (in a selected dock) point with the mouse pointer over the docky and press the key "p" to toggle between popupmode (default, closes the dock after a object was clicked) or normal mode (doesn't close the dock)
  +
- Use the context menu to toggle the popup mode and ti change the icon.
   
  +
=== Test.docky ===
************* Access.docky ****************************************************
 
  +
The first docky ever written. Just a fun-docky. This docky "listens" to all possible events and shows this by flashing in some color when a action is detected. Move your mouse over the docky and click it. Drag&Drop several files on the docky and watch what happens. This dock needs screen depth >8Bit. AmiDock will deny it on screen depths below 8Bit.
   
  +
== AmiDock's hints ==
- Single click with the left mouse button on this docky to open a list of
 
screens and windows. Select a window and it will be activated and
 
come to front (optionally)
 
   
  +
- If the Minimizeable-Checkbox is checked, you can minimize a dock by double-clicking it's drag-bar.
- This docky especially is cool when using a hotkey - this way you can use
 
the popup on EVERY screen. Just specify the hotkey like you do it with
 
normal icons, too.
 
   
  +
- Bring to front/send to back can be done by double clicking on an empty area in a dock (SHIFT together with a dobule click will send it to back).
- Use the context menu to toggle to-front mode
 
   
  +
- in a selected dock: shift+click+hold on a icon and move around to interactively change the icon-position
************* Anim.docky ******************************************************
 
   
  +
- to interactively delete a icon or a whole dock: click+hold the object, press the Backspace or Delete key
- On a empty Anim.docky (no Animation assigned yet), drop a GIF-Animation
 
(e.g. Boing#?.gif) on this docky to change the current animation
 
   
- (in a selected dock) point with the mouse pointer over the docky
 
and press the "+"/"-"-Keys to change animation speed
 
   
  +
= AmiDock's API =
- Use the context menu to specify a tool which shall be combined with this
 
docky. You can also change the used animation here.
 
   
  +
= Different types of Dockies =
************* Button.docky ****************************************************
 
  +
== Standalone Dockies ==
   
  +
== AppDockIcon Dockies ==
- On a empty Button.docky (no Picture assigned yet), drop a picture
 
on this docky to change the current image
 
   
  +
= How to make a good Docky =
- Use the context menu to specify a tool which shall be combined with this
 
docky. You can also change the used picture here.
 
   
  +
= How to make a Docky for tray-bar kind Docks =
************* Clock.docky *****************************************************
 
   
  +
If you as developer want to make your dockies to work in tray-bar kind docks, you need to make a docky more flexible, and you should follow some rulz when you do it:
A analog clock in the dock. This docky changes automatically to a digital
 
  +
clock if you change to name or button style docks.
 
  +
1.
   
  +
2.
- Double click the docky or use the context menu to open the system time
 
preferences.
 
   
  +
3.
************* Debugger.docky **************************************************
 
   
This docky opens a window and shows debugging information for docky-
 
programmers. Needed only for people developing third-party dockies.
 
Single-click it to enable/disable debug mode. Debugger.docky saves its state
 
in its preferences.
 
Use the context menu to toggle between single-dock and global (all docks)
 
debugging.
 
   
  +
= FAQ =
************* Lens.docky ******************************************************
 
   
  +
= Final Words =
- Double click this docky to switch between normal or maximized view
 
Note: Normal and maximized view do have their own settings.
 
   
  +
= Links =
- (in a selected dock) point with the mouse pointer over the docky
 
and press the key "x" - this will toggle between "cross-hair" mode and
 
non-cross-hair mode
 
 
- (in a selected dock) point with the mouse pointer over the docky
 
and press the "+"/"-"-Keys to change the used magnifcation
 
 
- (in a selected dock) point with the mouse pointer over the docky
 
and press the key "c" to enable coordinates
 
 
- (in a selected dock) point with the mouse pointer over the docky
 
and press the key "v" to enable RGB values output
 
(only available in a maximized lens!!)
 
 
- (in a selected dock) point with the mouse pointer over the docky
 
and press the key "g" to enable/disable the grid
 
 
You can also use the context menu to change all the above described settings.
 
 
************* Minimizer.docky *************************************************
 
 
As soon as this docky was added to a dock (to make the docky "invisible"
 
use another category for placing the docky), the dock will shrink to the
 
minimized state after some time.
 
As soon as the pointer is placed over the drag-bar, it expands to normal size.
 
You can change the delay time until this docky minimizes the dock using the
 
contextual menu.
 
 
************* Online.docky ****************************************************
 
 
Allows you to go on- and offline with RoadShow. Not fully implemented yet!!!
 
 
************* Rainbow.docky ***************************************************
 
 
This docky shows a colorful rainbow with alpha channel (!) - but nothing more.
 
Double click it to toggle between icon and image view.
 
 
This dock needs screen depth >8Bit. AmiDock will deny it on screen depths
 
below 8Bit.
 
 
************* Seperator.docky *************************************************
 
 
This docky is nothing more than just a seperator line. It automatically
 
adjusts itself to the size and orientation of a dock.
 
 
************* SubDocks.docky **************************************************
 
 
- Use the shortcut Amiga+U to place it in the current dock or throw it in the
 
dock which shall contain it...
 
 
- drag&drop a icon on it to configure its icon in AmiDock
 
 
- if you delete the subdock, the docky will remove itself automatically
 
 
- if you delete the docky, the docky will remove the subdock itself
 
automatically
 
 
- (in a selected dock) point with the mouse pointer over the docky
 
and press the key "p" to toggle between popupmode (default, closes the dock
 
after a object was clicked) or normal mode (doesn't close the dock)
 
 
- Use the context menu to toggle the popup mode and ti change the icon.
 
 
************* Test.docky ******************************************************
 
 
The first docky ever written. Just a fun-docky.
 
This docky "listens" to all possible events and shows this by flashing in some
 
color when a action is detected.
 
 
- Move your mouse over the docky and click it...
 
 
- Drag&Drop several files on the docky and watch what happens...
 
   
  +
1. SDK:Documentation/AutoDocs/docky.doc
This dock needs screen depth >8Bit. AmiDock will deny it on screen depths
 
  +
2. Sys:Documentation/Commodities/AmiDock_Arexx.doc
below 8Bit.
 

Revision as of 16:42, 3 August 2013

Introduction

What is Dock and Docky

Dock

A Dock is an area/a window (currently provided by the "AmiDock" commodity) where the user can put some icons and other stuff. Some may call it "Panels". Docks can be used and as launcher panels, and as tray-bar docs, to have tray bar functionality, i.e. like:

Tray doc.jpg

And as anything else anyone can come up with: you can put everything inside of panels of any size, structure and design it as you wish.

Docky

In general, A Docky is what you place in the Dock. Dockies can be of 2 main types:

1. "Standalone Dockies": is a special type of program which is made to show an icon in a Dock, delivering some functionality to the user.
2. "Standard AppDockIcon Dockies" which is a modern incarnation of AppIcon of some kind.

To sum up in "standalone dockies" the docky itself is the application (the only reason of existence of the application is the docky) while for "AppDockIcon dockies" the docky is just a graphical representation of a bigger application (the docky is just here to add user friendliness or visual feedback of the surrounding application)

What is AmiDock

Inbuild Dockies with AmigaOS4

Access.docky

Single click with the left mouse button on this docky to open a list of screens and windows. Select a window and it will be activated and come to front (optionally). This docky especially is cool when using a hotkey - this way you can use the popup on EVERY screen. Just specify the hotkey like you do it with normal icons, too. Use the context menu to toggle to-front mode

Anim.docky

On a empty Anim.docky (no Animation assigned yet), drop a GIF-Animation (e.g. Boing#?.gif) on this dockie to change the current animation(in a selected dock) point with the mouse pointer over the docky and press the "+"/"-"-Keys to change animation speed. Use the context menu to specify a tool which shall be combined with this docky. You can also change the used animation here.

Button.docky

On a empty Button.docky (no Picture assigned yet), drop a picture on this docky to change the current image. Use the context menu to specify a tool which shall be combined with this docky. You can also change the used picture here.

Clock.docky

A analog clock in the dock. This docky changes automatically to a digital clock if you change to name or button style docks. Double click the docky or use the context menu to open the system time preferences.

Debugger.docky

This docky opens a window and shows debugging information for docky-programmers. Needed only for people developing third-party dockies. Single-click it to enable/disable debug mode. Debugger.docky saves its state in its preferences. Use the context menu to toggle between single-dock and global (all docks) debugging.

Lens.docky

Double click this docky to switch between normal or maximized view

Note: Normal and maximized view do have their own settings. Do that in a selected dock:

point with the mouse pointer over the docky and press the key "x" - this will toggle between "cross-hair" mode and non-cross-hair mode.
point with the mouse pointer over the docky and press the "+"/"-"-Keys to change the used magnification
point with the mouse pointer over the docky and press the key "c" to enable coordinates
point with the mouse pointer over the docky and press the key "v" to enable RGB values output (only available in a maximized lens!!)
point with the mouse pointer over the docky and press the key "g" to enable/disable the grid.

You can also use the context menu to change all the above described settings.

Minimizer.docky

As soon as this docky was added to a dock (to make the docky "invisible" use another category for placing the docky), the dock will shrink to the minimized state after some time. As soon as the pointer is placed over the drag-bar, it expands to normal size. You can change the delay time until this docky minimizes the dock using the contextual menu.

Online.docky

Allows you to go on- and offline with RoadShow. Not fully implemented yet!!!

Rainbow.docky

This docky shows a colorful rainbow with alpha channel (!) - but nothing more. Double click it to toggle between icon and image view. This dock needs screen depth >8Bit. AmiDock will deny it on screen depths below 8Bit.

Seperator.docky

This docky is nothing more than just a seperator line. It automatically adjusts itself to the size and orientation of a dock.

SubDocks.docky

Use the shortcut Amiga+U to place it in the current dock or throw it in the dock which shall contain it...

- drag&drop a icon on it to configure its icon in AmiDock - if you delete the subdock, the docky will remove itself automatically - if you delete the docky, the docky will remove the subdock itself automatically - (in a selected dock) point with the mouse pointer over the docky and press the key "p" to toggle between popupmode (default, closes the dock after a object was clicked) or normal mode (doesn't close the dock) - Use the context menu to toggle the popup mode and ti change the icon.

Test.docky

The first docky ever written. Just a fun-docky. This docky "listens" to all possible events and shows this by flashing in some color when a action is detected. Move your mouse over the docky and click it. Drag&Drop several files on the docky and watch what happens. This dock needs screen depth >8Bit. AmiDock will deny it on screen depths below 8Bit.

AmiDock's hints

- If the Minimizeable-Checkbox is checked, you can minimize a dock by double-clicking it's drag-bar.

- Bring to front/send to back can be done by double clicking on an empty area in a dock (SHIFT together with a dobule click will send it to back).

- in a selected dock: shift+click+hold on a icon and move around to interactively change the icon-position

- to interactively delete a icon or a whole dock: click+hold the object, press the Backspace or Delete key


AmiDock's API

Different types of Dockies

Standalone Dockies

AppDockIcon Dockies

How to make a good Docky

How to make a Docky for tray-bar kind Docks

If you as developer want to make your dockies to work in tray-bar kind docks, you need to make a docky more flexible, and you should follow some rulz when you do it:

1.

2.

3.


FAQ

Final Words

Links

1. SDK:Documentation/AutoDocs/docky.doc 2. Sys:Documentation/Commodities/AmiDock_Arexx.doc