\hypertarget{classKeyInterface}{}\section{Key\+Interface Class Reference}
\label{classKeyInterface}\index{Key\+Interface@{Key\+Interface}}


Keyboard Event Interface.  




{\ttfamily \#include $<$Open\+Flipper/\+Base\+Plugin/\+Key\+Interface.\+hh$>$}

Inheritance diagram for Key\+Interface\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12.000000cm]{classKeyInterface}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classKeyInterface_a66e0b9cdc50addcbf20ac78b58e9bff7}{slot\+Key\+Event} (Q\+Key\+Event $\ast$\+\_\+event)
\begin{DoxyCompactList}\small\item\em Key Event from Main App. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classKeyInterface_afe64bc70902fb2c08169c16e6f825466}{register\+Key} (int \+\_\+key, Qt\+::\+Keyboard\+Modifiers \+\_\+modifiers, Q\+String \+\_\+description, bool \+\_\+multi\+Use=false)
\begin{DoxyCompactList}\small\item\em Register a key-\/combination for your plugin. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classKeyInterface_a94d9819293643c5abe9550f9dae8ba6a}{slot\+Key\+Release\+Event} (Q\+Key\+Event $\ast$\+\_\+event)
\begin{DoxyCompactList}\small\item\em Key Release Event from Main App. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classKeyInterface_a6530d2ecdfa3538a0efc350974c24d9d}\label{classKeyInterface_a6530d2ecdfa3538a0efc350974c24d9d}} 
virtual \hyperlink{classKeyInterface_a6530d2ecdfa3538a0efc350974c24d9d}{$\sim$\+Key\+Interface} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Keyboard Event Interface. 

\hyperlink{keyInterfacePage}{Detailed description} ~\newline
 Using this interface you can react on key events. 

Definition at line 59 of file Key\+Interface.\+hh.



\subsection{Member Function Documentation}
\mbox{\Hypertarget{classKeyInterface_afe64bc70902fb2c08169c16e6f825466}\label{classKeyInterface_afe64bc70902fb2c08169c16e6f825466}} 
\index{Key\+Interface@{Key\+Interface}!register\+Key@{register\+Key}}
\index{register\+Key@{register\+Key}!Key\+Interface@{Key\+Interface}}
\subsubsection{\texorpdfstring{register\+Key}{registerKey}}
{\footnotesize\ttfamily virtual void Key\+Interface\+::register\+Key (\begin{DoxyParamCaption}\item[{int}]{\+\_\+key,  }\item[{Qt\+::\+Keyboard\+Modifiers}]{\+\_\+modifiers,  }\item[{Q\+String}]{\+\_\+description,  }\item[{bool}]{\+\_\+multi\+Use = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [signal]}}



Register a key-\/combination for your plugin. 

To obtain key events from the viewer for a certain key-\/combination, you have to register that combination first


\begin{DoxyParams}{Parameters}
{\em \+\_\+key} & the key that should be registered \\
\hline
{\em \+\_\+modifiers} & the keyboard modifiers \\
\hline
{\em \+\_\+description} & a short description about the functionality (Will be used in the Options Widget) \\
\hline
{\em \+\_\+multi\+Use} & can the key additionally be registered by another plugin (You could make a key exclusive by this) \\
\hline
\end{DoxyParams}


Definition at line 71 of file Key\+Interface.\+hh.

\mbox{\Hypertarget{classKeyInterface_a66e0b9cdc50addcbf20ac78b58e9bff7}\label{classKeyInterface_a66e0b9cdc50addcbf20ac78b58e9bff7}} 
\index{Key\+Interface@{Key\+Interface}!slot\+Key\+Event@{slot\+Key\+Event}}
\index{slot\+Key\+Event@{slot\+Key\+Event}!Key\+Interface@{Key\+Interface}}
\subsubsection{\texorpdfstring{slot\+Key\+Event}{slotKeyEvent}}
{\footnotesize\ttfamily virtual void Key\+Interface\+::slot\+Key\+Event (\begin{DoxyParamCaption}\item[{Q\+Key\+Event $\ast$}]{\+\_\+event }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [slot]}}



Key Event from Main App. 

This slot is called if a key event occurred in the Viewer 
\begin{DoxyParams}{Parameters}
{\em \+\_\+event} & Key event \\
\hline
\end{DoxyParams}


Definition at line 80 of file Key\+Interface.\+hh.

\mbox{\Hypertarget{classKeyInterface_a94d9819293643c5abe9550f9dae8ba6a}\label{classKeyInterface_a94d9819293643c5abe9550f9dae8ba6a}} 
\index{Key\+Interface@{Key\+Interface}!slot\+Key\+Release\+Event@{slot\+Key\+Release\+Event}}
\index{slot\+Key\+Release\+Event@{slot\+Key\+Release\+Event}!Key\+Interface@{Key\+Interface}}
\subsubsection{\texorpdfstring{slot\+Key\+Release\+Event()}{slotKeyReleaseEvent()}}
{\footnotesize\ttfamily virtual void Key\+Interface\+::slot\+Key\+Release\+Event (\begin{DoxyParamCaption}\item[{Q\+Key\+Event $\ast$}]{\+\_\+event }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Key Release Event from Main App. 

This slot is called if a key release event occurred in the Viewer 
\begin{DoxyParams}{Parameters}
{\em \+\_\+event} & Key event \\
\hline
\end{DoxyParams}


Definition at line 87 of file Key\+Interface.\+hh.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
Open\+Flipper/\+Base\+Plugin/\hyperlink{KeyInterface_8hh}{Key\+Interface.\+hh}\end{DoxyCompactItemize}
