PovClipse editor hovers

The PovClipse editor uses text hovers to give you additional information. A hover is activated when the mouse pointer is held still on a word or annotation icon.

Hover types

Code folding hover

If a code is folded away, hovering on the '+' annotation symbol shows the folded code:

Declaration hover

If the mouse is held still over a declared name (either a #macro or a #declare name) the comment for that object is displayed (if there is one). This means the better you comment your code the more information can be displayed! Keep documenting as much as possible!

Hovering on a #macro name displays the macro interface followed by the macro documentation (if any):

Hovering on a #declare name displays the declaration documentation (if any) followed by the complete declaration code:

Both comment styles (/* ... */ and //) can be used, but not mixed:

/* First Line
   Second Line */
#macro myMacro(x, y) /* do something */ #end
// First Line
// Second Line
#macro myMacro(x, y) /* do something */ #end

Include hover

If the mouse is held still over an #include statement, information about the included file is shown:

  • The first line contains the complete file name and path
  • Than all macro names (if any) are shown in alphabetical order
  • Than all declared names (if any) are shown in alphabetical order

If the macro or declared name is introduced directly by the hovered file the name is printed in a strong color.
If the macro or declared name is introduced by a file being included by the hovered file it's marked using an asterisk and is printed in a lighter color.

Color hover

If the mouse is held still over an rgb[f|t|ft] statement (including the color value or vector), the color is shown:

Color_map hover

If the mouse is held still over an color_map statement (the keyword and everything between the opening '{' and closing '}' brace), the color map is shown:

Note: if the cursor is placed on a rgb[f|t|ft] color statement within the color_map, the color hover for that color is displayed.

Giving a hover window the focus

The image above shows the hover after giving it the focus by pressing 'F2'. This makes the hover window sticky and allows to scroll down and to select and copy text passages.


Hosted by SourceForge.net Logo