\hypertarget{class_ogre_bites_1_1_progress_bar}{}\section{Ogre\+Bites\+:\+:Progress\+Bar Class Reference}
\label{class_ogre_bites_1_1_progress_bar}\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}


Basic progress bar widget.  




{\ttfamily \#include $<$Ogre\+Trays.\+h$>$}



Inheritance diagram for Ogre\+Bites\+:\+:Progress\+Bar\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=209pt]{class_ogre_bites_1_1_progress_bar__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_bites_1_1_progress_bar_aaab3677e3e545e5167e6e71d3cc3011c}{Progress\+Bar} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{Ogre\+::\+String} \&name, const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&caption, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} comment\+Box\+Width)
\begin{DoxyCompactList}\small\item\em Do not instantiate any widgets directly. Use \hyperlink{class_ogre_bites_1_1_tray_manager}{Tray\+Manager}. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_bites_1_1_widget_a5495adaa134dc0f623a59edc47785d6b}{\+\_\+assign\+Listener} (\hyperlink{class_ogre_bites_1_1_tray_listener}{Tray\+Listener} $\ast$listener)
\item 
void \hyperlink{class_ogre_bites_1_1_widget_aa677ba5b52e973a39226b2e8274bba02}{\+\_\+assign\+To\+Tray} (\hyperlink{namespace_ogre_bites_a637c114a713225e37b0f0316f5da3530}{Tray\+Location} tray\+Loc)
\item 
virtual void \hyperlink{class_ogre_bites_1_1_widget_adfad9ac1f94d8c66a7af4dc097190f56}{\+\_\+cursor\+Moved} (const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&cursor\+Pos, float wheel\+Delta)
\item 
virtual void \hyperlink{class_ogre_bites_1_1_widget_a7f9eb0d7f7ef38179c7fb020d7895801}{\+\_\+cursor\+Pressed} (const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&cursor\+Pos)
\item 
virtual void \hyperlink{class_ogre_bites_1_1_widget_abd837ccab4c71eaaec3e116495e4e1ad}{\+\_\+cursor\+Released} (const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&cursor\+Pos)
\item 
virtual void \hyperlink{class_ogre_bites_1_1_widget_ae6ebe2e4ee545dd73508a582014b6529}{\+\_\+focus\+Lost} ()
\item 
void \hyperlink{class_ogre_bites_1_1_widget_a208e40264309e5a6d935c0427bafe329}{cleanup} ()
\item 
const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \& \hyperlink{class_ogre_bites_1_1_progress_bar_a4d984b0aa89b8711df8175d394db20c4}{get\+Caption} ()
\item 
const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \& \hyperlink{class_ogre_bites_1_1_progress_bar_ac430b3a95d4aaa81d9779e2f16e8a64c}{get\+Comment} ()
\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{Ogre\+::\+String} \& \hyperlink{class_ogre_bites_1_1_widget_a900177f635300dcdd31d138aac82b11f}{get\+Name} ()
\item 
\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$ \hyperlink{class_ogre_bites_1_1_widget_a379d3f1a2ca6eaf13fc5c52afaafd0d2}{get\+Overlay\+Element} ()
\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} \hyperlink{class_ogre_bites_1_1_progress_bar_ae4dcbc20fccfd6bedc0bbd31d9215f67}{get\+Progress} ()
\begin{DoxyCompactList}\small\item\em Gets the progress as a percentage. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_bites_a637c114a713225e37b0f0316f5da3530}{Tray\+Location} \hyperlink{class_ogre_bites_1_1_widget_a9df190dff5bcdc89fdeb24ae042e678b}{get\+Tray\+Location} ()
\item 
void \hyperlink{class_ogre_bites_1_1_widget_abf26dfc708c02ef494a53ca2cd1450c9}{hide} ()
\item 
bool \hyperlink{class_ogre_bites_1_1_widget_ab7e933da19d76d8c9204f92e0d6d9f1a}{is\+Visible} ()
\item 
void \hyperlink{class_ogre_bites_1_1_progress_bar_a6539fe13ff9d7319bb9fe945ffe1bbba}{set\+Caption} (const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&caption)
\item 
void \hyperlink{class_ogre_bites_1_1_progress_bar_a04bf50f3b2fdd091a57b5d60fa9ac56c}{set\+Comment} (const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&comment)
\item 
void \hyperlink{class_ogre_bites_1_1_progress_bar_a472e3f1c2cc5c49011faa6d19e61cea7}{set\+Progress} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} progress)
\begin{DoxyCompactList}\small\item\em Sets the progress as a percentage. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_bites_1_1_widget_aa90966b039159924d827c75b0f80dace}{show} ()
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \hyperlink{class_ogre_bites_1_1_widget_a2b09ddb115c2690a67f60e8f9ded516a}{cursor\+Offset} (\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$element, const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&cursor\+Pos)
\begin{DoxyCompactList}\small\item\em Static utility method used to get the cursor\textquotesingle{}s offset from the center of an overlay element in pixels. \end{DoxyCompactList}\item 
static void \hyperlink{class_ogre_bites_1_1_widget_ad255db14bc50d8292c7ffc7e7fdd2ad3}{fit\+Caption\+To\+Area} (const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&caption, \hyperlink{class_ogre_1_1_text_area_overlay_element}{Ogre\+::\+Text\+Area\+Overlay\+Element} $\ast$area, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} max\+Width)
\begin{DoxyCompactList}\small\item\em Static utility method to cut off a string to fit in a text area. \end{DoxyCompactList}\item 
static \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} \hyperlink{class_ogre_bites_1_1_widget_a307d2eb4e22b56109d16e3f75e5d2d79}{get\+Caption\+Width} (const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&caption, \hyperlink{class_ogre_1_1_text_area_overlay_element}{Ogre\+::\+Text\+Area\+Overlay\+Element} $\ast$area)
\begin{DoxyCompactList}\small\item\em Static utility method used to get the width of a caption in a text area. \end{DoxyCompactList}\item 
static bool \hyperlink{class_ogre_bites_1_1_widget_ad378831e42aa491ee31276a8e8ea0c77}{is\+Cursor\+Over} (\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$element, const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&cursor\+Pos, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} void\+Border=0)
\begin{DoxyCompactList}\small\item\em Static utility method to check if the cursor is over an overlay element. \end{DoxyCompactList}\item 
static void \hyperlink{class_ogre_bites_1_1_widget_a9219934ddc23fc2456c365a65e06c928}{nuke\+Overlay\+Element} (\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$element)
\begin{DoxyCompactList}\small\item\em Static utility method to recursively delete an overlay element plus all of its children from the system. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Basic progress bar widget. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_aaab3677e3e545e5167e6e71d3cc3011c}\label{class_ogre_bites_1_1_progress_bar_aaab3677e3e545e5167e6e71d3cc3011c}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!Progress\+Bar@{Progress\+Bar}}
\index{Progress\+Bar@{Progress\+Bar}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{Progress\+Bar()}{ProgressBar()}}
{\footnotesize\ttfamily Ogre\+Bites\+::\+Progress\+Bar\+::\+Progress\+Bar (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{Ogre\+::\+String} \&}]{name,  }\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&}]{caption,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real}}]{comment\+Box\+Width }\end{DoxyParamCaption})}



