source: trunk/src/uvmat_doc/FUNCTIONS_DOC/msgbox_uvmat.html @ 37

Last change on this file since 37 was 37, checked in by sommeria, 14 years ago

create_grid.fig ,
uvmat_doc and all the included files added
File size: 20.0 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of msgbox_uvmat</title>
6  <meta name="keywords" content="msgbox_uvmat">
7  <meta name="description" content="'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../index.html">Home</a> &gt;  <a href="index.html">.</a> &gt; msgbox_uvmat.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for .&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>msgbox_uvmat
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
24<div class="box"><strong>'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
27<div class="box"><strong>function varargout = msgbox_uvmat(varargin) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
30<div class="fragment"><pre class="comment">'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls
31 msgbox_uvmat(title,display)
32
33 OUTPUT:
34 answer  (text string)= 'yes', 'No', 'cancel', or the text string introduced as input
35
36INPUT:
37 title: string indicating the type of message box:
38          title= 'INPUT_TXT','CONFIMATION' ,'ERROR', 'WARNING', 'INPUT_Y-N', default = 'INPUT_TXT' (the title is displayed in the upper bar of the fig).
39          if title='INPUT_TXT', input data is asked in an edit box
40          if title='CONFIMATION'', 'ERROR', 'WARNING', the figure remains  opened until a button 'OK' is pressed
41          if title='INPUT_Y-N', an answer Yes/No is requested
42 display, displayed text
43 default_answer: default answer in the edit box (only used with title='INPUT_TXT')</pre></div>
44
45<!-- crossreference -->
46<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
47This function calls:
48<ul style="list-style-image:url(../matlabicon.gif)">
49</ul>
50This function is called by:
51<ul style="list-style-image:url(../matlabicon.gif)">
52<li><a href="civ.html" class="code" title="function varargout = civ(varargin)">civ</a>  'civ': function associated with the interface 'civ.fig' for PIV, spline interpolation and stereo PIV (patch)</li><li><a href="dataview.html" class="code" title="function varargout = dataview(varargin)">dataview</a>  TEST 'dataview': function for scanning directories in a campaign (TEST)</li><li><a href="geometry_calib.html" class="code" title="function varargout = geometry_calib(varargin)">geometry_calib</a>     'geometry_calib': performs geometric calibration from a set of reference points</li><li><a href="get_field.html" class="code" title="function varargout = get_field(varargin)">get_field</a>    'get_field': display variables and attributes from a Netcdf file, and plot selected fields</li><li><a href="plot_field.html" class="code" title="function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,KeepLim,PosColorbar)">plot_field</a>   'plot_field': plot any field with the structure defined in the uvmat package</li><li><a href="series.html" class="code" title="function varargout = series(varargin)">series</a>        'series': master function associated to the GUI series.m for analysis field series</li><li><a href="set_grid.html" class="code" title="function varargout = set_grid(varargin)">set_grid</a>    'set_grid':produce grid for PIV with one or two images (stereo case)</li><li><a href="set_object.html" class="code" title="function varargout = set_object(varargin)">set_object</a>    'set_object': GUI to edit a projection object</li><li><a href="uvmat.html" class="code" title="function varargout = uvmat(varargin)">uvmat</a>  'uvmat': function associated with the GUI 'uvmat.fig' for images and data field visualization</li><li><a href="warndlg_uvmat.html" class="code" title="function hwarn=warndlg_uvmat(warntext,title)">warndlg_uvmat</a>  'warndlg_uvmat': display warning message (error, warning, confirmation) in a given figure</li></ul>
53<!-- crossreference -->
54
55<h2><a name="_subfunctions"></a>SUBFUNCTIONS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
56<ul style="list-style-image:url(../matlabicon.gif)">
57<li><a href="#_sub1" class="code">function msgbox_uvmat_OpeningFcn(hObject, eventdata, handles,title,display,default_answer)</a></li><li><a href="#_sub2" class="code">function varargout = msgbox_uvmat_OutputFcn(hObject, eventdata, handles)</a></li><li><a href="#_sub3" class="code">function OK_Callback(hObject, eventdata, handles)</a></li><li><a href="#_sub4" class="code">function No_Callback(hObject, eventdata, handles)</a></li><li><a href="#_sub5" class="code">function Cancel_Callback(hObject, eventdata, handles)</a></li><li><a href="#_sub6" class="code">function edit_box_Callback(hObject, eventdata, handles)</a></li><li><a href="#_sub7" class="code">function figure1_CloseRequestFcn(hObject, eventdata, handles)</a></li><li><a href="#_sub8" class="code">function figure1_KeyPressFcn(hObject, eventdata, handles)</a></li></ul>
58<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
59<div class="fragment"><pre>0001 <span class="comment">%'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls</span>
600002 <span class="comment">% msgbox_uvmat(title,display)</span>
610003 <span class="comment">%</span>
620004 <span class="comment">% OUTPUT:</span>
630005 <span class="comment">% answer  (text string)= 'yes', 'No', 'cancel', or the text string introduced as input</span>
640006 <span class="comment">%</span>
650007 <span class="comment">%INPUT:</span>
660008 <span class="comment">% title: string indicating the type of message box:</span>
670009 <span class="comment">%          title= 'INPUT_TXT','CONFIMATION' ,'ERROR', 'WARNING', 'INPUT_Y-N', default = 'INPUT_TXT' (the title is displayed in the upper bar of the fig).</span>
680010 <span class="comment">%          if title='INPUT_TXT', input data is asked in an edit box</span>
690011 <span class="comment">%          if title='CONFIMATION'', 'ERROR', 'WARNING', the figure remains  opened until a button 'OK' is pressed</span>
700012 <span class="comment">%          if title='INPUT_Y-N', an answer Yes/No is requested</span>
710013 <span class="comment">% display, displayed text</span>
720014 <span class="comment">% default_answer: default answer in the edit box (only used with title='INPUT_TXT')</span>
730015
740016 <a name="_sub0" href="#_subfunctions" class="code">function varargout = msgbox_uvmat(varargin)</a>
750017
760018 <span class="comment">% Last Modified by GUIDE v2.5 24-Oct-2009 21:55:17</span>
770019
780020 <span class="comment">% Begin initialization code - DO NOT EDIT</span>
790021 gui_Singleton = 1;
800022 gui_State = struct(<span class="string">'gui_Name'</span>,       mfilename, <span class="keyword">...</span>
810023                    <span class="string">'gui_Singleton'</span>,  gui_Singleton, <span class="keyword">...</span>
820024                    <span class="string">'gui_OpeningFcn'</span>, @<a href="#_sub1" class="code" title="subfunction msgbox_uvmat_OpeningFcn(hObject, eventdata, handles,title,display,default_answer)">msgbox_uvmat_OpeningFcn</a>, <span class="keyword">...</span>
830025                    <span class="string">'gui_OutputFcn'</span>,  @<a href="#_sub2" class="code" title="subfunction varargout = msgbox_uvmat_OutputFcn(hObject, eventdata, handles)">msgbox_uvmat_OutputFcn</a>, <span class="keyword">...</span>
840026                    <span class="string">'gui_LayoutFcn'</span>,  [] , <span class="keyword">...</span>
850027                    <span class="string">'gui_Callback'</span>,   []);
860028 <span class="keyword">if</span> nargin &amp;&amp; ischar(varargin{1})
870029     gui_State.gui_Callback = str2func(varargin{1});
880030 <span class="keyword">end</span>
890031
900032 <span class="keyword">if</span> nargout
910033     [varargout{1:nargout}] = gui_mainfcn(gui_State, varargin{:});
920034 <span class="keyword">else</span>
930035     gui_mainfcn(gui_State, varargin{:});
940036 <span class="keyword">end</span>
950037 <span class="comment">% End initialization code - DO NOT EDIT</span>
960038
970039 <span class="comment">% --- Executes just before msgbox_uvmat is made visible.</span>
980040 <a name="_sub1" href="#_subfunctions" class="code">function msgbox_uvmat_OpeningFcn(hObject, eventdata, handles,title,display,default_answer)</a>
990041 <span class="comment">% This function has no output args, see OutputFcn.</span>
1000042
1010043 <span class="comment">% Choose default command line output for msgbox_uvmat</span>
1020044 handles.output = <span class="string">'Cancel'</span>;
1030045
1040046 <span class="comment">% Update handles structure</span>
1050047 guidata(hObject, handles);
1060048 testNo=0;
1070049 testCancel=1;
1080050 testinputstring=0;
1090051 icontype=<span class="string">'quest'</span>;<span class="comment">%default question icon (text input asked)</span>
1100052 <span class="keyword">if</span> exist(<span class="string">'title'</span>,<span class="string">'var'</span>)
1110053       set(hObject, <span class="string">'Name'</span>, title);
1120054       <span class="keyword">if</span> isequal (title,<span class="string">'CONFIRMATION'</span>)
1130055          icontype=<span class="string">''</span>;
1140056          testCancel=0; <span class="comment">%no cancel button</span>
1150057       <span class="keyword">elseif</span> isequal (title,<span class="string">'ERROR'</span>)
1160058          icontype=<span class="string">'error'</span>;
1170059          testCancel=0; <span class="comment">%no cancel button</span>
1180060       <span class="keyword">elseif</span> isequal (title,<span class="string">'WARNING'</span>)
1190061          icontype=<span class="string">'warn'</span>;
1200062          testCancel=0; <span class="comment">%no cancel button</span>
1210063       <span class="keyword">elseif</span> isequal (title,<span class="string">'INPUT_Y-N'</span>)
1220064          icontype=<span class="string">'quest'</span>;
1230065          testNo=1; <span class="comment">% button No activated</span>
1240066       <span class="keyword">else</span>
1250067           testinputstring=1;
1260068       <span class="keyword">end</span>
1270069 <span class="keyword">end</span>
1280070 <span class="keyword">if</span> exist(<span class="string">'display'</span>,<span class="string">'var'</span>)
1290071     set(handles.text1, <span class="string">'String'</span>, display);
1300072 <span class="keyword">end</span>
1310073 <span class="keyword">if</span> testinputstring
1320074     set(handles.edit_box, <span class="string">'Visible'</span>, <span class="string">'on'</span>);
1330075 <span class="keyword">else</span>
1340076     set(handles.text1, <span class="string">'Position'</span>, [0.15 0.3 0.85 0.7]);
1350077 <span class="keyword">end</span>
1360078 <span class="keyword">if</span> exist(<span class="string">'default_answer'</span>,<span class="string">'var'</span>) &amp;&amp;  testinputstring
1370079     set(handles.edit_box, <span class="string">'String'</span>, default_answer);
1380080 <span class="keyword">end</span>
1390081 <span class="comment">% Determine the position of the dialog - centered on the screen</span>
1400082 FigPos=get(0,<span class="string">'DefaultFigurePosition'</span>);
1410083 OldUnits = get(hObject, <span class="string">'Units'</span>);
1420084 set(hObject, <span class="string">'Units'</span>, <span class="string">'pixels'</span>);
1430085 OldPos = get(hObject,<span class="string">'Position'</span>);
1440086 FigWidth = OldPos(3);
1450087 FigHeight = OldPos(4);
1460088 ScreenUnits=get(0,<span class="string">'Units'</span>);
1470089 set(0,<span class="string">'Units'</span>,<span class="string">'pixels'</span>);
1480090 ScreenSize=get(0,<span class="string">'ScreenSize'</span>);
1490091 set(0,<span class="string">'Units'</span>,ScreenUnits);
1500092
1510093 FigPos(1)=1/2*(ScreenSize(3)-FigWidth);
1520094 FigPos(2)=2/3*(ScreenSize(4)-FigHeight);
1530095 FigPos(3:4)=[FigWidth FigHeight];
1540096 set(hObject, <span class="string">'Position'</span>, FigPos);
1550097 set(hObject, <span class="string">'Units'</span>, OldUnits);
1560098
1570099 <span class="comment">% Show a question icon from dialogicons.mat - variables questIconData</span>
1580100 <span class="comment">% and questIconMap</span>
1590101 <span class="keyword">if</span> isequal(icontype,<span class="string">''</span>)
1600102     hima=findobj(handles.axes1,<span class="string">'Type'</span>,<span class="string">'image'</span>);
1610103     <span class="keyword">if</span> ~isempty(hima)
1620104         delete(hima)
1630105     <span class="keyword">end</span>
1640106 <span class="keyword">else</span>
1650107     load dialogicons.mat
1660108     eval([<span class="string">'IconData='</span> icontype <span class="string">'IconData;'</span>])
1670109     eval([<span class="string">'IconCMap='</span> icontype <span class="string">'IconMap;'</span>])
1680110     questIconMap(256,:) = get(handles.figure1, <span class="string">'Color'</span>);
1690111     Img=image(IconData, <span class="string">'Parent'</span>, handles.axes1);
1700112     set(handles.figure1, <span class="string">'Colormap'</span>, IconCMap);
1710113     set(handles.axes1, <span class="keyword">...</span>
1720114         <span class="string">'Visible'</span>, <span class="string">'off'</span>, <span class="keyword">...</span>
1730115         <span class="string">'YDir'</span>   , <span class="string">'reverse'</span>       , <span class="keyword">...</span>
1740116         <span class="string">'XLim'</span>   , get(Img,<span class="string">'XData'</span>), <span class="keyword">...</span>
1750117         <span class="string">'YLim'</span>   , get(Img,<span class="string">'YData'</span>)  <span class="keyword">...</span>
1760118         );
1770119 <span class="keyword">end</span> 
1780120 <span class="keyword">if</span> testCancel
1790121      set(handles.Cancel,<span class="string">'Visible'</span>,<span class="string">'on'</span>)
1800122 <span class="keyword">else</span>
1810123     set(handles.Cancel,<span class="string">'Visible'</span>,<span class="string">'off'</span>)
1820124 <span class="keyword">end</span>
1830125 <span class="keyword">if</span> testNo
1840126      set(handles.No,<span class="string">'Visible'</span>,<span class="string">'on'</span>)
1850127 <span class="keyword">else</span>
1860128     set(handles.No,<span class="string">'Visible'</span>,<span class="string">'off'</span>)
1870129 <span class="keyword">end</span>
1880130 <span class="comment">% if testOK % request an answer to proceed</span>
1890131 <span class="comment">%     set(handles.OK,'Visible','on')</span>
1900132     <span class="comment">% Make the GUI modal</span>
1910133 set(handles.figure1,<span class="string">'WindowStyle'</span>,<span class="string">'modal'</span>)
1920134 <span class="comment">% UIWAIT makes msgbox_uvmat wait for user response (see UIRESUME)</span>
1930135 uiwait(handles.figure1);
1940136 <span class="comment">% else</span>
1950137 <span class="comment">%     set(handles.OK,'Visible','off')</span>
1960138 <span class="comment">%     set(handles.Cancel,'Visible','off')</span>
1970139 <span class="comment">% end</span>
1980140 <span class="comment">% delete(hObject)</span>
1990141
2000142 <span class="comment">% --- Outputs from this function are returned to the command line.</span>
2010143 <a name="_sub2" href="#_subfunctions" class="code">function varargout = msgbox_uvmat_OutputFcn(hObject, eventdata, handles)</a>
2020144
2030145 <span class="comment">% Get default command line output from handles structure</span>
2040146
2050147 <span class="comment">% varargout{1} = hObject;</span>
2060148 handles.output
2070149 <span class="keyword">if</span> isequal(handles.output,<span class="string">'Cancel'</span>)
2080150     varargout{1}=<span class="string">'Cancel'</span>;
2090151 <span class="keyword">elseif</span> isequal(handles.output,<span class="string">'No'</span>)
2100152     varargout{1}=<span class="string">'No'</span>;
2110153 <span class="keyword">else</span>
2120154     varargout{1}=get(handles.edit_box,<span class="string">'String'</span>);
2130155     isequal(varargout{1},<span class="string">''</span>)
2140156     <span class="keyword">if</span> isempty(varargout{1}) || isequal(varargout{1},<span class="string">''</span>)
2150157         varargout{1}=<span class="string">'Yes'</span>;
2160158     <span class="keyword">end</span>
2170159 <span class="keyword">end</span>
2180160     
2190161 <span class="comment">%varargout{2} = handles.output;</span>
2200162
2210163 <span class="comment">% The figure can be deleted now</span>
2220164 delete(handles.figure1);
2230165
2240166 <span class="comment">% --- Executes on button press in OK.</span>
2250167 <a name="_sub3" href="#_subfunctions" class="code">function OK_Callback(hObject, eventdata, handles)</a>
2260168 handles.output = get(hObject,<span class="string">'String'</span>);
2270169 guidata(hObject, handles);<span class="comment">% Update handles structure</span>
2280170 uiresume(handles.figure1);
2290171
2300172 <span class="comment">% --- Executes on button press in No.</span>
2310173 <a name="_sub4" href="#_subfunctions" class="code">function No_Callback(hObject, eventdata, handles)</a>
2320174 handles.output=<span class="string">'No'</span>;
2330175 guidata(hObject, handles);
2340176 uiresume(handles.figure1);
2350177
2360178 <span class="comment">% --- Executes on button press in Cancel.</span>
2370179 <a name="_sub5" href="#_subfunctions" class="code">function Cancel_Callback(hObject, eventdata, handles)</a>
2380180 handles.output = get(hObject,<span class="string">'String'</span>);
2390181 <span class="comment">%handles.output = 'Cancel'</span>
2400182 guidata(hObject, handles); <span class="comment">% Update handles structure</span>
2410183 <span class="comment">% Use UIRESUME instead of delete because the OutputFcn needs</span>
2420184 <span class="comment">% to get the updated handles structure.</span>
2430185 uiresume(handles.figure1);
2440186
2450187 <span class="comment">% --- Executes on activation of edit_box.</span>
2460188 <a name="_sub6" href="#_subfunctions" class="code">function edit_box_Callback(hObject, eventdata, handles)</a>
2470189
2480190
2490191 <span class="comment">% --- Executes when user attempts to close figure1.</span>
2500192 <a name="_sub7" href="#_subfunctions" class="code">function figure1_CloseRequestFcn(hObject, eventdata, handles)</a>
2510193 <span class="keyword">if</span> isequal(get(handles.figure1, <span class="string">'waitstatus'</span>), <span class="string">'waiting'</span>)
2520194     <span class="comment">% The GUI is still in UIWAIT, us UIRESUME</span>
2530195     uiresume(handles.figure1);
2540196 <span class="keyword">else</span>
2550197     <span class="comment">% The GUI is no longer waiting, just close it</span>
2560198     delete(handles.figure1);
2570199 <span class="keyword">end</span>
2580200
2590201 <span class="comment">% --- Executes on key press over figure1 with no controls selected.</span>
2600202 <a name="_sub8" href="#_subfunctions" class="code">function figure1_KeyPressFcn(hObject, eventdata, handles)</a>
2610203 <span class="comment">% Check for &quot;enter&quot; or &quot;escape&quot;</span>
2620204 <span class="keyword">if</span> isequal(get(hObject,<span class="string">'CurrentKey'</span>),<span class="string">'escape'</span>)
2630205     <span class="comment">% User said no by hitting escape</span>
2640206     handles.output = <span class="string">'No'</span>;
2650207     
2660208     <span class="comment">% Update handles structure</span>
2670209     guidata(hObject, handles);
2680210     
2690211     uiresume(handles.figure1);
2700212 <span class="keyword">end</span>
2710213 <span class="keyword">if</span> isequal(get(hObject,<span class="string">'CurrentKey'</span>),<span class="string">'return'</span>)
2720214     uiresume(handles.figure1);
2730215 <span class="keyword">end</span>   
2740216
2750217
2760218
2770219
2780220</pre></div>
279<hr><address>Generated on Fri 13-Nov-2009 11:17:03 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
280</body>
281</html>
Note: See TracBrowser for help on using the repository browser.