Skip to content

Commit

Permalink
Allow Dialog for classes as well, with restriction. (modelica#2618)
Browse files Browse the repository at this point in the history
* Allow Dialog for classes as well, with restriction.
Closes modelica#2617

With some cleanup of text.

Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
  • Loading branch information
HansOlsson and henrikt-ma committed Sep 24, 2020
1 parent e5350c9 commit b119f40
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion chapters/annotations.tex
Expand Up @@ -1144,7 +1144,7 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the
that shall be updated -- ideally without impacting users of the class.
If that is not possible the current class can have also have an obsolete-annotation.

A declaration may have the following annotations:
A component declaration may have the following annotation:
\begin{lstlisting}[language=modelica]
annotation(unassignedMessage = "message");
\end{lstlisting}
Expand Down Expand Up @@ -1173,6 +1173,7 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the
\end{lstlisting}
\end{example}

A component declaration or a short replaceable class definition may have the following annotation:
\begin{lstlisting}[language=modelica]
annotation(Dialog(enable = true, tab = "General",
group = "",
Expand All @@ -1181,6 +1182,8 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the
groupImage="modelica://MyPackage/Resources/Images/switch.png",
connectorSizing = false));
\end{lstlisting}
For a short replaceable class definition only the fields \lstinline!tab!, \lstinline!group!, \lstinline!enable! and
\lstinline!groupImage! are allowed.

The annotations \lstinline!tab! and \lstinline!group! define the placement of
the component or of variables in a dialog with optional tab and group
Expand Down

0 comments on commit b119f40

Please sign in to comment.