Do not instantiate any widgets directly. Use \hyperlink{class_ogre_bites_1_1_tray_manager}{Tray\+Manager}. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_a472e3f1c2cc5c49011faa6d19e61cea7}\label{class_ogre_bites_1_1_progress_bar_a472e3f1c2cc5c49011faa6d19e61cea7}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!set\+Progress@{set\+Progress}}
\index{set\+Progress@{set\+Progress}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{set\+Progress()}{setProgress()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Progress\+Bar\+::set\+Progress (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real}}]{progress }\end{DoxyParamCaption})}



Sets the progress as a percentage. 

\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_ae4dcbc20fccfd6bedc0bbd31d9215f67}\label{class_ogre_bites_1_1_progress_bar_ae4dcbc20fccfd6bedc0bbd31d9215f67}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Progress@{get\+Progress}}
\index{get\+Progress@{get\+Progress}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Progress()}{getProgress()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} Ogre\+Bites\+::\+Progress\+Bar\+::get\+Progress (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the progress as a percentage. 

\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_a4d984b0aa89b8711df8175d394db20c4}\label{class_ogre_bites_1_1_progress_bar_a4d984b0aa89b8711df8175d394db20c4}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Caption@{get\+Caption}}
\index{get\+Caption@{get\+Caption}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Caption()}{getCaption()}}
{\footnotesize\ttfamily const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String}\& Ogre\+Bites\+::\+Progress\+Bar\+::get\+Caption (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_a6539fe13ff9d7319bb9fe945ffe1bbba}\label{class_ogre_bites_1_1_progress_bar_a6539fe13ff9d7319bb9fe945ffe1bbba}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!set\+Caption@{set\+Caption}}
\index{set\+Caption@{set\+Caption}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{set\+Caption()}{setCaption()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Progress\+Bar\+::set\+Caption (\begin{DoxyParamCaption}\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&}]{caption }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_ac430b3a95d4aaa81d9779e2f16e8a64c}\label{class_ogre_bites_1_1_progress_bar_ac430b3a95d4aaa81d9779e2f16e8a64c}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Comment@{get\+Comment}}
\index{get\+Comment@{get\+Comment}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Comment()}{getComment()}}
{\footnotesize\ttfamily const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String}\& Ogre\+Bites\+::\+Progress\+Bar\+::get\+Comment (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_progress_bar_a04bf50f3b2fdd091a57b5d60fa9ac56c}\label{class_ogre_bites_1_1_progress_bar_a04bf50f3b2fdd091a57b5d60fa9ac56c}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!set\+Comment@{set\+Comment}}
\index{set\+Comment@{set\+Comment}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{set\+Comment()}{setComment()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Progress\+Bar\+::set\+Comment (\begin{DoxyParamCaption}\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&}]{comment }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a208e40264309e5a6d935c0427bafe329}\label{class_ogre_bites_1_1_widget_a208e40264309e5a6d935c0427bafe329}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!cleanup@{cleanup}}
\index{cleanup@{cleanup}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{cleanup()}{cleanup()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Widget\+::cleanup (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a9219934ddc23fc2456c365a65e06c928}\label{class_ogre_bites_1_1_widget_a9219934ddc23fc2456c365a65e06c928}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!nuke\+Overlay\+Element@{nuke\+Overlay\+Element}}
\index{nuke\+Overlay\+Element@{nuke\+Overlay\+Element}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{nuke\+Overlay\+Element()}{nukeOverlayElement()}}
{\footnotesize\ttfamily static void Ogre\+Bites\+::\+Widget\+::nuke\+Overlay\+Element (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$}]{element }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Static utility method to recursively delete an overlay element plus all of its children from the system. 

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_ad378831e42aa491ee31276a8e8ea0c77}\label{class_ogre_bites_1_1_widget_ad378831e42aa491ee31276a8e8ea0c77}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!is\+Cursor\+Over@{is\+Cursor\+Over}}
\index{is\+Cursor\+Over@{is\+Cursor\+Over}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{is\+Cursor\+Over()}{isCursorOver()}}
{\footnotesize\ttfamily static bool Ogre\+Bites\+::\+Widget\+::is\+Cursor\+Over (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$}]{element,  }\item[{const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&}]{cursor\+Pos,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real}}]{void\+Border = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Static utility method to check if the cursor is over an overlay element. 

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a2b09ddb115c2690a67f60e8f9ded516a}\label{class_ogre_bites_1_1_widget_a2b09ddb115c2690a67f60e8f9ded516a}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!cursor\+Offset@{cursor\+Offset}}
\index{cursor\+Offset@{cursor\+Offset}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{cursor\+Offset()}{cursorOffset()}}
{\footnotesize\ttfamily static \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} Ogre\+Bites\+::\+Widget\+::cursor\+Offset (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element} $\ast$}]{element,  }\item[{const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&}]{cursor\+Pos }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Static utility method used to get the cursor\textquotesingle{}s offset from the center of an overlay element in pixels. 

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a307d2eb4e22b56109d16e3f75e5d2d79}\label{class_ogre_bites_1_1_widget_a307d2eb4e22b56109d16e3f75e5d2d79}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Caption\+Width@{get\+Caption\+Width}}
\index{get\+Caption\+Width@{get\+Caption\+Width}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Caption\+Width()}{getCaptionWidth()}}
{\footnotesize\ttfamily static \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real} Ogre\+Bites\+::\+Widget\+::get\+Caption\+Width (\begin{DoxyParamCaption}\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&}]{caption,  }\item[{\hyperlink{class_ogre_1_1_text_area_overlay_element}{Ogre\+::\+Text\+Area\+Overlay\+Element} $\ast$}]{area }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Static utility method used to get the width of a caption in a text area. 

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_ad255db14bc50d8292c7ffc7e7fdd2ad3}\label{class_ogre_bites_1_1_widget_ad255db14bc50d8292c7ffc7e7fdd2ad3}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!fit\+Caption\+To\+Area@{fit\+Caption\+To\+Area}}
\index{fit\+Caption\+To\+Area@{fit\+Caption\+To\+Area}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{fit\+Caption\+To\+Area()}{fitCaptionToArea()}}
{\footnotesize\ttfamily static void Ogre\+Bites\+::\+Widget\+::fit\+Caption\+To\+Area (\begin{DoxyParamCaption}\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Ogre\+::\+Display\+String} \&}]{caption,  }\item[{\hyperlink{class_ogre_1_1_text_area_overlay_element}{Ogre\+::\+Text\+Area\+Overlay\+Element} $\ast$}]{area,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Ogre\+::\+Real}}]{max\+Width }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Static utility method to cut off a string to fit in a text area. 

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a379d3f1a2ca6eaf13fc5c52afaafd0d2}\label{class_ogre_bites_1_1_widget_a379d3f1a2ca6eaf13fc5c52afaafd0d2}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Overlay\+Element@{get\+Overlay\+Element}}
\index{get\+Overlay\+Element@{get\+Overlay\+Element}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Overlay\+Element()}{getOverlayElement()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_overlay_element}{Ogre\+::\+Overlay\+Element}$\ast$ Ogre\+Bites\+::\+Widget\+::get\+Overlay\+Element (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a900177f635300dcdd31d138aac82b11f}\label{class_ogre_bites_1_1_widget_a900177f635300dcdd31d138aac82b11f}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Name@{get\+Name}}
\index{get\+Name@{get\+Name}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Name()}{getName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{Ogre\+::\+String}\& Ogre\+Bites\+::\+Widget\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a9df190dff5bcdc89fdeb24ae042e678b}\label{class_ogre_bites_1_1_widget_a9df190dff5bcdc89fdeb24ae042e678b}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!get\+Tray\+Location@{get\+Tray\+Location}}
\index{get\+Tray\+Location@{get\+Tray\+Location}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{get\+Tray\+Location()}{getTrayLocation()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_bites_a637c114a713225e37b0f0316f5da3530}{Tray\+Location} Ogre\+Bites\+::\+Widget\+::get\+Tray\+Location (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_abf26dfc708c02ef494a53ca2cd1450c9}\label{class_ogre_bites_1_1_widget_abf26dfc708c02ef494a53ca2cd1450c9}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!hide@{hide}}
\index{hide@{hide}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{hide()}{hide()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Widget\+::hide (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_aa90966b039159924d827c75b0f80dace}\label{class_ogre_bites_1_1_widget_aa90966b039159924d827c75b0f80dace}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!show@{show}}
\index{show@{show}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{show()}{show()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Widget\+::show (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_ab7e933da19d76d8c9204f92e0d6d9f1a}\label{class_ogre_bites_1_1_widget_ab7e933da19d76d8c9204f92e0d6d9f1a}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!is\+Visible@{is\+Visible}}
\index{is\+Visible@{is\+Visible}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{is\+Visible()}{isVisible()}}
{\footnotesize\ttfamily bool Ogre\+Bites\+::\+Widget\+::is\+Visible (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a7f9eb0d7f7ef38179c7fb020d7895801}\label{class_ogre_bites_1_1_widget_a7f9eb0d7f7ef38179c7fb020d7895801}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+cursor\+Pressed@{\+\_\+cursor\+Pressed}}
\index{\+\_\+cursor\+Pressed@{\+\_\+cursor\+Pressed}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+cursor\+Pressed()}{\_cursorPressed()}}
{\footnotesize\ttfamily virtual void Ogre\+Bites\+::\+Widget\+::\+\_\+cursor\+Pressed (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&}]{cursor\+Pos }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reimplemented in \hyperlink{class_ogre_bites_1_1_check_box_ae884c75c98ceae0b68cef4c4017f2619}{Ogre\+Bites\+::\+Check\+Box}, \hyperlink{class_ogre_bites_1_1_slider_a3c93b39119063c6ef84a0830b00675ce}{Ogre\+Bites\+::\+Slider}, \hyperlink{class_ogre_bites_1_1_label_acdb9847496a3cb4ab0a28178baff4a78}{Ogre\+Bites\+::\+Label}, \hyperlink{class_ogre_bites_1_1_select_menu_a66987ecd1558dec054c2713342be0b0f}{Ogre\+Bites\+::\+Select\+Menu}, \hyperlink{class_ogre_bites_1_1_text_box_a14ccbf4a6d3e630df025b4dc82a20507}{Ogre\+Bites\+::\+Text\+Box}, and \hyperlink{class_ogre_bites_1_1_button_a962376cc6398881fb6bf6dafc748ab9d}{Ogre\+Bites\+::\+Button}.

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_abd837ccab4c71eaaec3e116495e4e1ad}\label{class_ogre_bites_1_1_widget_abd837ccab4c71eaaec3e116495e4e1ad}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+cursor\+Released@{\+\_\+cursor\+Released}}
\index{\+\_\+cursor\+Released@{\+\_\+cursor\+Released}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+cursor\+Released()}{\_cursorReleased()}}
{\footnotesize\ttfamily virtual void Ogre\+Bites\+::\+Widget\+::\+\_\+cursor\+Released (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&}]{cursor\+Pos }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reimplemented in \hyperlink{class_ogre_bites_1_1_slider_aad07178beb96b8c61e994adfe94959a8}{Ogre\+Bites\+::\+Slider}, \hyperlink{class_ogre_bites_1_1_select_menu_a670bd0335c5d4bd1e58c560db8435b21}{Ogre\+Bites\+::\+Select\+Menu}, \hyperlink{class_ogre_bites_1_1_text_box_a28b124d44b569c2bbc2c51929d753df2}{Ogre\+Bites\+::\+Text\+Box}, and \hyperlink{class_ogre_bites_1_1_button_ac54936b1ffd9851148b69c279861cf73}{Ogre\+Bites\+::\+Button}.

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_adfad9ac1f94d8c66a7af4dc097190f56}\label{class_ogre_bites_1_1_widget_adfad9ac1f94d8c66a7af4dc097190f56}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+cursor\+Moved@{\+\_\+cursor\+Moved}}
\index{\+\_\+cursor\+Moved@{\+\_\+cursor\+Moved}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+cursor\+Moved()}{\_cursorMoved()}}
{\footnotesize\ttfamily virtual void Ogre\+Bites\+::\+Widget\+::\+\_\+cursor\+Moved (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector2}{Ogre\+::\+Vector2} \&}]{cursor\+Pos,  }\item[{float}]{wheel\+Delta }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reimplemented in \hyperlink{class_ogre_bites_1_1_check_box_a1171830025b3294bbbd2f611d75a88fa}{Ogre\+Bites\+::\+Check\+Box}, \hyperlink{class_ogre_bites_1_1_slider_ae855858f84547b7915dcd2acadb0417e}{Ogre\+Bites\+::\+Slider}, \hyperlink{class_ogre_bites_1_1_select_menu_ab3242059d9782162ba525f2b9f3379e7}{Ogre\+Bites\+::\+Select\+Menu}, \hyperlink{class_ogre_bites_1_1_text_box_a69ad12326d82d6b3ff4633162ac8d29f}{Ogre\+Bites\+::\+Text\+Box}, and \hyperlink{class_ogre_bites_1_1_button_a9b4adf1eee1ec02c4515aa6d2ecc532e}{Ogre\+Bites\+::\+Button}.

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_ae6ebe2e4ee545dd73508a582014b6529}\label{class_ogre_bites_1_1_widget_ae6ebe2e4ee545dd73508a582014b6529}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+focus\+Lost@{\+\_\+focus\+Lost}}
\index{\+\_\+focus\+Lost@{\+\_\+focus\+Lost}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+focus\+Lost()}{\_focusLost()}}
{\footnotesize\ttfamily virtual void Ogre\+Bites\+::\+Widget\+::\+\_\+focus\+Lost (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reimplemented in \hyperlink{class_ogre_bites_1_1_check_box_a038eaeebf83d3228f1f04351bb67de88}{Ogre\+Bites\+::\+Check\+Box}, \hyperlink{class_ogre_bites_1_1_slider_a685f3d4f74178126c5ac6a39d31b8fc5}{Ogre\+Bites\+::\+Slider}, \hyperlink{class_ogre_bites_1_1_select_menu_a7c741b05bff8ece274a2d10cd2cdc9de}{Ogre\+Bites\+::\+Select\+Menu}, \hyperlink{class_ogre_bites_1_1_text_box_a0a248ea9cf64189342a15d160632248e}{Ogre\+Bites\+::\+Text\+Box}, and \hyperlink{class_ogre_bites_1_1_button_a5f88ebd2e09c29e16667b870a5f8121a}{Ogre\+Bites\+::\+Button}.

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_aa677ba5b52e973a39226b2e8274bba02}\label{class_ogre_bites_1_1_widget_aa677ba5b52e973a39226b2e8274bba02}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+assign\+To\+Tray@{\+\_\+assign\+To\+Tray}}
\index{\+\_\+assign\+To\+Tray@{\+\_\+assign\+To\+Tray}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+assign\+To\+Tray()}{\_assignToTray()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Widget\+::\+\_\+assign\+To\+Tray (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_bites_a637c114a713225e37b0f0316f5da3530}{Tray\+Location}}]{tray\+Loc }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_bites_1_1_widget_a5495adaa134dc0f623a59edc47785d6b}\label{class_ogre_bites_1_1_widget_a5495adaa134dc0f623a59edc47785d6b}} 
\index{Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}!\+\_\+assign\+Listener@{\+\_\+assign\+Listener}}
\index{\+\_\+assign\+Listener@{\+\_\+assign\+Listener}!Ogre\+Bites\+::\+Progress\+Bar@{Ogre\+Bites\+::\+Progress\+Bar}}
\subsubsection{\texorpdfstring{\+\_\+assign\+Listener()}{\_assignListener()}}
{\footnotesize\ttfamily void Ogre\+Bites\+::\+Widget\+::\+\_\+assign\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_bites_1_1_tray_listener}{Tray\+Listener} $\ast$}]{listener }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_trays_8h}{Ogre\+Trays.\+h}\end{DoxyCompactItemize}
