Skip to content

Document Enable trait types #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwiggins merged 1 commit into from
Mar 15, 2021
Merged

Document Enable trait types #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/source/enable/traits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Enable Custom Traits
====================
Enable defines several `trait types <https://docs.enthought.com/traits>`_ which
Copy link
Copy Markdown
Contributor

@aaronayres35 aaronayres35 Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe link to the custom traits section of the traits docs?
https://docs.enthought.com/traits/traits_user_manual/custom.html

I actually am unsure which would make more sense, so feel free to leave if you prefer the home page

Copy link
Copy Markdown
Member Author

@jwiggins jwiggins Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll leave it like this

can be used to simplify the generation of values to pass to various APIs
throughout Enable (and Kiva).


bounds_trait
------------
:class:`~.bounds_trait` represents the bounds of an object. It is a list of two
values: width and height.

ColorTrait
----------
:class:`ColorTrait` represents an RGBA color. One can assign either tuples
containing RGBA colors (each component in the range [0, 1]) or a string in
the form of an HTML color name ("blue" or "#0000FF").

font_trait
----------
:class:`~.font_trait` is a synonym for :class:`kiva.trait_defs.api.KivaFont`.
The trait maps a font-description string to a valid :class:`kiva.fonttools.Font`
instance which can be passed to :py:meth:`AbstractGraphicsContext.set_font`

LineStyle
---------
:class:`~.LineStyle` represents the dash style of a line drawn with Kiva.
Allowed values are "solid", "dot dash", "dash", "dot", or "long dash".

MarkerTrait
-----------
:class:`~.MarkerTrait` represents a marker which can be drawn by Kiva. Allowed
values are "square", "circle", "triangle", "inverted_triangle", "left_triangle",
"right_triangle", "pentagon", "hexagon", "hexagon2", "plus", "cross", "star",
"cross_plus", "diamond", "dot", or "pixel".

Pointer
-------
:class:`~.Pointer` represents the style of a mouse pointer on screen. Allowed
values are "arrow", "right arrow", "blank", "bullseye", "char", "cross", "hand",
"ibeam", "left button", "magnifier", "middle button", "no entry", "paint brush",
"pencil", "point left", "point right", "question arrow", "right button",
"size top", "size bottom", "size left", "size right", "size top right",
"size bottom left", "size top left", "size bottom right", "sizing", "spray can",
"wait", "watch", or "arrow wait".
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Enable Documentation
enable/mouse_events
enable/basic_tools
enable/drag_and_drop
enable/traits
enable/undo_redo
enable/toolkit_selection

Expand Down