home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / dokdocs.zip / dok.INF (.txt) next >
OS/2 Help File  |  1995-11-09  |  421KB  |  20,748 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. An Overview of Mesa DOK ΓòÉΓòÉΓòÉ
  3.  
  4. Mesa DOK includes 23 classes, which are described in detail in the "Developer 
  5. Object Kit Class Reference". These classes are described here briefly, with an 
  6. emphasis on how they interact with one another. 
  7.  
  8.      Models 
  9.  
  10.       Within Mesa DOK, the term model refers to an open Mesa 2 file. (Within 
  11.       the Mesa 2 User's Guide, the terms "file" and "workbook" are usually 
  12.       used; the term "worksheet" is used occassionally, as well. These terms 
  13.       can be considered interchangable.) The MMesaModel class allows you to 
  14.       create a model, associate it with a file, retrieve and alter information 
  15.       within that model, and initiate model-specific operations (see 
  16.       MMesaModel). 
  17.  
  18.       Every model contains one or more "pages", which are either layer pages or 
  19.       script pages. A layer page can be thought of as a single page in a 
  20.       workbook, containing a two-dimensional "slice" of the three-dimensional 
  21.       matrix of cells within the model. A script page can also be thought of as 
  22.       a page in a workbook, but it does not contain any cells; instead, it 
  23.       contains an executable REXX program. 
  24.  
  25.       Various items of information are maintained on a per-page basis - for 
  26.       example, each layer can have its own name. All of this information can be 
  27.       accessed through the MMesaModel instance (see 
  28.       MMesaModel::getLayerName()). 
  29.  
  30.       Other items of information are maintained on a per-model basis, and are 
  31.       described fully along with the model class itself. 
  32.  
  33.       Among the more important items contained in a model are: 
  34.  
  35.         1. Cells 
  36.  
  37.            Every model contains between one and 12 trillion cells, arranged in 
  38.            a three-dimensional matrix with rows along the X (horizontal) axis, 
  39.            columns along the Y (vertical) axis, and layers along the Z axis. 
  40.            Any cell in a model can be referred to via its three-dimensional 
  41.            address (row, column, and layer), indicating where in the matrix it 
  42.            is. 
  43.  
  44.              -  Cell addresses 
  45.  
  46.                 You can refer to a cell by its absolute address, specifying its 
  47.                 row, column and layer exactly, or you can refer to it via a 
  48.                 relative address, specifying the distance in rows, columns, and 
  49.                 layers between it and another cell whose address is known. 
  50.  
  51.                 Every cell address, both relative and absolute, is represented 
  52.                 by an instance of MAddress (see MAddress). 
  53.  
  54.              -  Cell contents 
  55.  
  56.                 Each cell can contain a number, a string, a formula, or an 
  57.                 array of numbers and/or strings. 
  58.  
  59.                 The contents of a cell can be queried or altered through the 
  60.                 MMesaModel instance (see MMesaModel::getCellString()). 
  61.  
  62.              -  Cell values 
  63.  
  64.                 Each cell has a value, which may be different from its contents 
  65.                 (for example, if a cell contains the formula @SQRT(100), its 
  66.                 value is 10), and which is recalculated regularly by the model 
  67.                 based on the cell's contents. 
  68.  
  69.                 The value of a cell can be queried through the MMesaModel 
  70.                 instance (see MMesaModel::getCellValue()). 
  71.  
  72.              -  Cell formats 
  73.  
  74.                 Each cell has a format, which controls how the cell value is 
  75.                 drawn on the screen or by a printer. For example, cells A1 and 
  76.                 A2 may share the value 2200, but cell A1 may display $2,200.00 
  77.                 in blue 12-point Helvetica Bold, while cell A2 displays 2.2e3 
  78.                 in red 24-point Times Rmn. Alignment, font and typeface, text 
  79.                 and background color, presence and color of borders, and much 
  80.                 more can be included in the format of a cell. 
  81.  
  82.                 Every distinct format within a model is represented by an 
  83.                 instance of MFormat (see MFormat). Every instance of MFormat, 
  84.                 in turn, refers to an instance of MFont (representing the font 
  85.                 family, size, and typeface of the format) and several instances 
  86.                 of MColor (representing text color, background color, border 
  87.                 colors, etc.). 
  88.  
  89.         2. Graphicobjects 
  90.  
  91.            Every model can contain any number of graphic objects, or frames. 
  92.            Among the types of frames that can be included are geometric shapes 
  93.            (rectangles, lines, ovals, etc.), OS/2 .BMP files, and any of a wide 
  94.            variety of graphs - for example, a column graph of a range of data. 
  95.            (The terms "frame", "graph", and "graphic object" can be considered 
  96.            interchangable in this document, and refer to any of the objects 
  97.            just mentioned). 
  98.  
  99.            Every frame within a model has a unique name and can be referred to 
  100.            by that name in order to access or edit it. While the frames 
  101.            themselves are implemented as a subclass of MFrame (an internal 
  102.            class not available through Mesa DOK), a frame's properties can be 
  103.            altered by merging it with an instance of MFrameXfer (see 
  104.            MFrameXfer) through the MMesaModel instance that contains it (see 
  105.            MMesaModel::setFrameInfo()). Generally speaking, interactions with 
  106.            Mesa DOK frames are handled through MFrameXfer. 
  107.  
  108.         3. Current selection(s) 
  109.  
  110.            Every model keeps track of the current selection - the object or set 
  111.            of objects that future actions should affect by default. Every layer 
  112.            has a selection associated with it, and when that layer is 
  113.            displayed, the associated selection is activated. All of this 
  114.            information is stored within an instance of MSelection, which is 
  115.            associated with the model (see MSelection). 
  116.  
  117.            A selection consists of a range of cells, which can be 
  118.            discontinuous, and is represented by an instance of MRange (see 
  119.            MRange). It may also contain some number of frames - the MSelection 
  120.            instance maintains a list of frame names. 
  121.  
  122.            Generally speaking, an action taken within the Mesa 2 application 
  123.            will affect some or all of the current selection. Actions that apply 
  124.            to a single cell will affect the base cell, actions that apply to a 
  125.            frame will affect all selected frames, and actions that apply to one 
  126.            or more cells will affect the entire selected range. 
  127.  
  128.         4. Interested objects 
  129.  
  130.            Every model maintains a list of objects which have registered some 
  131.            interest in it. For example, every window that displays some part of 
  132.            the model registers interest in that model. As long as something is 
  133.            still interested in it, the model stays open; conversely, when 
  134.            nothing is registering interest in it, the model destroys itself. 
  135.  
  136.            Interest in a model is represented by an instance of MInterest (see 
  137.            MInterest), and is registered directly through the MMesaModel 
  138.            instance (see MMesaModel::registerInterest()). 
  139.  
  140.            Note that the information about the model is actually stored in an 
  141.            instance of MModel, which is a Mesa-internal class not directly 
  142.            available through DOK. MMesaModel is a wrapper around the MModel 
  143.            class which your application can use to access Mesa's model 
  144.            functionality. 
  145.  
  146.              -  Windows 
  147.  
  148.                 MWindow is the class from which all Mesa windows inherit their 
  149.                 basic behavior (see MWindow). This behavior subsumes the 
  150.                 standard OS/2 window behavior, since MWindow implements a 
  151.                 series of pass-through functions to the default window handler. 
  152.  
  153.                 MView represents any region that can be placed inside a normal 
  154.                 OS/2 window (see MView). It is not directly instantiated, but 
  155.                 if you want to customize the display of information within your 
  156.                 application, you will probably need to create your own 
  157.                 subclasses of MView. 
  158.  
  159.                 MSheetView is a pre-created MView subclass that draws a layer 
  160.                 of data, including row and column headers (see MSheetView). 
  161.                 MMesaView is another pre-created MView subclass that combines 
  162.                 an MSheetView with a pair of scrollbars (see MMesaView).Any 
  163.                 point within an MWindow can be identified by its horizontal and 
  164.                 vertical distance from the upper-left corner of that window. 
  165.                 This information is generally stored in an MPoint instance (see 
  166.                 MPoint). For example, when you click the mouse on a layer to 
  167.                 select a cell, an MPoint is created that represents the 
  168.                 position of the mouse. Then, the model is queried to determine 
  169.                 the address of the cell being displayed at that point (see 
  170.                 MMesaModel::addressFromPoint()). 
  171.  
  172.                 Similarly, any rectangular region within an MWindow can be 
  173.                 identified by the MPoints representing its upper-left and 
  174.                 lower-right corners. That information is generally stored in an 
  175.                 MRect instance (see MRect). For example, when creating a graph, 
  176.                 you must specify the rectangle within which the frame is to be 
  177.                 created (see MMesaModel::createGraph()). 
  178.  
  179.              -  Input and output 
  180.  
  181.                   -- Byte streams 
  182.  
  183.                      Most input and output within Mesa DOK is handled through 
  184.                      MStream, a platform-independant streaming protocol that 
  185.                      represents a "stream" of data, and behaves consistently no 
  186.                      matter what I/O device is being used. Other classes can 
  187.                      write themselves out to and read themselves in from a 
  188.                      stream without knowing or caring where the data is 
  189.                      actually coming from or going. When an item is written to 
  190.                      a stream, it is written with an identifier, followed by 
  191.                      the position in the stream of the next item (to allow easy 
  192.                      skipping over the current item if desired), followed by 
  193.                      the item itself. 
  194.  
  195.                      There are two subclasses of MStream defined within Mesa 
  196.                      DOK - one to handle clipboard I/O (see MClipStream) and 
  197.                      one to handle file I/O (see MFileStream). You can subclass 
  198.                      MStream within your own application to handle 
  199.                      application-specific I/O in the same way. 
  200.  
  201.                   -- Printing 
  202.  
  203.                      For the most part, Mesa handles printing the same way it 
  204.                      handles drawing to the screen - the printer is treated as 
  205.                      just another space to draw on by the model (see 
  206.                      MMesaModel::print()). One exception is that when printing, 
  207.                      the model must keep track of various aspects of the print 
  208.                      job - margins, headers, footers, and so forth. This 
  209.                      information is stored in an MPrintHead instance (see 
  210.                      MPrintHead). 
  211.  
  212.                        -  The controller 
  213.  
  214.                           A controller is an object that handles 
  215.                           application-wide message passing. Within Mesa 2 the 
  216.                           controller object maintains a list of models and the 
  217.                           real time data feed table, performs licensing 
  218.                           functions, handles file opening and error panels, and 
  219.                           in general handles all functions that are not 
  220.                           associated with a specific MMesaModel instance. 
  221.  
  222.                           MGController is a generic controller object (see 
  223.                           MGController). In order to use the Mesa DLLs, you 
  224.                           must create and instantiate a subclass of 
  225.                           MGController that properly handles message-passing 
  226.                           between the DLLs and your application. Understanding 
  227.                           the MGController class and how it interacts with your 
  228.                           application is very important in learning to use DOK. 
  229.  
  230.                           Mesa DOK includes MException, a class that handles 
  231.                           errors within Mesa 2, and can be extended by your 
  232.                           custom application to handle other types of 
  233.                           exceptions. MException instances can be passed to and 
  234.                           from the controller for a variety of purposes, and 
  235.                           many methods include an MException parameter for 
  236.                           returning status information. 
  237.  
  238.  
  239. ΓòÉΓòÉΓòÉ 1.1. Mesa DOK class heirarchy ΓòÉΓòÉΓòÉ
  240.  
  241. Another way to categorize the Mesa DOK classes is through a class heirarchy, 
  242. emphasizing inheritance relationships between the various classes, as follows: 
  243.  
  244.      MObject (see MObject) 
  245.  
  246.       MObject is the base class for all objects with virtual tables, and it 
  247.       allows those classes and instances to query information about themselves. 
  248.       The following classes inherit from MObject: 
  249.  
  250.         -  MFrameXfer (see MFrameXfer) 
  251.  
  252.            Stores information about a Mesa graphic object (for example, a graph 
  253.            or a geometric shape). 
  254.  
  255.         -  MGController (see MGController) 
  256.  
  257.            Handles application-wide message passing. 
  258.  
  259.         -  MInterest (see MInterest) 
  260.  
  261.            Allows one object to declare an "interest" in another. 
  262.  
  263.         -  MMesaModel (see MMesaModel) 
  264.  
  265.            Represents an open Mesa 2 file. 
  266.  
  267.         -  MPrintHead (see MPrintHead) 
  268.  
  269.            Stores information related to a print operation - margins, headers, 
  270.            footers, etc. 
  271.  
  272.         -  MStream (see MStream) 
  273.  
  274.            Handles input and output in a platform-independant fashion. The 
  275.            following platform-dependant input/output classes inherit from 
  276.            MStream: 
  277.  
  278.              -- MClipStream (see MClipStream) 
  279.  
  280.                 Handles OS/2 clipboard I/O. 
  281.  
  282.              -- MFileStream (see MFileStream) 
  283.  
  284.                 Handles OS/2 file system I/O. 
  285.  
  286.         -  MWindow (see MWindow) 
  287.  
  288.            Handles windowing functions within Mesa DOK. The following 
  289.            Mesa-specific window classes inherit from MWindow: 
  290.  
  291.              -- MEditView (see MEditView) 
  292.  
  293.                 Implements an edit view: a rectangular region within which text 
  294.                 can be edited. 
  295.  
  296.              -- MMesaView (see MMesaView) 
  297.  
  298.                 Handles the relationship between a display window, an 
  299.                 MSheetView instance (see below), and a set of scrollbars. 
  300.  
  301.              -- MSheetView (see MSheetView) 
  302.  
  303.                 Handles the drawing of a layer of data, including row and 
  304.                 column headers. 
  305.  
  306.  Mesa DOK also includes the following classes which do not inherit from any 
  307.  other DOK class: 
  308.  
  309.      MAddress (see MAddress) 
  310.  
  311.      MColor (see MColor) 
  312.  
  313.      MException (see MException) 
  314.  
  315.      MFont (see MFont) 
  316.  
  317.      MFormat (see MFormat) 
  318.  
  319.      MPoint (see MPoint) 
  320.  
  321.      MRange (see MRange) 
  322.  
  323.      MRect (see MRect) 
  324.  
  325.      MSelection (see MSelection) 
  326.  
  327.  
  328. ΓòÉΓòÉΓòÉ 2. Developer Object Kit Class Reference ΓòÉΓòÉΓòÉ
  329.  
  330. The Mesa Developer Object Kit (DOK) consists of the following classes: 
  331.  
  332.      MAddress 
  333.  
  334.       Holds the three-dimensional address (relative or absolute) of a cell in a 
  335.       model. 
  336.  
  337.      MClipStream 
  338.  
  339.       Handles input and output to the OS/2 clipboard. 
  340.  
  341.      MColor 
  342.  
  343.       Stores color and pattern information for a single color instance. 
  344.  
  345.      MEditView 
  346.  
  347.       Implements an edit view: a rectangular region within which text can be 
  348.       edited. 
  349.  
  350.      MException 
  351.  
  352.       Stores an application-defined error. Can be expanded to include warnings 
  353.       and other kinds of exceptions. 
  354.  
  355.      MFileStream 
  356.  
  357.       Abstracts the OS/2 file system and allows data to be written to or read 
  358.       from disk. 
  359.  
  360.      MFont 
  361.  
  362.       Stores font family, size, and typeface information for a single font 
  363.       instance. 
  364.  
  365.      MFormat 
  366.  
  367.       Stores formatting information that controls how a cell's contents are 
  368.       displayed. 
  369.  
  370.      MFrameXfer 
  371.  
  372.       Stores information about a Mesa graphic object (for example, a graph or a 
  373.       geometric shape),otherwise known as a frame. 
  374.  
  375.      MGController 
  376.  
  377.       An application-specific, abstract base class that handles 
  378.       application-wide message passing. Essentially, any information or task 
  379.       that is not file-specific is stored in and handled by the controller. 
  380.  
  381.      MInterest 
  382.  
  383.       Abstract base class that represents interest in an model, which results 
  384.       in notifications being sent when that model undergoes a state change. 
  385.       Each model maintains a list of registered interests in it, and notifies 
  386.       the interest whenever an appropriate state change occurs. 
  387.  
  388.      MMesaModel 
  389.  
  390.       Represents an open Mesa 2 file, often called a workbook or a model. In 
  391.       general, all information and processes specific to a single Mesa 2 file 
  392.       can be accessed and initiated by the MMesaModel instance that represents 
  393.       that file. 
  394.  
  395.      MMesaView 
  396.  
  397.       Handles the "spreadsheet" part of a single file window, including 
  398.       scrollbars and the sheet display. 
  399.  
  400.      MObject 
  401.  
  402.       Base class for all objects with virtual tables in Mesa DOK. MObject 
  403.       allows other classes and instances to query information about themselves. 
  404.  
  405.      MPoint 
  406.  
  407.       Represents a single point within the application window - for example, 
  408.       the point where a mouse-down event occurs. MPoint is an abstraction of 
  409.       the OS/2 POINTL class, existing primarily to allow alterations to 
  410.       point-handling routines to be made in a single place in the code. 
  411.  
  412.      MPrintHead 
  413.  
  414.       Each MPrintHead instance keeps track of print-job related information: 
  415.  
  416.      MRange 
  417.  
  418.       Represents a range of cells within a model. 
  419.  
  420.      MRect 
  421.  
  422.       Represents a rectangular region within the application window - for 
  423.       example, the size of a selected rectangular range. 
  424.  
  425.      MSelection 
  426.  
  427.       An MSelection represents a set of model contents, such as ranges and 
  428.       graphs, and also maintains other information about the view and model 
  429.       that it is associated with. 
  430.  
  431.      MSheetView 
  432.  
  433.       Represents a view into a layer of data, including row and column headers. 
  434.  
  435.      MStream 
  436.  
  437.       Handles input and output in a platform-independant fashion. 
  438.  
  439.      MView 
  440.  
  441.       Handles abstract views - display regions that can be placed inside a 
  442.       normal OS/2 window. The other Mesa DOK view classes, such as MMesaView 
  443.       and MSheetView, are all subclasses of MView. 
  444.  
  445.      MWindow 
  446.  
  447.       MWindow is the basic Mesa window class; all windows within the 
  448.       application are subclasses of MWindow. 
  449.  
  450.  
  451. ΓòÉΓòÉΓòÉ 2.1. MAddress ΓòÉΓòÉΓòÉ
  452.  
  453. address.h is the source file for this class. 
  454.  
  455. ach cell in a model can be referenced via a three-dimensional coordinate (row, 
  456. column, layer) in one of two ways: via absolute reference, where the three 
  457. coordinates are given from the upper-left corner of the model (cell [A]A1), or 
  458. relative reference, where they are given from some other cell in the model. In 
  459. order to work with a relative address, it is frequently necessary to determine 
  460. the absolute address of the cell it refers to. To do this requires that it be 
  461. merged with respect to another address via MAddress::doMerge(). 
  462.  
  463. Each MAddress instance keeps track of coordinates for row, column, and layer 
  464. (these are integers, starting at 0). Additionally, each instance keeps relative 
  465. flags for row, column, and layer, indicating whether that part of the address 
  466. is relative or not, and a null-address flag, indicating whether the instance 
  467. currently represents a valid address. 
  468.  
  469.  
  470. ΓòÉΓòÉΓòÉ 2.1.1. Creating, destroying, and initializing an MAddress instance ΓòÉΓòÉΓòÉ
  471.  
  472. Open the Contents view and expand this section to see a list of methods. 
  473.  
  474.  
  475. ΓòÉΓòÉΓòÉ 2.1.1.1. MAddress::free() ΓòÉΓòÉΓòÉ
  476.  
  477. free() 
  478.  
  479. Resets all variables and sets null-address flag true. 
  480.  
  481. void 
  482.  
  483.  
  484. ΓòÉΓòÉΓòÉ 2.1.1.2. MAddress::init() ΓòÉΓòÉΓòÉ
  485.  
  486. init() 
  487.  
  488. Clears the row, column, layer coordinates; sets null-address flag true. 
  489.  
  490. void 
  491.  
  492. init(int r, int c, int l) 
  493.  
  494.       int r   New row coordinate 
  495.  
  496.       int c   New column coordinate 
  497.  
  498.       int l   New layer coordinate 
  499.  
  500.  Sets row, column and layer coordinates to r, c, and l, respectively. Sets all 
  501.  relative flags true. 
  502.  
  503.  void 
  504.  
  505.  init(const MAddress *ad) 
  506.  
  507.       const MAddress *ad   MAddress reference to initialize from 
  508.  
  509.  Sets all coordinates and flags equal to those in ad. 
  510.  
  511.  void 
  512.  
  513.  init(MStream *st) 
  514.  
  515.       MStream *st   Input stream 
  516.  
  517.  Sets all coordinates and flags equal to those read from st (see MStream). 
  518.  
  519.  void 
  520.  
  521.  
  522. ΓòÉΓòÉΓòÉ 2.1.2. Reading and writing an MAddress instance ΓòÉΓòÉΓòÉ
  523.  
  524. Open the Contents view and expand this section to see a list of methods. 
  525.  
  526.  
  527. ΓòÉΓòÉΓòÉ 2.1.2.1. MAddress::read() ΓòÉΓòÉΓòÉ
  528.  
  529. read(MStream *st) 
  530.  
  531.       MStream *st   Input stream 
  532.  
  533.  Sets all coordinates and flags equal to those read from st. The stream must 
  534.  have been written to via MAddress::write() for this to work (see MStream). 
  535.  
  536.  void 
  537.  
  538.  
  539. ΓòÉΓòÉΓòÉ 2.1.2.2. MAddress::write() ΓòÉΓòÉΓòÉ
  540.  
  541. write(MStream *st) const 
  542.  
  543.       MStream *st   Output stream 
  544.  
  545.  Outputs the MAddress instance to st (see MStream). 
  546.  
  547.  void 
  548.  
  549.  
  550. ΓòÉΓòÉΓòÉ 2.1.3. Retrieving information about an MAddress instance ΓòÉΓòÉΓòÉ
  551.  
  552. Open the Contents view and expand this section to see a list of methods. 
  553.  
  554.  
  555. ΓòÉΓòÉΓòÉ 2.1.3.1. MAddress::getAbsRow() ΓòÉΓòÉΓòÉ
  556.  
  557. getAbsRow() const 
  558.  
  559. Returns 1 if the row is an absolute reference, 0 otherwise. 
  560.  
  561. int 
  562.  
  563.  
  564. ΓòÉΓòÉΓòÉ 2.1.3.2. MAddress::getAbsCol() ΓòÉΓòÉΓòÉ
  565.  
  566. getAbsCol() const 
  567.  
  568. Returns 1 if the column is an absolute reference, 0 otherwise. 
  569.  
  570. int 
  571.  
  572.  
  573. ΓòÉΓòÉΓòÉ 2.1.3.3. MAddress::getAbsLayer() ΓòÉΓòÉΓòÉ
  574.  
  575. getAbsLayer() const 
  576.  
  577. Returns 1 if the layer is an absolute reference, 0 otherwise. 
  578.  
  579. int 
  580.  
  581.  
  582. ΓòÉΓòÉΓòÉ 2.1.3.4. MAddress::getCol() ΓòÉΓòÉΓòÉ
  583.  
  584. getCol() const 
  585.  
  586. Returns column coordinate. 
  587.  
  588. int 
  589.  
  590.  
  591. ΓòÉΓòÉΓòÉ 2.1.3.5. MAddress::getRow() ΓòÉΓòÉΓòÉ
  592.  
  593. getRow() const 
  594.  
  595. Returns row coordinate. 
  596.  
  597. int 
  598.  
  599.  
  600. ΓòÉΓòÉΓòÉ 2.1.3.6. MAddress::getLayer() ΓòÉΓòÉΓòÉ
  601.  
  602. getLayer() const 
  603.  
  604. Returns layer coordinate. 
  605.  
  606. int 
  607.  
  608.  
  609. ΓòÉΓòÉΓòÉ 2.1.3.7. MAddress::isNull() ΓòÉΓòÉΓòÉ
  610.  
  611. isNull() const 
  612.  
  613. Returns 1 if null-address flag is set, 0 otherwise. 
  614.  
  615. int 
  616.  
  617.  
  618. ΓòÉΓòÉΓòÉ 2.1.3.8. MAddress::inRange() ΓòÉΓòÉΓòÉ
  619.  
  620. inRange(const MAddress *ul, const MAddress *lr) const 
  621.  
  622.       const MAddress *ul   Upper-left corner of the range 
  623.  
  624.       const MAddress *lr   Lower-right corner of the range 
  625.  
  626.  Given two corners of a range, determines whether the current MAddress instance 
  627.  is within that range. The range can be three-dimensional - that is, ul and lr 
  628.  can be on different layers. 
  629.  
  630.  If null-address flag is set for this instance or for ul, returns 0. 
  631.  
  632.  If null-address flag is set for lr: 
  633.  
  634.     If this instance is equal to ul, returns 1; otherwise returns 0. 
  635.  
  636.  If all the addresses are valid: 
  637.  
  638.     Returns 1 if cell is within range, 0 otherwise. 
  639.  
  640.  For example, if ul has row 3, column 4, and layer 2 and lr has row 6, column 
  641.  7, and layer 5, then inRange(ul, lr) will return 1 if the current MAddress 
  642.  instance is anywhere in the range [C]E4:[F]H7. 
  643.  
  644.  int 
  645.  
  646.  
  647. ΓòÉΓòÉΓòÉ 2.1.3.9. MAddress::toStr() ΓòÉΓòÉΓòÉ
  648.  
  649. toStr(char *s, int lay = -1) const 
  650.  
  651.       char *s   Buffer to store string form of address 
  652.  
  653.       int lay   Include layer? -1 for yes, 0 otherwise. Defaults to -1 
  654.  
  655.  Creates a string representation of this address, in one of the following 
  656.  forms: 
  657.  
  658.  [<layerLabel>]<colLabel><rowLabel> (if lay is -1, or if lay is different from 
  659.  layer coordinate, or if layer reference is absolute) 
  660.  
  661.  <colLabel><rowLabel> (otherwise) 
  662.  
  663.  ...where layerLabel and colLabel are alphabetical (i.e.; 0 ="A", 1 = "B", 
  664.  etc.), rowLabel is numeric and 1-based (i.e.; 0 =1, 1 =2, etc.), and each is 
  665.  preceded with a $ if the associated relative flag is false (see also 
  666.  MMesaModel::adToStr() ). 
  667.  
  668.  Some examples: 
  669.  
  670.  If layer coordinate is 0, row coordinate is 1, column coordinate is 2, 
  671.  relative row and relative column flags are false, and relative layer is true, 
  672.  then toStr(string, 0) will set string to $C$2. 
  673.  
  674.  If layer coordinate is 0, row coordinate is 1, column coordinate is 2, and all 
  675.  the relative flags are false, then toStr(string, 0) will set string to 
  676.  [$A]$C$2. 
  677.  
  678.  void 
  679.  
  680.  
  681. ΓòÉΓòÉΓòÉ 2.1.4. Changing values in an MAddress instance ΓòÉΓòÉΓòÉ
  682.  
  683. Open the Contents view and expand this section to see a list of methods. 
  684.  
  685.  
  686. ΓòÉΓòÉΓòÉ 2.1.4.1. MAddress::doMerge() ΓòÉΓòÉΓòÉ
  687.  
  688. doMerge(const MAddress *) 
  689.  
  690.       const MAddress *   Absolute address of the cell from which to dereference 
  691.       the current MAddress instance. 
  692.  
  693.  Sets the layer coordinate, row coordinate, and column coordinate for the 
  694.  current instance to the sum of the existing values and the corresponding 
  695.  values in the address passed in, and sets all relative flags false. 
  696.  
  697.  For example, if a user enters in cell [A]B1 the formula =C2, this is 
  698.  interpreted as a relative reference - that is, an MAddress instance with layer 
  699.  coordinate 0, row coordinate 1, column coordinate 1, and all relative flags 
  700.  true (call it this). 
  701.  
  702.  When the cell's value is calculated, doMerge(base) is performed on this, where 
  703.  base is the absolute address of cell [A]B1 - that is, an MAddress instance 
  704.  with layer coordinate 0, row coordinate 0, column coordinate 1, and all 
  705.  relative flags false. 
  706.  
  707.  Subsequently, this has layer coordinate 0, row coordinate 1, column coordinate 
  708.  2, and all relative flags false - that is, this now refers to cell [$A]$C$2, 
  709.  which is precisely what was intended. 
  710.  
  711.  void 
  712.  
  713.  
  714. ΓòÉΓòÉΓòÉ 2.1.4.2. MAddress::makeAbs() ΓòÉΓòÉΓòÉ
  715.  
  716. makeAbs() 
  717.  
  718. Clears relative flags for row, column and layer, making this instance an 
  719. absolute reference. 
  720.  
  721. void 
  722.  
  723.  
  724. ΓòÉΓòÉΓòÉ 2.1.4.3. MAddress::makeNull() ΓòÉΓòÉΓòÉ
  725.  
  726. makeNull() 
  727.  
  728. Sets null-address flag . 
  729.  
  730. void 
  731.  
  732.  
  733. ΓòÉΓòÉΓòÉ 2.1.4.4. MAddress::offset() ΓòÉΓòÉΓòÉ
  734.  
  735. offset(int r, int c, int l) 
  736.  
  737.       int r   Row offset 
  738.  
  739.       int c   Column offset 
  740.  
  741.       int l   Layer offset 
  742.  
  743.  Increments row, column, and layer coordinates by r, c and l, respectively. 
  744.  Preserves the current status of all relative flags. 
  745.  
  746.  void 
  747.  
  748.  
  749. ΓòÉΓòÉΓòÉ 2.1.4.5. MAddress::offsetRel() ΓòÉΓòÉΓòÉ
  750.  
  751. offsetRel(int r, int c, int l) 
  752.  
  753.       int r   Row offset 
  754.  
  755.       int c   Column offset 
  756.  
  757.       int l   Layer offset 
  758.  
  759.  Increments row, column, and/or layer coordinates by r, c and/or l, 
  760.  respectively. Only coordinates for which the relative flag is true are 
  761.  incremented; others are unchanged. 
  762.  
  763.  For example, if the layer coordinate is 0, the row coordinate is 1, the column 
  764.  coordinate is 2, and relative is set for the row and column but not the layer, 
  765.  then offsetRel(2, 2, 2) will change the row coordinate to 3 and the column 
  766.  coordinate to 4, leaving the layer coordinate untouched. 
  767.  
  768.  void 
  769.  
  770.  
  771. ΓòÉΓòÉΓòÉ 2.1.4.6. MAddress::offsetAbs() ΓòÉΓòÉΓòÉ
  772.  
  773. offsetAbs(int r, int c, int l) 
  774.  
  775.       int r   Row offset 
  776.  
  777.       int c   Column offset 
  778.  
  779.       int l   Layer offset 
  780.  
  781.  Increments row, column, and/or layer coordinates by r, c and/or l, 
  782.  respectively. Only coordinates for which the relative flag is false are 
  783.  incremented; others are unchanged. 
  784.  
  785.  For example, if the layer coordinate is 0, the row coordinate is 1, the column 
  786.  coordinate is 2, and relative is set for the layer but not the row or column, 
  787.  then offsetRel(2, 2, 2) will change the row coordinate to 3 and the column 
  788.  coordinate to 4, leaving the layer coordinate untouched. 
  789.  
  790.  void 
  791.  
  792.  
  793. ΓòÉΓòÉΓòÉ 2.1.4.7. MAddress::set() ΓòÉΓòÉΓòÉ
  794.  
  795. set(const MAddress *ad) 
  796.  
  797.       const MAddress *ad    Address to set to. 
  798.  
  799.  Sets all coordinates and flags equal to those in ad. 
  800.  
  801.  void 
  802.  
  803.  set(int r, int c, int l) 
  804.  
  805.       int r   New row value 
  806.  
  807.       int c   New column value 
  808.  
  809.       int l   New layer value 
  810.  
  811.  Sets row, column, and layer coordinates equal to r, c, and l, respectively. 
  812.  Clears all relative flags. 
  813.  
  814.  void 
  815.  
  816.  
  817. ΓòÉΓòÉΓòÉ 2.1.4.8. MAddress::setRow() ΓòÉΓòÉΓòÉ
  818.  
  819. setRow(int r) 
  820.  
  821.       int r   New row value 
  822.  
  823.  Sets row coordinate to r, and sets relative row flag. 
  824.  
  825.  void 
  826.  
  827.  
  828. ΓòÉΓòÉΓòÉ 2.1.4.9. MAddress::setCol() ΓòÉΓòÉΓòÉ
  829.  
  830. setCol(int c) 
  831.  
  832.       int c   New column value 
  833.  
  834.  Sets column coordinate to c, and sets relative column flag. 
  835.  
  836.  void 
  837.  
  838.  
  839. ΓòÉΓòÉΓòÉ 2.1.4.10. MAddress::setLayer() ΓòÉΓòÉΓòÉ
  840.  
  841. setLayer(int l) 
  842.  
  843.       int l   New layer value 
  844.  
  845.  Sets layer coordinate to l, and sets relative layer flag. 
  846.  
  847.  void 
  848.  
  849.  
  850. ΓòÉΓòÉΓòÉ 2.1.4.11. MAddress::setRawCol() ΓòÉΓòÉΓòÉ
  851.  
  852. setRawCol(int c) 
  853.  
  854.       int c   New column value 
  855.  
  856.  Sets column coordinate to c, leaves relative column flag unchanged. 
  857.  
  858.  void 
  859.  
  860.  
  861. ΓòÉΓòÉΓòÉ 2.1.4.12. MAddress::setRawLayer() ΓòÉΓòÉΓòÉ
  862.  
  863. setRawLayer(int l) 
  864.  
  865.       int l   New layer value 
  866.  
  867.  Sets layer coordinate to l, leaves relative layer flag unchanged. 
  868.  
  869.  void 
  870.  
  871.  
  872. ΓòÉΓòÉΓòÉ 2.1.4.13. MAddress::setRawRow() ΓòÉΓòÉΓòÉ
  873.  
  874. setRawRow(int r) 
  875.  
  876.       int r   New row value 
  877.  
  878.  Sets row coordinate to r, leaves relative row flag unchanged. 
  879.  
  880.  void 
  881.  
  882.  
  883. ΓòÉΓòÉΓòÉ 2.1.4.14. MAddress::setAbsCol() ΓòÉΓòÉΓòÉ
  884.  
  885. setAbsCol(int c) 
  886.  
  887.       int c   New column value 
  888.  
  889.  Sets row coordinate to c, clears relative column flag. 
  890.  
  891.  void 
  892.  
  893.  
  894. ΓòÉΓòÉΓòÉ 2.1.4.15. MAddress::setAbsLayer() ΓòÉΓòÉΓòÉ
  895.  
  896. setAbsLayer(int l) 
  897.  
  898.       int l   New layer value 
  899.  
  900.  Sets row coordinate to l, clears relative layer flag. 
  901.  
  902.  void 
  903.  
  904.  
  905. ΓòÉΓòÉΓòÉ 2.1.4.16. MAddress::setAbsRow() ΓòÉΓòÉΓòÉ
  906.  
  907. setAbsRow(int r) 
  908.  
  909.       int r   New row value 
  910.  
  911.  Sets row coordinate to r, clears relative row flag. 
  912.  
  913.  void 
  914.  
  915.  
  916. ΓòÉΓòÉΓòÉ 2.1.4.17. MAddress::swapColInfo() ΓòÉΓòÉΓòÉ
  917.  
  918. swapColInfo(MAddress &ad) 
  919.  
  920.       MAddress &ad   Address to swap with 
  921.  
  922.  Swaps the values of the column coordinate and relative column flag in this 
  923.  instance with the corresponding values in ad. 
  924.  
  925.  void 
  926.  
  927.  
  928. ΓòÉΓòÉΓòÉ 2.1.4.18. MAddress::swapLayerInfo() ΓòÉΓòÉΓòÉ
  929.  
  930. swapLayerInfo(MAddress &ad) 
  931.  
  932.       MAddress &ad   Address to swap with 
  933.  
  934.  Swaps the values of the layer coordinate and relative layer flag in this 
  935.  instance with the corresponding values in ad. 
  936.  
  937.  void 
  938.  
  939.  
  940. ΓòÉΓòÉΓòÉ 2.1.4.19. MAddress::swapRowInfo() ΓòÉΓòÉΓòÉ
  941.  
  942. swapRowInfo(MAddress &ad) 
  943.  
  944.       MAddress &ad   Address to swap with 
  945.  
  946.  Swaps the values of the row coordinate and relative row flag in this instance 
  947.  with the corresponding values in ad. 
  948.  
  949.  void 
  950.  
  951.  
  952. ΓòÉΓòÉΓòÉ 2.1.4.20. MAddress::zap() ΓòÉΓòÉΓòÉ
  953.  
  954. zap() 
  955.  
  956. Sets null-address flag to true. 
  957.  
  958. void 
  959.  
  960.  
  961. ΓòÉΓòÉΓòÉ 2.1.5. MAddress operators ΓòÉΓòÉΓòÉ
  962.  
  963. Open the Contents view and expand this section to see a list of methods. 
  964.  
  965.  
  966. ΓòÉΓòÉΓòÉ 2.1.5.1. MAddress::operator==() ΓòÉΓòÉΓòÉ
  967.  
  968. operator== (const MAddress &ad) const 
  969.  
  970.       const MAddress &ad    Address to compare 
  971.  
  972.  Compares the current instance to ad. 
  973.  
  974.  If null-address flag is set for either, returns 0. 
  975.  
  976.  Otherwise, if row, column, and layer coordinates all match (ignoring relative 
  977.  flags), returns 1; if not, returns 0. 
  978.  
  979.  int 
  980.  
  981.  
  982. ΓòÉΓòÉΓòÉ 2.1.5.2. MAddress::operator>() ΓòÉΓòÉΓòÉ
  983.  
  984. operator> (const MAddress &ad) const 
  985.  
  986.       const MAddress &ad   Address to compare to 
  987.  
  988.  Compares the current instance to ad. 
  989.  
  990.  If null-address flag is set for either, returns 0. 
  991.  
  992.  Otherwise, layer coordinates are compared. If layer coordinates are identical, 
  993.  row coordinates are compared; if those are identical then column coordinates 
  994.  are compared. 
  995.  
  996.  Returns 1 if the current instance is greater than ad, 0 otherwise. 
  997.  
  998.  int 
  999.  
  1000.  
  1001. ΓòÉΓòÉΓòÉ 2.1.5.3. MAddress::operator>=() ΓòÉΓòÉΓòÉ
  1002.  
  1003. operator>= (const MAddress &ad) const 
  1004.  
  1005.       const MAddress &ad   Address to compare to 
  1006.  
  1007.  Compares the current instance to ad. 
  1008.  
  1009.  If null-address flag is set for either, returns 0. 
  1010.  
  1011.  Otherwise, layer coordinates are compared. If layer coordinates are identical, 
  1012.  row coordinates are compared; if those are identical then column coordinates 
  1013.  are compared. 
  1014.  
  1015.  Returns 1 if the current instance is greater than ad, 0 otherwise. 
  1016.  
  1017.  int 
  1018.  
  1019.  
  1020. ΓòÉΓòÉΓòÉ 2.1.5.4. MAddress::operator<() ΓòÉΓòÉΓòÉ
  1021.  
  1022. operator< (const MAddress &ad) const 
  1023.  
  1024.       const MAddress &ad   Address to compare to 
  1025.  
  1026.  Compares the current instance to ad. 
  1027.  
  1028.  If null-address flag is set for either, returns 0. 
  1029.  
  1030.  Otherwise, layer coordinates are compared. If layer coordinates are identical, 
  1031.  row coordinates are compared; if those are identical then column coordinates 
  1032.  are compared. 
  1033.  
  1034.  Returns 1 if the current address is less than ad, 0 otherwise. 
  1035.  
  1036.  int 
  1037.  
  1038.  
  1039. ΓòÉΓòÉΓòÉ 2.1.5.5. MAddress::operator<=() ΓòÉΓòÉΓòÉ
  1040.  
  1041. operator<= (const MAddress &ad) const 
  1042.  
  1043.       const MAddress &ad   Address to compare to 
  1044.  
  1045.  Compares the current instance to ad. 
  1046.  
  1047.  If null-address flag is set for either, returns 0. 
  1048.  
  1049.  Otherwise, layer coordinates are compared. If layer coordinates are identical, 
  1050.  row coordinates are compared; if those are identical then column coordinates 
  1051.  are compared. 
  1052.  
  1053.  Returns 1 if the current address is less than or equal to ad, 0 otherwise. 
  1054.  
  1055.  int 
  1056.  
  1057.  
  1058. ΓòÉΓòÉΓòÉ 2.1.5.6. MAddress::operator!=() ΓòÉΓòÉΓòÉ
  1059.  
  1060. operator!= (const MAddress &ad) const 
  1061.  
  1062.       const MAddress &ad   Address to compare to. 
  1063.  
  1064.  Compares the current instance to ad. 
  1065.  
  1066.  If null-address flag is set for either, returns 0. 
  1067.  
  1068.  Otherwise, if row, column, and layer coordinates all match (ignoring relative 
  1069.  flags), returns 0; if not, returns 1. 
  1070.  
  1071.  int 
  1072.  
  1073.  
  1074. ΓòÉΓòÉΓòÉ 2.2. MClipStream ΓòÉΓòÉΓòÉ
  1075.  
  1076. clipstream.h is the source file for this class. 
  1077.  
  1078. This class inherits from MStream 
  1079.  
  1080. Handles input and output to the OS/2 clipboard. 
  1081.  
  1082. MClipStream can read and write ASCII text, RTF text, OS/2 bitmaps (BMP), OS/2 
  1083. metafile pictures (MET), and Mesa 2's internal format. When cell contents are 
  1084. copied or cut to the clipboard, all text formats (e.g; ASCII, RTF and Mesa 2) 
  1085. are usually placed there simultaneously, allowing a selection to be made when 
  1086. data is being read from the clipboard. Additionally, DDE information is 
  1087. generally placed on the clipboard at the same time, allowing DDE-enabled 
  1088. applications (including Mesa 2) to create a DDE link via a "Paste Link" 
  1089. command. 
  1090.  
  1091. Each MClipStream instance maintains several memory buffers in which to store 
  1092. the various formats it supports (ASCII, DDE, RTF, OS/2 BMP, MET, and Mesa 2's 
  1093. internal format), as well as shared-memory buffer to send and/or receive 
  1094. information from the clipboard. It also maintains a RESETANDSTUFF flag, which 
  1095. determines whether buffer values are written to the clipboard when the instance 
  1096. is destroyed; and a DONTSTUFF flag, which determines whether the temporary 
  1097. buffers are freed when the instance is destroyed. 
  1098.  
  1099. Like all other MStream subclasses, it also keeps track of current and 
  1100. next-element stream positions, allocates storage for any errors that may occur, 
  1101. and maintains a version number. For more information, see "MStream". 
  1102.  
  1103.  
  1104. ΓòÉΓòÉΓòÉ 2.2.1. Creating, destroying, and initializing an MClipStream instance ΓòÉΓòÉΓòÉ
  1105.  
  1106. Open the Contents view and expand this section to see a list of methods. 
  1107.  
  1108.  
  1109. ΓòÉΓòÉΓòÉ 2.2.1.1. MClipStream::MClipStream() ΓòÉΓòÉΓòÉ
  1110.  
  1111. MClipStream(HAB) 
  1112.  
  1113.       HAB   Handle to the application's anchor block. 
  1114.  
  1115.  Opens the clipboard for use by this process/thread, queries the clipboard data 
  1116.  and associates the various buffers with that data. 
  1117.  
  1118.  void 
  1119.  
  1120.  
  1121. ΓòÉΓòÉΓòÉ 2.2.1.2. MClipStream::~MClipStream() ΓòÉΓòÉΓòÉ
  1122.  
  1123. ~MClipStream() [virtual] 
  1124.  
  1125. Closes the clipboard and unlocks it. 
  1126.  
  1127. If DONTSTUFF has been set, it frees the various buffers that have been 
  1128. allocated. Otherwise, if RESETANDSTUFF has been set, it clears the clipboard 
  1129. and writes the contents of the various buffers to the appropriate locations in 
  1130. the clipboard. 
  1131.  
  1132. void 
  1133.  
  1134.  
  1135. ΓòÉΓòÉΓòÉ 2.2.1.3. MClipStream::resetClipboard() ΓòÉΓòÉΓòÉ
  1136.  
  1137. resetClipboard() [virtual] 
  1138.  
  1139. Sets RESETANDSTUFF to 1 and zeros all buffers. 
  1140.  
  1141. void 
  1142.  
  1143.  
  1144. ΓòÉΓòÉΓòÉ 2.2.1.4. MClipStream::setDontStuff() ΓòÉΓòÉΓòÉ
  1145.  
  1146. setDontStuff(int i) [virtual] 
  1147.  
  1148.       int i   New value for DONTSTUFF 
  1149.  
  1150.  Sets DONTSTUFF to i. 
  1151.  
  1152.  void 
  1153.  
  1154.  
  1155. ΓòÉΓòÉΓòÉ 2.2.2. Reading from the clipboard ΓòÉΓòÉΓòÉ
  1156.  
  1157. Open the Contents view and expand this section to see a list of methods. 
  1158.  
  1159.  
  1160. ΓòÉΓòÉΓòÉ 2.2.2.1. MClipStream::beginReadLink() ΓòÉΓòÉΓòÉ
  1161.  
  1162. beginReadLink() [virtual] 
  1163.  
  1164. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1165. data into the DDE link buffer. 
  1166.  
  1167. void 
  1168.  
  1169.  
  1170. ΓòÉΓòÉΓòÉ 2.2.2.2. MClipStream::beginReadRTF() ΓòÉΓòÉΓòÉ
  1171.  
  1172. beginReadRTF() [virtual] 
  1173.  
  1174. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1175. data into the RTF buffer. 
  1176.  
  1177. void 
  1178.  
  1179.  
  1180. ΓòÉΓòÉΓòÉ 2.2.2.3. MClipStream::beginReadText() ΓòÉΓòÉΓòÉ
  1181.  
  1182. beginReadText() [virtual] 
  1183.  
  1184. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1185. data into the ASCII buffer. 
  1186.  
  1187. void 
  1188.  
  1189.  
  1190. ΓòÉΓòÉΓòÉ 2.2.2.4. MClipStream::beginReadBitmap() ΓòÉΓòÉΓòÉ
  1191.  
  1192. beginReadBitmap() [virtual] 
  1193.  
  1194. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1195. data into the BMP buffer. 
  1196.  
  1197. void 
  1198.  
  1199.  
  1200. ΓòÉΓòÉΓòÉ 2.2.2.5. MClipStream::beginReadMesa() ΓòÉΓòÉΓòÉ
  1201.  
  1202. beginReadMesa() [virtual] 
  1203.  
  1204. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1205. data into the Mesa-format buffer. 
  1206.  
  1207. void 
  1208.  
  1209.  
  1210. ΓòÉΓòÉΓòÉ 2.2.2.6. MClipStream::beginReadPict() ΓòÉΓòÉΓòÉ
  1211.  
  1212. beginReadPict() [virtual] 
  1213.  
  1214. Sets the shared-memory buffer so that MClipStream::read() will read clipboard 
  1215. data into the MET buffer. 
  1216.  
  1217. void 
  1218.  
  1219.  
  1220. ΓòÉΓòÉΓòÉ 2.2.2.7. MClipStream::beginWrite() ΓòÉΓòÉΓòÉ
  1221.  
  1222. beginWrite() [virtual] 
  1223.  
  1224. Allocates shared memory into the shared-memory buffer. 
  1225.  
  1226. void 
  1227.  
  1228.  
  1229. ΓòÉΓòÉΓòÉ 2.2.2.8. MClipStream::endClipRead() ΓòÉΓòÉΓòÉ
  1230.  
  1231. endClipRead() [virtual] 
  1232.  
  1233. Terminates reading from the clipboard. 
  1234.  
  1235. void 
  1236.  
  1237.  
  1238. ΓòÉΓòÉΓòÉ 2.2.2.9. MClipStream::read() ΓòÉΓòÉΓòÉ
  1239.  
  1240. read(void *, int) [virtual] 
  1241.  
  1242.       void *   Buffer into which the clipboard bytes should be copied 
  1243.  
  1244.       int   Number of bytes to be copied 
  1245.  
  1246.  Copies from the clipboard buffer to the buffer provided. 
  1247.  
  1248.  Returns number of bytes actually copied. 
  1249.  
  1250.  int 
  1251.  
  1252.  
  1253. ΓòÉΓòÉΓòÉ 2.2.3. Writing to the clipboard ΓòÉΓòÉΓòÉ
  1254.  
  1255. Open the Contents view and expand this section to see a list of methods. 
  1256.  
  1257.  
  1258. ΓòÉΓòÉΓòÉ 2.2.3.1. MClipStream::endWriteBitmap() ΓòÉΓòÉΓòÉ
  1259.  
  1260. endWriteBitmap() [virtual] 
  1261.  
  1262. Lets the clipboard know that the object just placed there is in BMP format. 
  1263.  
  1264. void 
  1265.  
  1266.  
  1267. ΓòÉΓòÉΓòÉ 2.2.3.2. MClipStream::endWriteLink() ΓòÉΓòÉΓòÉ
  1268.  
  1269. endWriteLink() [virtual] 
  1270.  
  1271. Lets the clipboard know that the object just placed there is in DDE link 
  1272. format. 
  1273.  
  1274. void 
  1275.  
  1276.  
  1277. ΓòÉΓòÉΓòÉ 2.2.3.3. MClipStream::endWriteRTF() ΓòÉΓòÉΓòÉ
  1278.  
  1279. endWriteRTF() [virtual] 
  1280.  
  1281. Lets the clipboard know that the object just placed there is in RTF format. 
  1282.  
  1283. void 
  1284.  
  1285.  
  1286. ΓòÉΓòÉΓòÉ 2.2.3.4. MClipStream::endWriteMesa() ΓòÉΓòÉΓòÉ
  1287.  
  1288. endWriteMesa() [virtual] 
  1289.  
  1290. Lets the clipboard know that the object just placed there is in Mesa format. 
  1291.  
  1292. void 
  1293.  
  1294.  
  1295. ΓòÉΓòÉΓòÉ 2.2.3.5. MClipStream::endWritePict() ΓòÉΓòÉΓòÉ
  1296.  
  1297. endWritePict() [virtual] 
  1298.  
  1299. Lets the clipboard know that the object just placed there is in MET format. 
  1300.  
  1301. void 
  1302.  
  1303.  
  1304. ΓòÉΓòÉΓòÉ 2.2.3.6. MClipStream::endWriteText() ΓòÉΓòÉΓòÉ
  1305.  
  1306. endWriteText() [virtual] 
  1307.  
  1308. Lets the clipboard know that the object just placed there is in ASCII format. 
  1309.  
  1310. void 
  1311.  
  1312.  
  1313. ΓòÉΓòÉΓòÉ 2.2.3.7. MClipStream::write() ΓòÉΓòÉΓòÉ
  1314.  
  1315. write(const void *, int) [virtual] 
  1316.  
  1317.       const void *buf   Buffer to copy from 
  1318.  
  1319.       int n   Number of bytes to copy from the buffer to the clipboard. 
  1320.  
  1321.  Attempts to copy n bytes from buf to the clipboard memory buffer. Returns 
  1322.  number of bytes written. 
  1323.  
  1324.  int 
  1325.  
  1326.  
  1327. ΓòÉΓòÉΓòÉ 2.2.4. Querying the clipboard ΓòÉΓòÉΓòÉ
  1328.  
  1329. Open the Contents view and expand this section to see a list of methods. 
  1330.  
  1331.  
  1332. ΓòÉΓòÉΓòÉ 2.2.4.1. MClipStream::hasBitmap() ΓòÉΓòÉΓòÉ
  1333.  
  1334. hasBitmap() [virtual] 
  1335.  
  1336. Returns 1 if the clipboard contents are in BMP format, 0 otherwise. 
  1337.  
  1338. int 
  1339.  
  1340.  
  1341. ΓòÉΓòÉΓòÉ 2.2.4.2. MClipStream::hasLink() ΓòÉΓòÉΓòÉ
  1342.  
  1343. hasLink() [virtual] 
  1344.  
  1345. Returns 1 if the clipboard contents are in DDE link format, 0 otherwise. 
  1346.  
  1347. int 
  1348.  
  1349.  
  1350. ΓòÉΓòÉΓòÉ 2.2.4.3. MClipStream::hasRTF() ΓòÉΓòÉΓòÉ
  1351.  
  1352. hasRTF() [virtual] 
  1353.  
  1354. Returns 1 if the clipboard contents are in RTF, 0 otherwise. 
  1355.  
  1356. int 
  1357.  
  1358.  
  1359. ΓòÉΓòÉΓòÉ 2.2.4.4. MClipStream::hasMesa() ΓòÉΓòÉΓòÉ
  1360.  
  1361. hasMesa() [virtual] 
  1362.  
  1363. Returns 1 if the clipboard contents are in Mesa format, 0 otherwise. 
  1364.  
  1365. int 
  1366.  
  1367.  
  1368. ΓòÉΓòÉΓòÉ 2.2.4.5. MClipStream::hasPict() ΓòÉΓòÉΓòÉ
  1369.  
  1370. hasPict() [virtual] 
  1371.  
  1372. Returns 1 if the clipboard contents are in MET format, 0 otherwise. 
  1373.  
  1374. int 
  1375.  
  1376.  
  1377. ΓòÉΓòÉΓòÉ 2.2.4.6. MClipStream::hasText() ΓòÉΓòÉΓòÉ
  1378.  
  1379. hasText() [virtual] 
  1380.  
  1381. Returns 1 if the clipboard contents are in ASCII format, 0 otherwise. 
  1382.  
  1383. int 
  1384.  
  1385.  
  1386. ΓòÉΓòÉΓòÉ 2.2.5. Retrieving information about MClipStream buffers ΓòÉΓòÉΓòÉ
  1387.  
  1388. Open the Contents view and expand this section to see a list of methods. 
  1389.  
  1390.  
  1391. ΓòÉΓòÉΓòÉ 2.2.5.1. MClipStream::getLinkPtr() ΓòÉΓòÉΓòÉ
  1392.  
  1393. getLinkPtr() [virtual] 
  1394.  
  1395. Returns pointer to DDE link buffer. 
  1396.  
  1397. const char * 
  1398.  
  1399.  
  1400. ΓòÉΓòÉΓòÉ 2.2.5.2. MClipStream::getMesaPtr() ΓòÉΓòÉΓòÉ
  1401.  
  1402. getMesaPtr(int &l) [virtual] 
  1403.  
  1404.       int &l   Storage variable. 
  1405.  
  1406.  Stores the allocated size of the Mesa format buffer and returns pointer to 
  1407.  Mesa format buffer. 
  1408.  
  1409.  const char * 
  1410.  
  1411.  
  1412. ΓòÉΓòÉΓòÉ 2.2.5.3. MClipStream::getRTFPtr() ΓòÉΓòÉΓòÉ
  1413.  
  1414. getRTFPtr() [virtual] 
  1415.  
  1416. Returns pointer to RTF buffer. 
  1417.  
  1418. const char * 
  1419.  
  1420.  
  1421. ΓòÉΓòÉΓòÉ 2.2.5.4. MClipStream::getPos() ΓòÉΓòÉΓòÉ
  1422.  
  1423. getPos() [virtual] 
  1424.  
  1425. Returns current position within the stream buffer. 
  1426.  
  1427. int 
  1428.  
  1429.  
  1430. ΓòÉΓòÉΓòÉ 2.2.5.5. MClipStream::getTextPtr() ΓòÉΓòÉΓòÉ
  1431.  
  1432. getTextPtr() [virtual] 
  1433.  
  1434. Returns pointer to ASCII buffer. 
  1435.  
  1436. const char * 
  1437.  
  1438.  
  1439. ΓòÉΓòÉΓòÉ 2.2.6. Navigating within the stream ΓòÉΓòÉΓòÉ
  1440.  
  1441. Open the Contents view and expand this section to see a list of methods. 
  1442.  
  1443.  
  1444. ΓòÉΓòÉΓòÉ 2.2.6.1. MClipStream::getStreamLen() ΓòÉΓòÉΓòÉ
  1445.  
  1446. getStreamLen() [virtual] 
  1447.  
  1448. Returns number of valid bytes in the stream. 
  1449.  
  1450. int 
  1451.  
  1452.  
  1453. ΓòÉΓòÉΓòÉ 2.2.6.2. MClipStream::isEOF() ΓòÉΓòÉΓòÉ
  1454.  
  1455. isEOF() [virtual] 
  1456.  
  1457. Returns 1 if at the end of stream, 0 otherwise. 
  1458.  
  1459. int 
  1460.  
  1461.  
  1462. ΓòÉΓòÉΓòÉ 2.2.6.3. MClipStream::seek() ΓòÉΓòÉΓòÉ
  1463.  
  1464. seek(int pos) [virtual] 
  1465.  
  1466.       int pos   Position to move to 
  1467.  
  1468.  Attempts to set the current location within the stream to pos. Returns new 
  1469.  location within the stream. 
  1470.  
  1471.  int 
  1472.  
  1473.  
  1474. ΓòÉΓòÉΓòÉ 2.3. MColor ΓòÉΓòÉΓòÉ
  1475.  
  1476. color.h is the source file for this class. 
  1477.  
  1478. Stores color and pattern information for a single color instance. 
  1479.  
  1480. For example, if a cell in Mesa has a red background and blue text, there are at 
  1481. least two MColor instances associated with that cell - a "red" MColor, which is 
  1482. associated with the background, and a "blue" MColor, which is associated with 
  1483. the text. Which MColor is associated with what aspect of the cell is controlled 
  1484. by the MFormat class (see MFormat). 
  1485.  
  1486. Every MColor instance contains two 24-bit RGB color values (foreground and 
  1487. background) 
  1488.  
  1489. Given values of red, green and blue between 0 and 255, use set(red, green, 
  1490. blue) to assign that color value to an existing MColor instance (see set(int, 
  1491. int, int)). Or, use set(colorValue), where colorValue is either a predefined 
  1492. color constant like MCOL_RED (see "Color constants") or is calculated using the 
  1493. following equation: 
  1494.  
  1495. (16777216 * pattern) + (red * 65536) + (green * 256) + blue 
  1496.  
  1497. ...where pattern is an optional index into array of known patterns. If pattern 
  1498. is 0, the color is a solid color; currently, this is the only pattern defined 
  1499. within Mesa DOK. 
  1500.  
  1501. The background color is only used if the pattern is not solid (and is therefore 
  1502. currently unused within Mesa DOK). For example, an MColor instance representing 
  1503. red with white stripes would have its color set to MCOL_WHITE and its 
  1504. background color set to MCOL_RED. 
  1505.  
  1506.  
  1507. ΓòÉΓòÉΓòÉ 2.3.1. Creating, destroying, and initializing an MColor instance ΓòÉΓòÉΓòÉ
  1508.  
  1509. Open the Contents view and expand this section to see a list of methods. 
  1510.  
  1511.  
  1512. ΓòÉΓòÉΓòÉ 2.3.1.1. MColor::free() ΓòÉΓòÉΓòÉ
  1513.  
  1514. free() 
  1515.  
  1516. Deallocates any resources used. 
  1517.  
  1518. void 
  1519.  
  1520.  
  1521. ΓòÉΓòÉΓòÉ 2.3.1.2. MColor::init() ΓòÉΓòÉΓòÉ
  1522.  
  1523. init(MStream *st) 
  1524.  
  1525.       MStream *st   Input stream 
  1526.  
  1527.  Reads all color and pattern values from st (see MStream). 
  1528.  
  1529.  void 
  1530.  
  1531.  init(int t) 
  1532.  
  1533.       int t   New foreground color value 
  1534.  
  1535.  Sets color to t and clears background color. 
  1536.  
  1537.  void 
  1538.  
  1539.  init(const MColor *c) 
  1540.  
  1541.       const MColor *c   MColor instance to initialize from 
  1542.  
  1543.  Sets all color and pattern values equal to the equivalent components of c. 
  1544.  
  1545.  void 
  1546.  
  1547.  init() 
  1548.  
  1549.  Initializes this instance to default values. 
  1550.  
  1551.  void 
  1552.  
  1553.  
  1554. ΓòÉΓòÉΓòÉ 2.3.2. Reading and writing an MColor instance ΓòÉΓòÉΓòÉ
  1555.  
  1556. Open the Contents view and expand this section to see a list of methods. 
  1557.  
  1558.  
  1559. ΓòÉΓòÉΓòÉ 2.3.2.1. MColor::read() ΓòÉΓòÉΓòÉ
  1560.  
  1561. read(MStream *st) 
  1562.  
  1563.       MStream *st   Input stream 
  1564.  
  1565.  Reads all color and pattern values from st (see MStream). 
  1566.  
  1567.  void 
  1568.  
  1569.  
  1570. ΓòÉΓòÉΓòÉ 2.3.2.2. MColor::write() ΓòÉΓòÉΓòÉ
  1571.  
  1572. write(MStream *st) const 
  1573.  
  1574.       MStream *st   Output stream 
  1575.  
  1576.  Writes all color and pattern values out to st (see MStream). 
  1577.  
  1578.  void 
  1579.  
  1580.  
  1581. ΓòÉΓòÉΓòÉ 2.3.3. Retrieving information about an MColor instance ΓòÉΓòÉΓòÉ
  1582.  
  1583. Open the Contents view and expand this section to see a list of methods. 
  1584.  
  1585.  
  1586. ΓòÉΓòÉΓòÉ 2.3.3.1. MColor::getRGB() ΓòÉΓòÉΓòÉ
  1587.  
  1588. getRGB() 
  1589.  
  1590. Returns the color value, (red * 65536) + (green * 256) + blue. (Compare with 
  1591. MColor::getColor().) 
  1592.  
  1593. int 
  1594.  
  1595.  
  1596. ΓòÉΓòÉΓòÉ 2.3.3.2. MColor::getBlue() ΓòÉΓòÉΓòÉ
  1597.  
  1598. getBlue() 
  1599.  
  1600. Returns the blue component of the RGB color. 
  1601.  
  1602. unsigned int 
  1603.  
  1604.  
  1605. ΓòÉΓòÉΓòÉ 2.3.3.3. MColor::getColorFromPalette() ΓòÉΓòÉΓòÉ
  1606.  
  1607. getColorFromPalette(MColor *palette, int numInPalette) 
  1608.  
  1609.       MColor *palette   Array of MColors to be selected from 
  1610.  
  1611.       int numInPalette   Size of palette 
  1612.  
  1613.  Returns an index into palette pointing to the color there that matches the 
  1614.  current color most closely. "Close match" is calculated by adding the absolute 
  1615.  differences between the red, green and blue values; the smallest total 
  1616.  difference wins. 
  1617.  
  1618.  int 
  1619.  
  1620.  
  1621. ΓòÉΓòÉΓòÉ 2.3.3.4. MColor::getGreen() ΓòÉΓòÉΓòÉ
  1622.  
  1623. getGreen() 
  1624.  
  1625. Returns the green component of the RGB color. 
  1626.  
  1627. unsigned int 
  1628.  
  1629.  
  1630. ΓòÉΓòÉΓòÉ 2.3.3.5. MColor::getRed() ΓòÉΓòÉΓòÉ
  1631.  
  1632. getRed() 
  1633.  
  1634. Returns the red component of the RGB color. 
  1635.  
  1636. unsigned int 
  1637.  
  1638.  
  1639. ΓòÉΓòÉΓòÉ 2.3.3.6. MColor::getColor() ΓòÉΓòÉΓòÉ
  1640.  
  1641. getColor() 
  1642.  
  1643. Returns the color-and-pattern value, (16777216 * pattern) + (red * 65536) + 
  1644. (green * 256) + blue. Note that if the pattern is solid (i.e.; if pattern 
  1645. equals 0), this is identical to the color value (see MColor::getRGB()). 
  1646.  
  1647. int 
  1648.  
  1649.  
  1650. ΓòÉΓòÉΓòÉ 2.3.3.7. MColor::getPattern() ΓòÉΓòÉΓòÉ
  1651.  
  1652. getPattern() 
  1653.  
  1654. Returns pattern value (index into an array of known patterns; currently always 
  1655. 0). 
  1656.  
  1657. int 
  1658.  
  1659.  
  1660. ΓòÉΓòÉΓòÉ 2.3.3.8. MColor::getBkgRGB() ΓòÉΓòÉΓòÉ
  1661.  
  1662. getBkgRGB() 
  1663.  
  1664. Returns background color value, (red * 65536) + (green * 256) + blue. This 
  1665. value is not currently used within Mesa DOK. 
  1666.  
  1667. int 
  1668.  
  1669.  
  1670. ΓòÉΓòÉΓòÉ 2.3.3.9. MColor::getBkgPattern() ΓòÉΓòÉΓòÉ
  1671.  
  1672. getBkgPattern() 
  1673.  
  1674. Returns backgroundpattern value (index into an array of known patterns; 
  1675. currently always 0). 
  1676.  
  1677. int 
  1678.  
  1679.  
  1680. ΓòÉΓòÉΓòÉ 2.3.4. Changing values in an MColor instance ΓòÉΓòÉΓòÉ
  1681.  
  1682. Open the Contents view and expand this section to see a list of methods. 
  1683.  
  1684.  
  1685. ΓòÉΓòÉΓòÉ 2.3.4.1. MColor::average() ΓòÉΓòÉΓòÉ
  1686.  
  1687. average(MColor col) 
  1688.  
  1689.       MColor col   Color instance to average with 
  1690.  
  1691.  Sets current color to the average of the current color and col. Clears pattern 
  1692.  and background color. 
  1693.  
  1694.  void 
  1695.  
  1696.  
  1697. ΓòÉΓòÉΓòÉ 2.3.4.2. MColor::set() ΓòÉΓòÉΓòÉ
  1698.  
  1699. set(int c) 
  1700.  
  1701.       int c   New color-and-pattern value 
  1702.  
  1703.  Sets color and pattern values to c, and resets the background color. 
  1704.  
  1705.  c should be either a predefined color constant or a color-and-pattern value 
  1706.  constructed as follows: (16777216 * pattern) + (red * 65536) + (green * 256) + 
  1707.  blue (see "Color constants") . 
  1708.  
  1709.  void 
  1710.  
  1711.  set(MColor) 
  1712.  
  1713.       MColor   MColor instance to take values from 
  1714.  
  1715.  Sets the color values to those of the MColor instance passed in. 
  1716.  
  1717.  void 
  1718.  
  1719.  set(const MColor *) 
  1720.  
  1721.       const MColor *   MColor instance to take values from 
  1722.  
  1723.  Sets the color values to those of the instance passed in. 
  1724.  
  1725.  void 
  1726.  
  1727.  set(int, int, int) 
  1728.  
  1729.       int   Red value 
  1730.  
  1731.       int   Green value 
  1732.  
  1733.       int   Blue value 
  1734.  
  1735.  Sets the color value to the RGB values passed in; sets the pattern component 
  1736.  to 0, and the background color to 0. 
  1737.  
  1738.  void 
  1739.  
  1740.  set(const char *colorName) 
  1741.  
  1742.       const char *colorName   Null-terminated string for a named color 
  1743.  
  1744.  Sets color value to the named color (see "Color constants" for a list of valid 
  1745.  color names). If colorName is not a valid name, sets color black. 
  1746.  
  1747.  Returns 1 if colorName is a valid color name, 0 otherwise. 
  1748.  
  1749.  int 
  1750.  
  1751.  
  1752. ΓòÉΓòÉΓòÉ 2.3.5. MColor operators ΓòÉΓòÉΓòÉ
  1753.  
  1754. Open the Contents view and expand this section to see a list of methods. 
  1755.  
  1756.  
  1757. ΓòÉΓòÉΓòÉ 2.3.5.1. MColor::operator==() ΓòÉΓòÉΓòÉ
  1758.  
  1759. operator==(const MColor &) const 
  1760.  
  1761.       const MColor &c    Color to compare to 
  1762.  
  1763.  Returns 1 if current color and pattern values (foreground and background) are 
  1764.  equal to those of c; 0 otherwise. 
  1765.  
  1766.  int 
  1767.  
  1768.  
  1769. ΓòÉΓòÉΓòÉ 2.3.5.2. MColor::operator!=() ΓòÉΓòÉΓòÉ
  1770.  
  1771. operator!=(const MColor &) const 
  1772.  
  1773.       const MColor &    Color to compare to 
  1774.  
  1775.  Returns 0 if current color and pattern values (foreground and background) are 
  1776.  equal to those of c; 1 otherwise. 
  1777.  
  1778.  int 
  1779.  
  1780.  
  1781. ΓòÉΓòÉΓòÉ 2.3.5.3. MColor::operator>() ΓòÉΓòÉΓòÉ
  1782.  
  1783. operator>(const MColor &c) const 
  1784.  
  1785.       const MColor &c    Color to compare to 
  1786.  
  1787.  Compares current color and pattern values (foreground and background) to those 
  1788.  of c. The following precedence order is used: 
  1789.  
  1790.     foreground pattern 
  1791.  
  1792.     foreground red 
  1793.  
  1794.     foreground greed 
  1795.  
  1796.     foreground blue 
  1797.  
  1798.     background pattern 
  1799.  
  1800.     background red 
  1801.  
  1802.     background greed 
  1803.  
  1804.     background blue 
  1805.  
  1806.  Returns 1 if the current instance is greater than c, 0 otherwise. 
  1807.  
  1808.  int 
  1809.  
  1810.  
  1811. ΓòÉΓòÉΓòÉ 2.3.5.4. MColor::operator>=() ΓòÉΓòÉΓòÉ
  1812.  
  1813. operator>=(const MColor &) const 
  1814.  
  1815.       const MColor &c    Color to compare to 
  1816.  
  1817.  Compares current color and pattern values (foreground and background) to those 
  1818.  of c. The following precedence order is used: 
  1819.  
  1820.     foreground pattern 
  1821.  
  1822.     foreground red 
  1823.  
  1824.     foreground greed 
  1825.  
  1826.     foreground blue 
  1827.  
  1828.     background pattern 
  1829.  
  1830.     background red 
  1831.  
  1832.     background greed 
  1833.  
  1834.     background blue 
  1835.  
  1836.  Returns 1 if the current instance is greater than or equal to c, 0 otherwise. 
  1837.  
  1838.  int 
  1839.  
  1840.  
  1841. ΓòÉΓòÉΓòÉ 2.3.5.5. MColor::operator<() ΓòÉΓòÉΓòÉ
  1842.  
  1843. operator<(const MColor &c) const 
  1844.  
  1845.       const MColor &c    Color to compare to 
  1846.  
  1847.  Compares current color and pattern values (foreground and background) to those 
  1848.  of c. The following precedence order is used: 
  1849.  
  1850.     foreground pattern 
  1851.  
  1852.     foreground red 
  1853.  
  1854.     foreground greed 
  1855.  
  1856.     foreground blue 
  1857.  
  1858.     background pattern 
  1859.  
  1860.     background red 
  1861.  
  1862.     background greed 
  1863.  
  1864.     background blue 
  1865.  
  1866.  Returns 1 if the current instance is less than c, 0 otherwise. 
  1867.  
  1868.  int 
  1869.  
  1870.  
  1871. ΓòÉΓòÉΓòÉ 2.3.5.6. MColor::operator<=() ΓòÉΓòÉΓòÉ
  1872.  
  1873. operator<=(const MColor &c) const 
  1874.  
  1875.       const MColor &c    Color to compare to 
  1876.  
  1877.  Compares current color and pattern values (foreground and background) to those 
  1878.  of c. The following precedence order is used: 
  1879.  
  1880.     foreground pattern 
  1881.  
  1882.     foreground red 
  1883.  
  1884.     foreground greed 
  1885.  
  1886.     foreground blue 
  1887.  
  1888.     background pattern 
  1889.  
  1890.     background red 
  1891.  
  1892.     background greed 
  1893.  
  1894.     background blue 
  1895.  
  1896.  Returns 1 if the current instance is less than or equal to c, 0 otherwise. 
  1897.  
  1898.  int 
  1899.  
  1900.  
  1901. ΓòÉΓòÉΓòÉ 2.4. MEditView ΓòÉΓòÉΓòÉ
  1902.  
  1903. editview.h is the source file for this class. 
  1904.  
  1905. This class inherits from MView 
  1906.  
  1907. Implements an edit view: a rectangular region within which text can be edited. 
  1908.  
  1909. Within the Mesa 2 application, an edit view is created whenever the user clicks 
  1910. in the Formula Bar. Within your custom applications, you can create an edit 
  1911. view and place it wherever you like. 
  1912.  
  1913. The edit view keeps track of its current contents and selection. The selection 
  1914. can be a single point, in which case a blinking insertion-point indicator is 
  1915. displayed at that point, or it can be one or more characters, in which case the 
  1916. selected characters are displayed with a gray background. Text entered by the 
  1917. user appears at the current position, replacing the selected characters (if 
  1918. any). The edit view also keeps track of what layer in the model is currently 
  1919. selected. 
  1920.  
  1921. Additionally, the following flags can be set within an MEditView instance: 
  1922.  
  1923.      ISEDITING 
  1924.  
  1925.       Are we currently editing in an edit view? 
  1926.  
  1927.      ISSELECTING 
  1928.  
  1929.       Are we currently selecting a region in the edit view? 
  1930.  
  1931.      JUSTUNDID 
  1932.  
  1933.       Was the most recent operation an undo operation? 
  1934.  
  1935.      BLINKON 
  1936.  
  1937.       Is the insertion point indicator currently being displayed? 
  1938.  
  1939.  It also keeps track of the current context menu and the "superview" window, 
  1940.  just like any other MView subclass (see MView). 
  1941.  
  1942.  
  1943. ΓòÉΓòÉΓòÉ 2.4.1. Creating, destroying, and initializing an MEditView instance ΓòÉΓòÉΓòÉ
  1944.  
  1945. Open the Contents view and expand this section to see a list of methods. 
  1946.  
  1947.  
  1948. ΓòÉΓòÉΓòÉ 2.4.1.1. MEditView::MEditView() ΓòÉΓòÉΓòÉ
  1949.  
  1950. MEditView(MWindow *, int = 0, MMesaModel *mp =0) 
  1951.  
  1952.       MWindow *   Parent window 
  1953.  
  1954.       int   Default is 0 
  1955.  
  1956.       MMesaModel *mp =0   The model associated with the edit view. 
  1957.  
  1958.   Creates an MEditView instance with the values passed in. 
  1959.  
  1960.   void 
  1961.  
  1962.  
  1963. ΓòÉΓòÉΓòÉ 2.4.1.2. MEditView::~MEditView() ΓòÉΓòÉΓòÉ
  1964.  
  1965. ~MEditView() [virtual] 
  1966.  
  1967. Releases any string resources that have been allocated. 
  1968.  
  1969. void 
  1970.  
  1971.  
  1972. ΓòÉΓòÉΓòÉ 2.4.1.3. MEditView::cleanUp() ΓòÉΓòÉΓòÉ
  1973.  
  1974. cleanUp() [virtual] 
  1975.  
  1976. Releases any strings that have been allocated, and passes the cleanUp() method 
  1977. to the parent window. 
  1978.  
  1979. void 
  1980.  
  1981.  
  1982. ΓòÉΓòÉΓòÉ 2.4.1.4. MEditView::setUp() ΓòÉΓòÉΓòÉ
  1983.  
  1984. setUp(const MRect *, int=0) [virtual] 
  1985.  
  1986.       const MRect *   Rectangle to draw in 
  1987.  
  1988.       int   Style flags. Defaults to 0. 
  1989.  
  1990.  Pass-through to MView::setUp(). 
  1991.  
  1992.  Also, sets the cycle time for the blinking of the edit-view cursor, using 
  1993.  MGController::ping(). 
  1994.  
  1995.  void 
  1996.  
  1997.  
  1998. ΓòÉΓòÉΓòÉ 2.4.2. Retrieving information about an MEditView instance ΓòÉΓòÉΓòÉ
  1999.  
  2000. Open the Contents view and expand this section to see a list of methods. 
  2001.  
  2002.  
  2003. ΓòÉΓòÉΓòÉ 2.4.2.1. MEditView::bufferWindow() ΓòÉΓòÉΓòÉ
  2004.  
  2005. bufferWindow() [virtual] 
  2006.  
  2007. Is this window to be buffered (see MWindow::bufferWindow())? 
  2008.  
  2009. Always returns 1. 
  2010.  
  2011. int 
  2012.  
  2013.  
  2014. ΓòÉΓòÉΓòÉ 2.4.2.2. MEditView::findChar() ΓòÉΓòÉΓòÉ
  2015.  
  2016. findChar(int x) [virtual] 
  2017.  
  2018.       int x   Position within the edit view (in pixels) 
  2019.  
  2020.  Finds the character that is displayed at position x within the edit view. 
  2021.  Returns position of that character within the edit view contents. 
  2022.  
  2023.  For example, if the edit view contains the alphabet 
  2024.  (ABCDEFGHIJKLMNOPQRSTUVWXYZ) in a fixed-width font where each character is 8 
  2025.  pixels wide, then findChar(6) will return 0 (the position of A in the 
  2026.  alphabet) and findChar(70) will return 9 (the position of I in the alphabet). 
  2027.  
  2028.  int 
  2029.  
  2030.  
  2031. ΓòÉΓòÉΓòÉ 2.4.2.3. MEditView::getCurLayer() ΓòÉΓòÉΓòÉ
  2032.  
  2033. getCurLayer() [virtual] 
  2034.  
  2035. Returns the number of the currenty active layer within the currently active 
  2036. model. 
  2037.  
  2038. int 
  2039.  
  2040.  
  2041. ΓòÉΓòÉΓòÉ 2.4.2.4. MEditView::getHasEdited() ΓòÉΓòÉΓòÉ
  2042.  
  2043. getHasEdited() [virtual] 
  2044.  
  2045. Returns value of ISEDITING. 
  2046.  
  2047. int 
  2048.  
  2049.  
  2050. ΓòÉΓòÉΓòÉ 2.4.2.5. MEditView::getStart() ΓòÉΓòÉΓòÉ
  2051.  
  2052. getStart() [virtual] 
  2053.  
  2054. Returns the position within the edit-view contents of the first selected 
  2055. character. 
  2056.  
  2057. int 
  2058.  
  2059.  
  2060. ΓòÉΓòÉΓòÉ 2.4.2.6. MEditView::getString() ΓòÉΓòÉΓòÉ
  2061.  
  2062. getString() [virtual] 
  2063.  
  2064. Returns edit-view contents. 
  2065.  
  2066. char * 
  2067.  
  2068.  
  2069. ΓòÉΓòÉΓòÉ 2.4.2.7. MEditView::hasDrawSelf() ΓòÉΓòÉΓòÉ
  2070.  
  2071. hasDrawSelf() [virtual] 
  2072.  
  2073. Always returns 1, indicating that MEditView has a drawSelf() method (see 
  2074. MWindow::hasDrawSelf()). 
  2075.  
  2076. int 
  2077.  
  2078.  
  2079. ΓòÉΓòÉΓòÉ 2.4.2.8. MEditView::isCellSelectOK() ΓòÉΓòÉΓòÉ
  2080.  
  2081. isCellSelectOK() [virtual] 
  2082.  
  2083. Returns 1 if pressing an arrow key within the edit view should enter a cell 
  2084. reference at that point in the edit view; returns 0 otherwise. 
  2085.  
  2086.  int 
  2087.  
  2088.  
  2089. ΓòÉΓòÉΓòÉ 2.4.2.9. MEditView::isEditingFormula() ΓòÉΓòÉΓòÉ
  2090.  
  2091. isEditingFormula() [virtual] 
  2092.  
  2093. Does the edit buffer contain a formula? This is determined by the presence of 
  2094. operators in the first character of the string, or @ followed by a letter 
  2095. (meaning a function name). 
  2096.  
  2097. Returns 1 if editing a formula, 0 otherwise. 
  2098.  
  2099. int 
  2100.  
  2101.  
  2102. ΓòÉΓòÉΓòÉ 2.4.2.10. MEditView::rightOfOperator() ΓòÉΓòÉΓòÉ
  2103.  
  2104. rightOfOperator(const char *, int) [virtual] 
  2105.  
  2106.       const char * 
  2107.  
  2108.       int 
  2109.  
  2110.  Is the cursor immediately to the right of an operator such as +, -, (, etc.? 
  2111.  
  2112.  This method is used by MEditView::isCellSelectOK() to determine the behavior 
  2113.  of arrow keys within the edit view. 
  2114.  
  2115.  Returns 1 if cursor is to the right of an operator, 0 otherwise. 
  2116.  
  2117.   int 
  2118.  
  2119.  
  2120. ΓòÉΓòÉΓòÉ 2.4.3. Changing values in an MEditView instance ΓòÉΓòÉΓòÉ
  2121.  
  2122. Open the Contents view and expand this section to see a list of methods. 
  2123.  
  2124.  
  2125. ΓòÉΓòÉΓòÉ 2.4.3.1. MEditView::setCurLayer() ΓòÉΓòÉΓòÉ
  2126.  
  2127. setCurLayer(int i) [virtual] 
  2128.  
  2129.       int i 
  2130.  
  2131.  Informs the edit view that the currently selected layer is i. This controls 
  2132.  how the edit view handles creating range references and similar activities 
  2133.  (see MEditView::toggleAbsolute()); it does not change the actual selection 
  2134.  within the model. 
  2135.  
  2136.  void 
  2137.  
  2138.  
  2139. ΓòÉΓòÉΓòÉ 2.4.3.2. MEditView::setIsEditing() ΓòÉΓòÉΓòÉ
  2140.  
  2141. setIsEditing() [virtual] 
  2142.  
  2143. Sets ISEDITING flag and stores the current edit string for backup purposes. 
  2144.  
  2145. void 
  2146.  
  2147. setIsEditing(int i) [virtual] 
  2148.  
  2149.       int i   New value for ISEDITING (should be 0 or 1) 
  2150.  
  2151.  Sets ISEDITING flag to i. 
  2152.  
  2153.  void 
  2154.  
  2155.  
  2156. ΓòÉΓòÉΓòÉ 2.4.4. Handling keyboard input to the edit view ΓòÉΓòÉΓòÉ
  2157.  
  2158. Open the Contents view and expand this section to see a list of methods. 
  2159.  
  2160.  
  2161. ΓòÉΓòÉΓòÉ 2.4.4.1. MEditView::editGetDoSomething() ΓòÉΓòÉΓòÉ
  2162.  
  2163. editGetDoSomething(int, int) 
  2164.  
  2165.       int   Character entered 
  2166.  
  2167.       int   Key flags set (Ctrl, Alt, etc.) 
  2168.  
  2169.  Determines whether the key-combination entered requires special processing. 
  2170.  
  2171.  Returns 1 if it requires special processing, 0 otherwise. 
  2172.  
  2173.  static int 
  2174.  
  2175.  
  2176. ΓòÉΓòÉΓòÉ 2.4.4.2. MEditView::handleKey() ΓòÉΓòÉΓòÉ
  2177.  
  2178. handleKey(int, int) [virtual] 
  2179.  
  2180.       int   Character entered 
  2181.  
  2182.       int   Key flags set (Ctrl, Alt, etc.) 
  2183.  
  2184.  Processes a keystroke. Normal characters are entered at the current position 
  2185.  (replacing the current selection if any); some special characters perform 
  2186.  special functions within the edit view (changing the value of arguments, 
  2187.  selecting regions of text, etc.). 
  2188.  
  2189.  Returns 0 if the key has been handled, 1 otherwise. 
  2190.  
  2191.  int 
  2192.  
  2193.  
  2194. ΓòÉΓòÉΓòÉ 2.4.5. Handling mouse input to the edit view ΓòÉΓòÉΓòÉ
  2195.  
  2196. Open the Contents view and expand this section to see a list of methods. 
  2197.  
  2198.  
  2199. ΓòÉΓòÉΓòÉ 2.4.5.1. MEditView::mouse1Down() ΓòÉΓòÉΓòÉ
  2200.  
  2201. mouse1Down(const MPoint *, int, int &) [virtual] 
  2202.  
  2203.       const MPoint *   Point at which mouse was depressed 
  2204.  
  2205.       int   Key flags at that point (Ctrl, Alt, etc) 
  2206.  
  2207.       int &   Was it handled? 1 for yes, 0 for no. 
  2208.  
  2209.  Translates the mouse position into a character position within the string, and 
  2210.  sets the edit-view cursor to to that position. 
  2211.  
  2212.  void 
  2213.  
  2214.  
  2215. ΓòÉΓòÉΓòÉ 2.4.5.2. MEditView::mouse1MotionEnd() ΓòÉΓòÉΓòÉ
  2216.  
  2217. mouse1MotionEnd(int &) [virtual] 
  2218.  
  2219.       int &   Unused 
  2220.  
  2221.  Turns off the ISSELECTING flag. 
  2222.  
  2223.  void 
  2224.  
  2225.  
  2226. ΓòÉΓòÉΓòÉ 2.4.5.3. MEditView::mouse1MotionStart() ΓòÉΓòÉΓòÉ
  2227.  
  2228. mouse1MotionStart(int &) [virtual] 
  2229.  
  2230.       int &   Was it handled? Will always be no. 
  2231.  
  2232.  Sets the ISSELECTING flag, indicating that a range of characters in the edit 
  2233.  view is currently being selected. Sets the first character of the selection 
  2234.  (the anchor character) to the character where the mouse was initially pressed 
  2235.  (see MEditView::mouse1MotionStart()), and updates the window. 
  2236.  
  2237.  void 
  2238.  
  2239.  
  2240. ΓòÉΓòÉΓòÉ 2.4.5.4. MEditView::mouse1Up() ΓòÉΓòÉΓòÉ
  2241.  
  2242. mouse1Up(const MPoint *, int, int &) [virtual] 
  2243.  
  2244.       const MPoint *   Point at which mouse was depressed 
  2245.  
  2246.       int   Key flags at that point 
  2247.  
  2248.       int &   Was it handled? 1 for yes, 0 for no. 
  2249.  
  2250.  If ISSELECTING is set, passes a mouse1MotionEnd() method to the instance. 
  2251.  
  2252.  void 
  2253.  
  2254.  
  2255. ΓòÉΓòÉΓòÉ 2.4.5.5. MEditView::winButton1Click() ΓòÉΓòÉΓòÉ
  2256.  
  2257. winButton1Click(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  2258.  
  2259.       HWND   Window handle
  2260.  
  2261.       ULONG   Message 
  2262.  
  2263.       MPARAM   Parameter 1 
  2264.  
  2265.       MPARAM   Parameter 2 
  2266.  
  2267.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  2268.       passed to default window handler.) 
  2269.  
  2270.  Selects the character pointed at by the mouse. 
  2271.  
  2272.  MRESULT 
  2273.  
  2274.  
  2275. ΓòÉΓòÉΓòÉ 2.4.5.6. MEditView::winButton1DoubleClick() ΓòÉΓòÉΓòÉ
  2276.  
  2277. winButton1DoubleClick(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  2278.  
  2279.       HWND   Window handle
  2280.  
  2281.       ULONG   Message 
  2282.  
  2283.       MPARAM   Parameter 1 
  2284.  
  2285.       MPARAM   Parameter 2 
  2286.  
  2287.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  2288.       passed to default window handler.) 
  2289.  
  2290.  Selects the word pointed at by the mouse. 
  2291.  
  2292.  MRESULT 
  2293.  
  2294.  
  2295. ΓòÉΓòÉΓòÉ 2.4.5.7. MEditView::winChord() ΓòÉΓòÉΓòÉ
  2296.  
  2297. winChord(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  2298.  
  2299.       HWND 
  2300.  
  2301.       ULONG 
  2302.  
  2303.       MPARAM 
  2304.  
  2305.       MPARAM 
  2306.  
  2307.       int & 
  2308.  
  2309.  Selects the entire edit-view string. 
  2310.  
  2311.  MRESULT 
  2312.  
  2313.  
  2314. ΓòÉΓòÉΓòÉ 2.4.5.8. MEditView::winMouseMove() ΓòÉΓòÉΓòÉ
  2315.  
  2316. winMouseMove(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  2317.  
  2318.       HWND   Window handle
  2319.  
  2320.       ULONG   Message 
  2321.  
  2322.       MPARAM   Parameter 1 
  2323.  
  2324.       MPARAM   Parameter 2 
  2325.  
  2326.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  2327.       passed to default window handler.) 
  2328.  
  2329.  If ISSELECTING is set, then the selection is reset to include the characters 
  2330.  between the initial mouse-click location and the current mouse location. 
  2331.  
  2332.  MRESULT 
  2333.  
  2334.  
  2335. ΓòÉΓòÉΓòÉ 2.4.6. Selecting characters in the edit view ΓòÉΓòÉΓòÉ
  2336.  
  2337. Open the Contents view and expand this section to see a list of methods. 
  2338.  
  2339.  
  2340. ΓòÉΓòÉΓòÉ 2.4.6.1. MEditView::selectArgs() ΓòÉΓòÉΓòÉ
  2341.  
  2342. selectArgs(int startPoint, int len) [virtual] 
  2343.  
  2344.       int startPoint   Offset from first character in edit-view string 
  2345.  
  2346.       int len   Maximum number of characters to select 
  2347.  
  2348.  Finds and selects the argument list in the edit-view string after startPoint 
  2349.  character of the edit-view string. If the argument list is more than len 
  2350.  characters, nothing is selected. This method is used, for example, when a 
  2351.  function is inserted into the edit view through the Formula Builder in Mesa. 
  2352.  
  2353.  For example, if the edit view string is =INT(SQRT(LOG10(A5))), then 
  2354.  selectArgs(2,20) will select the substring SQRT(LOG10(A5)), selectArgs(8,20) 
  2355.  will select the substring LOG10(A5), and selectArgs(12,20) will select the 
  2356.  substring A5. 
  2357.  
  2358.  void 
  2359.  
  2360.  
  2361. ΓòÉΓòÉΓòÉ 2.4.6.2. MEditView::selectRange() ΓòÉΓòÉΓòÉ
  2362.  
  2363. selectRange(int, int, int) [virtual] 
  2364.  
  2365.       int   Start of selection 
  2366.  
  2367.       int   End of selection 
  2368.  
  2369.       int   Position to make visible 
  2370.  
  2371.  Sets the current selection, and scrolls the window (if necessary) to make the 
  2372.  specified position visible. 
  2373.  
  2374.  void 
  2375.  
  2376.  
  2377. ΓòÉΓòÉΓòÉ 2.4.6.3. MEditView::selectText() ΓòÉΓòÉΓòÉ
  2378.  
  2379. selectText() [virtual] 
  2380.  
  2381. Selects the entire text of the edit buffer. 
  2382.  
  2383. void 
  2384.  
  2385.  
  2386. ΓòÉΓòÉΓòÉ 2.4.6.4. MEditView::setEditRange() ΓòÉΓòÉΓòÉ
  2387.  
  2388. setEditRange(int, int, int=0) [virtual] 
  2389.  
  2390.       int   Start of selection 
  2391.  
  2392.       int   End of selection 
  2393.  
  2394.       int = 0   Unused. 
  2395.  
  2396.  Sets the start and end characters of the current selection within the edit 
  2397.  view. 
  2398.  
  2399.  void 
  2400.  
  2401.  
  2402. ΓòÉΓòÉΓòÉ 2.4.7. Writing selected characters to clipboard ΓòÉΓòÉΓòÉ
  2403.  
  2404. Open the Contents view and expand this section to see a list of methods. 
  2405.  
  2406.  
  2407. ΓòÉΓòÉΓòÉ 2.4.7.1. MEditView::copyToClipboard() ΓòÉΓòÉΓòÉ
  2408.  
  2409. copyToClipboard(MClipStream *) [virtual] 
  2410.  
  2411.       MClipStream *   Clipboard output stream 
  2412.  
  2413.  Writes the contents of the current selection to the clipboard. 
  2414.  
  2415.  void 
  2416.  
  2417.  
  2418. ΓòÉΓòÉΓòÉ 2.4.8. Controlling the appearance of the edit view ΓòÉΓòÉΓòÉ
  2419.  
  2420. Open the Contents view and expand this section to see a list of methods. 
  2421.  
  2422.  
  2423. ΓòÉΓòÉΓòÉ 2.4.8.1. MEditView::drawSelf() ΓòÉΓòÉΓòÉ
  2424.  
  2425. drawSelf(MDraw *, const MRect *) [virtual] 
  2426.  
  2427.       MDraw *   Region to draw into 
  2428.  
  2429.       const MRect *   Clipping rectangle 
  2430.  
  2431.  Draws the contents of the edit window and highlights the selected area. 
  2432.  
  2433.  Always returns 1 (see MWindow::drawSelf()). 
  2434.  
  2435.  int 
  2436.  
  2437.  
  2438. ΓòÉΓòÉΓòÉ 2.4.8.2. MEditView::scrollToVisible() ΓòÉΓòÉΓòÉ
  2439.  
  2440. scrollToVisible(int) [virtual] 
  2441.  
  2442.       int   Position of first character to make visible. -1 means make visible 
  2443.       from beginning. 
  2444.  
  2445.  Modifies the offset value to ensure that the given character position is 
  2446.  visible on the screen. 
  2447.  
  2448.  void 
  2449.  
  2450.  
  2451. ΓòÉΓòÉΓòÉ 2.4.8.3. MEditView::setFont() ΓòÉΓòÉΓòÉ
  2452.  
  2453. setFont(const MFont *) [virtual] 
  2454.  
  2455.       const MFont *   New font 
  2456.  
  2457.  Changes the display font of the edit view. 
  2458.  
  2459.  void 
  2460.  
  2461.  
  2462. ΓòÉΓòÉΓòÉ 2.4.8.4. MEditView::winPing() ΓòÉΓòÉΓòÉ
  2463.  
  2464. winPing(HWND, MPARAM, MPARAM) [virtual] 
  2465.  
  2466.       HWND   Unused 
  2467.  
  2468.       MPARAM   Unused 
  2469.  
  2470.       MPARAM   Unused 
  2471.  
  2472.  If ISSELECTING is not set, updates the window. 
  2473.  
  2474.  Starts another ping to repeat the process (see MEditView::setUp()). 
  2475.  
  2476.  Always returns 1. 
  2477.  
  2478.  MRESULT 
  2479.  
  2480.  
  2481. ΓòÉΓòÉΓòÉ 2.4.9. Editing characters in the edit view ΓòÉΓòÉΓòÉ
  2482.  
  2483. Open the Contents view and expand this section to see a list of methods. 
  2484.  
  2485.  
  2486. ΓòÉΓòÉΓòÉ 2.4.9.1. MEditView::insertAtStart() ΓòÉΓòÉΓòÉ
  2487.  
  2488. insertAtStart(const char *) [virtual] 
  2489.  
  2490.       const char *   Input string 
  2491.  
  2492.  Replaces the current selection within the edit string (if any) with the given 
  2493.  input string. (Compare with MEditView::insertRefAtStart().) 
  2494.  
  2495.  void 
  2496.  
  2497.  
  2498. ΓòÉΓòÉΓòÉ 2.4.9.2. MEditView::insertRefAtStart() ΓòÉΓòÉΓòÉ
  2499.  
  2500. insertRefAtStart(const char *) [virtual] 
  2501.  
  2502.       const char *   Input string 
  2503.  
  2504.  Replaces the current selection within the edit string (if any) with the given 
  2505.  input string, adding other characters as well based on the characters in the 
  2506.  edit string before the current selection. (Compare with 
  2507.  MEditView::insertAtStart().) 
  2508.  
  2509.  If the cursor location is between a pair of parentheses and not preceded by a 
  2510.  comma, then a comma is inserted before the input string (thereby treating the 
  2511.  input string as the next argument within the parentheses). 
  2512.  
  2513.  If the cursor location is preceded by a quotation mark then an ampersand is 
  2514.  inserted before the input string (thereby treating the input string as string 
  2515.  to be concatenated with the preceding string). 
  2516.  
  2517.  Otherwise, the input string is preceded by a plus sign. 
  2518.  
  2519.  void 
  2520.  
  2521.  
  2522. ΓòÉΓòÉΓòÉ 2.4.9.3. MEditView::removeSelection() ΓòÉΓòÉΓòÉ
  2523.  
  2524. removeSelection() [virtual] 
  2525.  
  2526. Deletes the currently selected characters from the edit buffer. 
  2527.  
  2528. void 
  2529.  
  2530.  
  2531. ΓòÉΓòÉΓòÉ 2.4.9.4. MEditView::pasteInto() ΓòÉΓòÉΓòÉ
  2532.  
  2533. pasteInto(MClipStream *) [virtual] 
  2534.  
  2535.       MClipStream *   The input stream. 
  2536.  
  2537.  Places the contents of the clipboard (if Mesa 2 or ASCII format) into the edit 
  2538.  string at the current selection point, replacing the currently selected 
  2539.  characters (if any). 
  2540.  
  2541.  void 
  2542.  
  2543.  
  2544. ΓòÉΓòÉΓòÉ 2.4.9.5. MEditView::setString() ΓòÉΓòÉΓòÉ
  2545.  
  2546. setString(const char *) [virtual] 
  2547.  
  2548.       const char *   String to store in edit buffer 
  2549.  
  2550.  Changes the string in the edit buffer to the string passed in, resets the 
  2551.  selection, and updates the window. 
  2552.  
  2553.  void 
  2554.  
  2555.  
  2556. ΓòÉΓòÉΓòÉ 2.4.9.6. MEditView::toggleAbsolute() ΓòÉΓòÉΓòÉ
  2557.  
  2558. toggleAbsolute() [virtual] 
  2559.  
  2560. If the current region selected within the edit view is a range reference (e.g.; 
  2561. A1:D5) or a cell reference (e.g.; B7), or if there is no region selected but 
  2562. the cursor is within a range or cell reference, then the reference is cycled 
  2563. through the various combinations of absolute and relative status (see MAddress) 
  2564. in the following order: 
  2565.  
  2566. all relative 
  2567.  
  2568. absolute row 
  2569.  
  2570. absolute column 
  2571.  
  2572. absolute row and column 
  2573.  
  2574. absolute layer 
  2575.  
  2576. absolute row and layer 
  2577.  
  2578. absolute column and layer 
  2579.  
  2580. all absolute 
  2581.  
  2582. If no layer reference is included in the string, then the current layer is used 
  2583. (see MEditView::getCurLayer()). 
  2584.  
  2585. This method is generally associated with the F4 key within Mesa. 
  2586.  
  2587. For example, if the currently selected region is the substring D5 and the 
  2588. current layer is 3, repeated uses of toggleAbsolute() will replace the 
  2589. substring with D$5, $D5, $D$5, [$D]D5, [$D]D$5, [$D]$D5, [$D]$D$5, [D]D5. (Note 
  2590. that at the end of the cycle, an explicit relative layer reference has been 
  2591. added (that is, D5 has changed to [D]D5). This has no real effect, since the D5 
  2592. syntax includes an implicit relative reference to the current layer, and the 
  2593. two strings are parsed equivalently. 
  2594.  
  2595.  void 
  2596.  
  2597.  
  2598. ΓòÉΓòÉΓòÉ 2.4.10. Undoing and redoing edits ΓòÉΓòÉΓòÉ
  2599.  
  2600. Open the Contents view and expand this section to see a list of methods. 
  2601.  
  2602.  
  2603. ΓòÉΓòÉΓòÉ 2.4.10.1. MEditView::undo() ΓòÉΓòÉΓòÉ
  2604.  
  2605. undo() [virtual] 
  2606.  
  2607. Restores the value of the edit string from the undo buffer, selects the entire 
  2608. string, and sets the JUSTUNDID flag. 
  2609.  
  2610. void 
  2611.  
  2612.  
  2613. ΓòÉΓòÉΓòÉ 2.4.10.2. MEditView::redo() ΓòÉΓòÉΓòÉ
  2614.  
  2615. redo() [virtual] 
  2616.  
  2617. Replaces the current edit string with the contents of a temporary "undo" buffer 
  2618. (see MEditView::undo()). Also places the current edit string contents in the 
  2619. undo buffer. 
  2620.  
  2621. void 
  2622.  
  2623.  
  2624. ΓòÉΓòÉΓòÉ 2.5. MException ΓòÉΓòÉΓòÉ
  2625.  
  2626. exception.h is the source file for this class. 
  2627.  
  2628. Stores an application-defined error. Can be expanded to include warnings and 
  2629. other kinds of exceptions. 
  2630.  
  2631. Your application's controller should implement some method for dealing with or 
  2632. displaying MExceptions, such as redirecting them to an output file or 
  2633. displaying their contents in a message box (see 
  2634. MGController::displayException()=0). 
  2635.  
  2636. Each MException holds an error code and an associated error string (see "Error 
  2637. constants"). It also contains an optional list of warnings and an optional list 
  2638. of error-location values (values relating to the location at which an error 
  2639. occured) which are not currently used for anything, but can be set and read 
  2640. from within your application. 
  2641.  
  2642.  
  2643. ΓòÉΓòÉΓòÉ 2.5.1. Creating, destroying, and initializing an MException instance ΓòÉΓòÉΓòÉ
  2644.  
  2645. Open the Contents view and expand this section to see a list of methods. 
  2646.  
  2647.  
  2648. ΓòÉΓòÉΓòÉ 2.5.1.1. MException::MException() ΓòÉΓòÉΓòÉ
  2649.  
  2650. MException() 
  2651.  
  2652. Initializes the exception. 
  2653.  
  2654. void 
  2655.  
  2656.  
  2657. ΓòÉΓòÉΓòÉ 2.5.1.2. MException::~MException() ΓòÉΓòÉΓòÉ
  2658.  
  2659. ~MException() 
  2660.  
  2661. Destroys the exception. 
  2662.  
  2663. void 
  2664.  
  2665.  
  2666. ΓòÉΓòÉΓòÉ 2.5.1.3. MException::_init() ΓòÉΓòÉΓòÉ
  2667.  
  2668. _init() 
  2669.  
  2670. Initializes the exception. 
  2671.  
  2672. void 
  2673.  
  2674.  
  2675. ΓòÉΓòÉΓòÉ 2.5.1.4. MException::_destroy() ΓòÉΓòÉΓòÉ
  2676.  
  2677. _destroy() 
  2678.  
  2679. Releases any warnings, error messages, etc., before destroying the exception. 
  2680.  
  2681. void 
  2682.  
  2683.  
  2684. ΓòÉΓòÉΓòÉ 2.5.2. Retrieving information about an MException instance ΓòÉΓòÉΓòÉ
  2685.  
  2686. Open the Contents view and expand this section to see a list of methods. 
  2687.  
  2688.  
  2689. ΓòÉΓòÉΓòÉ 2.5.2.1. MException::getError() ΓòÉΓòÉΓòÉ
  2690.  
  2691. getError() const 
  2692.  
  2693. If there is no error in this exception, returns noError (see "Error 
  2694. constants"); otherwise, returns the error code. 
  2695.  
  2696. int 
  2697.  
  2698.  
  2699. ΓòÉΓòÉΓòÉ 2.5.2.2. MException::getErrorPlaces() ΓòÉΓòÉΓòÉ
  2700.  
  2701. getErrorPlaces(int i) const 
  2702.  
  2703.       int i   Index into error-locations list 
  2704.  
  2705.  Returns the given error-location value (see MException). 
  2706.  
  2707.  int 
  2708.  
  2709.  
  2710. ΓòÉΓòÉΓòÉ 2.5.2.3. MException::getErrorText() ΓòÉΓòÉΓòÉ
  2711.  
  2712. getErrorText() const 
  2713.  
  2714. Returns the error string (see "Error constants"). 
  2715.  
  2716. char * 
  2717.  
  2718.  
  2719. ΓòÉΓòÉΓòÉ 2.5.2.4. MException::getWarning() ΓòÉΓòÉΓòÉ
  2720.  
  2721. getWarning(int) const 
  2722.  
  2723.       int   Index into warnings list 
  2724.  
  2725.  Returns the    given warning ID (see MException). 
  2726.  
  2727.  int 
  2728.  
  2729.  
  2730. ΓòÉΓòÉΓòÉ 2.5.2.5. MException::getWarningCnt() ΓòÉΓòÉΓòÉ
  2731.  
  2732. getWarningCnt() const 
  2733.  
  2734. Returns size of warnings list. 
  2735.  
  2736. int 
  2737.  
  2738.  
  2739. ΓòÉΓòÉΓòÉ 2.5.2.6. MException::getWarningText() ΓòÉΓòÉΓòÉ
  2740.  
  2741. getWarningText(int) const 
  2742.  
  2743.       int   Index into warnings list 
  2744.  
  2745.  Returns the given warning text. 
  2746.  
  2747.  char * 
  2748.  
  2749.  
  2750. ΓòÉΓòÉΓòÉ 2.5.2.7. MException::isError() ΓòÉΓòÉΓòÉ
  2751.  
  2752. isError() const 
  2753.  
  2754. If there is no error in this exception, returns noError (see "Error 
  2755. constants"); otherwise, returns the error code. 
  2756.  
  2757. Identical to MException::isError(). 
  2758.  
  2759. int 
  2760.  
  2761.  
  2762. ΓòÉΓòÉΓòÉ 2.5.3. Changing values in an MException instance ΓòÉΓòÉΓòÉ
  2763.  
  2764. Open the Contents view and expand this section to see a list of methods. 
  2765.  
  2766.  
  2767. ΓòÉΓòÉΓòÉ 2.5.3.1. MException::addWarning() ΓòÉΓòÉΓòÉ
  2768.  
  2769. addWarning(int, const char * = (const char *) NULL) 
  2770.  
  2771.       int   Warning ID 
  2772.  
  2773.       const char *   Warning text. Defaults to NULL pointer. 
  2774.  
  2775.  Adds warning to the warning list. 
  2776.  
  2777.  void 
  2778.  
  2779.  
  2780. ΓòÉΓòÉΓòÉ 2.5.3.2. MException::setError() ΓòÉΓòÉΓòÉ
  2781.  
  2782. setError(int, const char * = (const char *) NULL) 
  2783.  
  2784.       int   Error ID 
  2785.  
  2786.       const char *   Error message. Defaults to NULL pointer. 
  2787.  
  2788.  Sets the error ID and text of the current exception. 
  2789.  
  2790.  void 
  2791.  
  2792.  
  2793. ΓòÉΓòÉΓòÉ 2.5.3.3. MException::setErrorPlaces() ΓòÉΓòÉΓòÉ
  2794.  
  2795. setErrorPlaces(int, int) 
  2796.  
  2797.       int i   Index to error-locations list 
  2798.  
  2799.       int value   Error-location value 
  2800.  
  2801.  Sets the given element of the error-locations list to value. 
  2802.  
  2803.  void 
  2804.  
  2805.  
  2806. ΓòÉΓòÉΓòÉ 2.5.3.4. MException::setOSError() ΓòÉΓòÉΓòÉ
  2807.  
  2808. setOSError(int) 
  2809.  
  2810.       int   Error ID 
  2811.  
  2812.  Sets the error value to one of a set of operating-system-specific error 
  2813.  messages (see "Error constants"), and the error text to NULL. (Compare with 
  2814.  MException::setError().) 
  2815.  
  2816.  void 
  2817.  
  2818.  
  2819. ΓòÉΓòÉΓòÉ 2.5.3.5. MException::setRexxError() ΓòÉΓòÉΓòÉ
  2820.  
  2821. setRexxError(int) 
  2822.  
  2823.       int   Error ID 
  2824.  
  2825.  Sets the error value to one of a set of REXX-specific error messages (see 
  2826.  "Error constants") and the error text to NULL. (Compare with 
  2827.  MException::setError().) 
  2828.  
  2829.  void 
  2830.  
  2831.  
  2832. ΓòÉΓòÉΓòÉ 2.6. MFileStream ΓòÉΓòÉΓòÉ
  2833.  
  2834. filestream.h is the source file for this class. 
  2835.  
  2836. This class inherits from MStream 
  2837.  
  2838. Abstracts the OS/2 file system and allows data to be written to or read from 
  2839. disk. 
  2840.  
  2841. Each MFileStream instance keeps track of its current position within the file 
  2842. and maintains a local cache buffer for faster file handling. It also keeps 
  2843. track of whether it is an input stream (MSTREAM_READ) or an output stream 
  2844. (MSTREAM_WRITE). 
  2845.  
  2846. Like all other MStream subclasses, it also keeps track of current and 
  2847. next-element stream positions, allocates storage for any errors that may occur, 
  2848. and maintains a version number. For more information, see "MStream". 
  2849.  
  2850.  
  2851. ΓòÉΓòÉΓòÉ 2.6.1. Creating, destroying, and initializing an MFileStream instance ΓòÉΓòÉΓòÉ
  2852.  
  2853. Open the Contents view and expand this section to see a list of methods. 
  2854.  
  2855.  
  2856. ΓòÉΓòÉΓòÉ 2.6.1.1. MFileStream::MFileStream() ΓòÉΓòÉΓòÉ
  2857.  
  2858. MFileStream(int, const char *) 
  2859.  
  2860.       int   Stream type (MSTREAM_READ or MSTREAM_WRITE) 
  2861.  
  2862.       const char *   File name associated with the stream. 
  2863.  
  2864.  Creates an MFileStream instance variable of a given type, and associates it 
  2865.  with the given filename. 
  2866.  
  2867.  void 
  2868.  
  2869.  
  2870. ΓòÉΓòÉΓòÉ 2.6.1.2. MFileStream::~MFileStream() ΓòÉΓòÉΓòÉ
  2871.  
  2872. ~MFileStream() [virtual] 
  2873.  
  2874. Closes the associated file and frees all allocated resources. If file-system 
  2875. errors are encountered the appropriate error ID is placed in the exception 
  2876. handler. 
  2877.  
  2878. void 
  2879.  
  2880.  
  2881. ΓòÉΓòÉΓòÉ 2.6.2. Reading and writing the file ΓòÉΓòÉΓòÉ
  2882.  
  2883. Open the Contents view and expand this section to see a list of methods. 
  2884.  
  2885.  
  2886. ΓòÉΓòÉΓòÉ 2.6.2.1. MFileStream::read()=0 ΓòÉΓòÉΓòÉ
  2887.  
  2888. read(void *, int numBytes) = 0 [virtual] 
  2889.  
  2890.       void *   Pointer to storage buffer 
  2891.  
  2892.       int numBytes   Number of bytes to be read into buffer. 
  2893.  
  2894.  Attempts to read numBytes bytes from the file into the given storage buffer. 
  2895.  
  2896.  Returns actual number of bytes read. 
  2897.  
  2898.  int 
  2899.  
  2900.  
  2901. ΓòÉΓòÉΓòÉ 2.6.2.2. MFileStream::write() ΓòÉΓòÉΓòÉ
  2902.  
  2903. write(const void *, int) [virtual] 
  2904.  
  2905.       const void *buf   Buffer containing bytes to output 
  2906.  
  2907.       int N   Number of bytes to write 
  2908.  
  2909.  Writes N bytes from buf to the associated file. 
  2910.  
  2911.  For performance reasons, write() will simply edit the contents of the local 
  2912.  cache if N does not exceed the cache size. 
  2913.  
  2914.  Returns actual number of bytes written. 
  2915.  
  2916.  int 
  2917.  
  2918.  
  2919. ΓòÉΓòÉΓòÉ 2.6.3. Setting file attributes ΓòÉΓòÉΓòÉ
  2920.  
  2921. Open the Contents view and expand this section to see a list of methods. 
  2922.  
  2923.  
  2924. ΓòÉΓòÉΓòÉ 2.6.3.1. MFileStream::setAttributes() ΓòÉΓòÉΓòÉ
  2925.  
  2926. setAttributes(const char *fileType) [virtual] 
  2927.  
  2928.       const char *fileType   Type of file, in null-terminated string format 
  2929.  
  2930.  Sets the OS/2 extended-attribute .TYPE parameter to fileType. 
  2931.  
  2932.  For example, setAttributes("123 DOS Spreadsheet") will set the 
  2933.  extended-attribute .TYPE parameter of the associated file to 123 DOS 
  2934.  Spreadsheet (the Lotus(TM) .WK1 format), and setAttributes("Mesa Workbook 
  2935.  File") will set the extended-attribute .TYPE parameter of the associated file 
  2936.  to MesaWorkbook File (the Mesa(TM) .M2 format). 
  2937.  
  2938.  void 
  2939.  
  2940.  
  2941. ΓòÉΓòÉΓòÉ 2.6.3.2. MFileStream::setMesaAttributes() ΓòÉΓòÉΓòÉ
  2942.  
  2943. setMesaAttributes() [virtual] 
  2944.  
  2945. Sets the OS/2 extended-attribute .TYPE parameter to Mesa Workbook File. 
  2946. (Compare with MFileStream::setAttributes().) 
  2947.  
  2948. void 
  2949.  
  2950.  
  2951. ΓòÉΓòÉΓòÉ 2.6.4. Querying the file ΓòÉΓòÉΓòÉ
  2952.  
  2953. Open the Contents view and expand this section to see a list of methods. 
  2954.  
  2955.  
  2956. ΓòÉΓòÉΓòÉ 2.6.4.1. MFileStream::isEOF() ΓòÉΓòÉΓòÉ
  2957.  
  2958. isEOF() [virtual] 
  2959.  
  2960. Returns 1 if the current file position is the end of the file, 0 otherwise. 
  2961.  
  2962. int 
  2963.  
  2964.  
  2965. ΓòÉΓòÉΓòÉ 2.6.4.2. MFileStream::getPos() ΓòÉΓòÉΓòÉ
  2966.  
  2967. getPos() [virtual] 
  2968.  
  2969. Returns the current file position. 
  2970.  
  2971. int 
  2972.  
  2973.  
  2974. ΓòÉΓòÉΓòÉ 2.6.5. Navigating within the stream ΓòÉΓòÉΓòÉ
  2975.  
  2976. Open the Contents view and expand this section to see a list of methods. 
  2977.  
  2978.  
  2979. ΓòÉΓòÉΓòÉ 2.6.5.1. MFileStream::getStreamLen() ΓòÉΓòÉΓòÉ
  2980.  
  2981. getStreamLen() [virtual] 
  2982.  
  2983. Returns the length of the stream. 
  2984.  
  2985. int 
  2986.  
  2987.  
  2988. ΓòÉΓòÉΓòÉ 2.6.5.2. MFileStream::seek() ΓòÉΓòÉΓòÉ
  2989.  
  2990. seek(int newPos) [virtual] 
  2991.  
  2992.       int newPos   New file position 
  2993.  
  2994.  Sets the current file position to newPos. 
  2995.  
  2996.  Returns new file position. 
  2997.  
  2998.  int 
  2999.  
  3000.  
  3001. ΓòÉΓòÉΓòÉ 2.6.6. Related Function: ΓòÉΓòÉΓòÉ
  3002.  
  3003. Open the Contents view and expand this section to see a list of methods. 
  3004.  
  3005.  
  3006. ΓòÉΓòÉΓòÉ 2.6.6.1. MFileStream::makeBackup() ΓòÉΓòÉΓòÉ
  3007.  
  3008. makeBackup(const char *, const char *) 
  3009.  
  3010.       const char *   Filename 
  3011.  
  3012.       const char *   Extension 
  3013.  
  3014.  Makes a backup of the given filename by creating a duplicate, deleting the 
  3015.  file, and renaming the given file to the backup name. The default backup 
  3016.  extension is M2B. 
  3017.  
  3018.  void 
  3019.  
  3020.  
  3021. ΓòÉΓòÉΓòÉ 2.7. MFont ΓòÉΓòÉΓòÉ
  3022.  
  3023. font.h is the source file for this class. 
  3024.  
  3025. Stores font family, size, and typeface information for a single font instance. 
  3026.  
  3027. Each model maintains an MFont array representing the font/size/typeface 
  3028. combinations that have been used within the model. Generally speaking, methods 
  3029. that deal with fonts can accept an integer index into the MFont array. For more 
  3030. information, see "MMesaModel contents". 
  3031.  
  3032. Each MFont instance stores a font name, like "Helvetica bold italic", and a 
  3033. font size (in points). 
  3034.  
  3035.  
  3036. ΓòÉΓòÉΓòÉ 2.7.1. Creating, destroying, and initializing an MFont instance ΓòÉΓòÉΓòÉ
  3037.  
  3038. Open the Contents view and expand this section to see a list of methods. 
  3039.  
  3040.  
  3041. ΓòÉΓòÉΓòÉ 2.7.1.1. MFont::free() ΓòÉΓòÉΓòÉ
  3042.  
  3043. free() 
  3044.  
  3045. Releases all allocated resources, such as the font name. 
  3046.  
  3047. void 
  3048.  
  3049.  
  3050. ΓòÉΓòÉΓòÉ 2.7.1.2. MFont::init() ΓòÉΓòÉΓòÉ
  3051.  
  3052. init() 
  3053.  
  3054. Initializes the MFont instance to the default font (12.Helv). 
  3055.  
  3056. void 
  3057.  
  3058. init(MStream *st) 
  3059.  
  3060.       MStream *st   Input stream 
  3061.  
  3062.  Initializes the MFont instance to values read from st (see MStream). 
  3063.  
  3064.  void 
  3065.  
  3066.  init(const MFont *font) 
  3067.  
  3068.       const MFont *font   Font to initialize from 
  3069.  
  3070.  Initializes the MFont instance to values read from font. 
  3071.  
  3072.  void 
  3073.  
  3074.  init(const char *) 
  3075.  
  3076.       const char *   OS/2 font name 
  3077.  
  3078.  Initialize the MFont instance from an OS/2 format font specifier (i.e. 
  3079.  "8.Helv"). 
  3080.  
  3081.  void 
  3082.  
  3083.  
  3084. ΓòÉΓòÉΓòÉ 2.7.2. Retrieving information about an MFont instance ΓòÉΓòÉΓòÉ
  3085.  
  3086. Open the Contents view and expand this section to see a list of methods. 
  3087.  
  3088.  
  3089. ΓòÉΓòÉΓòÉ 2.7.2.1. MFont::getName() ΓòÉΓòÉΓòÉ
  3090.  
  3091. getName() const 
  3092.  
  3093. Returns font name. 
  3094.  
  3095. const char * 
  3096.  
  3097.  
  3098. ΓòÉΓòÉΓòÉ 2.7.2.2. MFont::getSize() ΓòÉΓòÉΓòÉ
  3099.  
  3100. getSize() const 
  3101.  
  3102. Returns font size (in points). 
  3103.  
  3104. int 
  3105.  
  3106.  
  3107. ΓòÉΓòÉΓòÉ 2.7.2.3. MFont::getSystemName() ΓòÉΓòÉΓòÉ
  3108.  
  3109. getSystemName(char * buf) 
  3110.  
  3111.       char *buf   Storage location 
  3112.  
  3113.  Loads font name and size into buf, in OS/2 font specifier format (e.g.; 
  3114.  "8.Helv"). 
  3115.  
  3116.  void 
  3117.  
  3118.  
  3119. ΓòÉΓòÉΓòÉ 2.7.2.4. MFont::isBold() ΓòÉΓòÉΓòÉ
  3120.  
  3121. isBold() 
  3122.  
  3123. A font is bold if it has " bold" in its name. 
  3124.  
  3125. Returns 1 if the font is bold, 0 otherwise. 
  3126.  
  3127. int 
  3128.  
  3129.  
  3130. ΓòÉΓòÉΓòÉ 2.7.2.5. MFont::isItalic() ΓòÉΓòÉΓòÉ
  3131.  
  3132. isItalic() 
  3133.  
  3134. A font is italic if it has " italic" in its name. 
  3135.  
  3136. Returns 1 if the font is italic, 0 otherwise. 
  3137.  
  3138. int 
  3139.  
  3140.  
  3141. ΓòÉΓòÉΓòÉ 2.7.3. Changing values in an MFont instance ΓòÉΓòÉΓòÉ
  3142.  
  3143. Open the Contents view and expand this section to see a list of methods. 
  3144.  
  3145.  
  3146. ΓòÉΓòÉΓòÉ 2.7.3.1. MFont::makeBold() ΓòÉΓòÉΓòÉ
  3147.  
  3148. makeBold(int) 
  3149.  
  3150.       int   Make bold or unbold? 1 for bold, 0 for normal 
  3151.  
  3152.  Forces font to bold (if 1) or normal weight (if 0). 
  3153.  
  3154.  void 
  3155.  
  3156.  
  3157. ΓòÉΓòÉΓòÉ 2.7.3.2. MFont::makeItalic() ΓòÉΓòÉΓòÉ
  3158.  
  3159. makeItalic(int) 
  3160.  
  3161.       int   Make italic or normal? 1 for italic, 0 for normal 
  3162.  
  3163.  Forces font to italic (if 1) or normal angle (if 0). 
  3164.  
  3165.  void 
  3166.  
  3167.  
  3168. ΓòÉΓòÉΓòÉ 2.7.3.3. MFont::makePlain() ΓòÉΓòÉΓòÉ
  3169.  
  3170. makePlain(int) 
  3171.  
  3172.       int   Not currently used. 
  3173.  
  3174.  Removes bold and italic attributes from the current font. 
  3175.  
  3176.  void 
  3177.  
  3178.  
  3179. ΓòÉΓòÉΓòÉ 2.7.3.4. MFont::setName() ΓòÉΓòÉΓòÉ
  3180.  
  3181. setName(const char *) 
  3182.  
  3183.       const char *   New font name 
  3184.  
  3185.  Sets the font name to the value passed in. 
  3186.  
  3187.  void 
  3188.  
  3189.  
  3190. ΓòÉΓòÉΓòÉ 2.7.3.5. MFont::setSize() ΓòÉΓòÉΓòÉ
  3191.  
  3192. setSize(int) 
  3193.  
  3194.       int   New size value 
  3195.  
  3196.  Sets the font size to the value passed in. 
  3197.  
  3198.  void 
  3199.  
  3200.  
  3201. ΓòÉΓòÉΓòÉ 2.7.4. Outputting an MFont instance ΓòÉΓòÉΓòÉ
  3202.  
  3203. Open the Contents view and expand this section to see a list of methods. 
  3204.  
  3205.  
  3206. ΓòÉΓòÉΓòÉ 2.7.4.1. MFont::write() ΓòÉΓòÉΓòÉ
  3207.  
  3208. write(MStream *st) const 
  3209.  
  3210.       MStream *st   Output stream 
  3211.  
  3212.  Outputs the values of the font instance to st (see MStream). 
  3213.  
  3214.  void 
  3215.  
  3216.  
  3217. ΓòÉΓòÉΓòÉ 2.7.5. MFont operators ΓòÉΓòÉΓòÉ
  3218.  
  3219. Open the Contents view and expand this section to see a list of methods. 
  3220.  
  3221.  
  3222. ΓòÉΓòÉΓòÉ 2.7.5.1. MFont::operator=() ΓòÉΓòÉΓòÉ
  3223.  
  3224. operator=(const MFont &) 
  3225.  
  3226.       const MFont &   MFont instance to assign to 
  3227.  
  3228.  Sets the current instance equal to the MFont passed in. 
  3229.  
  3230.  Returns current MFont instance. 
  3231.  
  3232.  MFont & 
  3233.  
  3234.  operator=(const MFont *) 
  3235.  
  3236.       const MFont *   MFont instance to assign to 
  3237.  
  3238.  Sets the current instance equal to the MFont passed in. 
  3239.  
  3240.  Returns current MFont instance. 
  3241.  
  3242.  MFont & 
  3243.  
  3244.  
  3245. ΓòÉΓòÉΓòÉ 2.7.5.2. MFont::operator==() ΓòÉΓòÉΓòÉ
  3246.  
  3247. operator==(const MFont &f) const 
  3248.  
  3249.       const MFont &   MFont instance to compare to 
  3250.  
  3251.  Returns 1 if the two fonts have the same size and font name; 0 otherwise. 
  3252.  
  3253.  int 
  3254.  
  3255.  
  3256. ΓòÉΓòÉΓòÉ 2.8. MFormat ΓòÉΓòÉΓòÉ
  3257.  
  3258. format.h is the source file for this class. 
  3259.  
  3260. Stores formatting information that controls how a cell's contents are 
  3261. displayed. 
  3262.  
  3263. Each Mesa model contains an array of known formats, and whenever a new 
  3264. formatting combination is created, an associated MFormat instance is created 
  3265. and added to that list. Each cell in a model contains an index into that list, 
  3266. which is used to determine how the cell is displayed. For more information, see 
  3267. "MMesaModel". 
  3268.  
  3269. Among the bits of information stored within an MFormat instance are: 
  3270.  
  3271.      display format ID, degree of precision, and hidden status (see "Display 
  3272.       format constants") 
  3273.  
  3274.      vertical and horizontal alignment (see "Alignment constants") 
  3275.  
  3276.      input protection status (see "Input type constants") 
  3277.  
  3278.      colors of text and background (see MColor), including clear vs. opaque 
  3279.       background 
  3280.  
  3281.       A format can contain either a clear background or an opaque background. 
  3282.       The distinction is usually irrelevant; however, if a cell containing a 
  3283.       clear background is displayed above some other object (e.g.; a graph), 
  3284.       then the other object can be seen underneath it. If the cell contains an 
  3285.       opaque background, the other object cannot be seen. 
  3286.  
  3287.      colors and widths of borders (see "Border constants") 
  3288.  
  3289.      font, typeface, and size (see MFont) 
  3290.  
  3291.      underlining 
  3292.  
  3293.  Additionally, each piece of information has a merge flag associated with it. 
  3294.  In general, to alter the properties of an existing MFormat instance, you first 
  3295.  create a new MFormat instance with the values you want to change, set the 
  3296.  merge flags for those properties, then merge the new instance into the 
  3297.  existing instance through MFormat::mergeFormat(). 
  3298.  
  3299.  
  3300. ΓòÉΓòÉΓòÉ 2.8.1. Creating, destroying, and initializing an MFormat instance ΓòÉΓòÉΓòÉ
  3301.  
  3302. Open the Contents view and expand this section to see a list of methods. 
  3303.  
  3304.  
  3305. ΓòÉΓòÉΓòÉ 2.8.1.1. MFormat::free() ΓòÉΓòÉΓòÉ
  3306.  
  3307. free() 
  3308.  
  3309. Releases all allocated resources. 
  3310.  
  3311. void 
  3312.  
  3313.  
  3314. ΓòÉΓòÉΓòÉ 2.8.1.2. MFormat::init() ΓòÉΓòÉΓòÉ
  3315.  
  3316. init() 
  3317.  
  3318. Initializes the instance to appropriate default values. 
  3319.  
  3320. void 
  3321.  
  3322. init(const MFormat *fm) 
  3323.  
  3324.       const MFormat *fm   An existing MFormat instance from which to initialize 
  3325.  
  3326.  Initializes the instance with values from fm. 
  3327.  
  3328.  void 
  3329.  
  3330.  init(MStream *st) 
  3331.  
  3332.       MStream *st   Input stream. 
  3333.  
  3334.  Initializes the instance with values from st (see MStream). 
  3335.  
  3336.  void 
  3337.  
  3338.  
  3339. ΓòÉΓòÉΓòÉ 2.8.2. Retrieving information about an MFormat instance ΓòÉΓòÉΓòÉ
  3340.  
  3341. Open the Contents view and expand this section to see a list of methods. 
  3342.  
  3343.  
  3344. ΓòÉΓòÉΓòÉ 2.8.2.1. MFormat::getAlignment() ΓòÉΓòÉΓòÉ
  3345.  
  3346. getAlignment() const 
  3347.  
  3348. Returns horizontal alignment (see "Alignment constants"). 
  3349.  
  3350. int 
  3351.  
  3352.  
  3353. ΓòÉΓòÉΓòÉ 2.8.2.2. MFormat::getBkgColor() ΓòÉΓòÉΓòÉ
  3354.  
  3355. getBkgColor() const 
  3356.  
  3357. Returns background color (see MColor). 
  3358.  
  3359. MColor 
  3360.  
  3361.  
  3362. ΓòÉΓòÉΓòÉ 2.8.2.3. MFormat::getBorder() ΓòÉΓòÉΓòÉ
  3363.  
  3364. getBorder(int) const 
  3365.  
  3366.       int   Which border? 
  3367.  
  3368.  Returns width of the given border (see "Border constants"), in pixels. 
  3369.  
  3370.  int 
  3371.  
  3372.  
  3373. ΓòÉΓòÉΓòÉ 2.8.2.4. MFormat::getBorderColor() ΓòÉΓòÉΓòÉ
  3374.  
  3375. getBorderColor(int) const 
  3376.  
  3377.       int         Which border? 
  3378.  
  3379.  Returns color of the given border (see "Border constants"). 
  3380.  
  3381.  MColor 
  3382.  
  3383.  
  3384. ΓòÉΓòÉΓòÉ 2.8.2.5. MFormat::getClearBkg() ΓòÉΓòÉΓòÉ
  3385.  
  3386. getClearBkg() const 
  3387.  
  3388. Returns 1 if the background is clear, 0 otherwise. 
  3389.  
  3390. int 
  3391.  
  3392.  
  3393. ΓòÉΓòÉΓòÉ 2.8.2.6. MFormat::getFont() ΓòÉΓòÉΓòÉ
  3394.  
  3395. getFont() const 
  3396.  
  3397. Returns an index into the MFont array maintained by the model, indicating the 
  3398. font/typeface/size of the current format. For more information, see "MFont". 
  3399.  
  3400. int 
  3401.  
  3402.  
  3403. ΓòÉΓòÉΓòÉ 2.8.2.7. MFormat::getFormat() ΓòÉΓòÉΓòÉ
  3404.  
  3405. getFormat() const 
  3406.  
  3407. Returns the display format ID (eg; dateYYMMDDFormat, timeHM24Format, etc.). For 
  3408. more information, see "Display format constants". 
  3409.  
  3410. int 
  3411.  
  3412.  
  3413. ΓòÉΓòÉΓòÉ 2.8.2.8. MFormat::getFormatSansPrec() ΓòÉΓòÉΓòÉ
  3414.  
  3415. getFormatSansPrec() const 
  3416.  
  3417. Returns display format specifier, consolidating numeric formats. For more 
  3418. information, see "Display format constants". 
  3419.  
  3420. int 
  3421.  
  3422.  
  3423. ΓòÉΓòÉΓòÉ 2.8.2.9. MFormat::getHidden() ΓòÉΓòÉΓòÉ
  3424.  
  3425. getHidden() const 
  3426.  
  3427. Returns 1 if the format is hidden, 0 otherwise. For more information, see 
  3428. "Display format constants". 
  3429.  
  3430. int 
  3431.  
  3432.  
  3433. ΓòÉΓòÉΓòÉ 2.8.2.10. MFormat::getInputType() ΓòÉΓòÉΓòÉ
  3434.  
  3435. getInputType() const 
  3436.  
  3437. Returns input type specifier, which determines what kind of values can be 
  3438. entered. For more information, see "Input type constants". 
  3439.  
  3440. int 
  3441.  
  3442.  
  3443. ΓòÉΓòÉΓòÉ 2.8.2.11. MFormat::getPrecision() ΓòÉΓòÉΓòÉ
  3444.  
  3445. getPrecision() const 
  3446.  
  3447. Returns degree of precision (see "Display format constants"). 
  3448.  
  3449. int 
  3450.  
  3451.  
  3452. ΓòÉΓòÉΓòÉ 2.8.2.12. MFormat::getProtected() ΓòÉΓòÉΓòÉ
  3453.  
  3454. getProtected() const 
  3455.  
  3456. Returns 1 if the format is protected, 0 otherwise (see "Input type constants"). 
  3457.  
  3458. int 
  3459.  
  3460.  
  3461. ΓòÉΓòÉΓòÉ 2.8.2.13. MFormat::getTextColor() ΓòÉΓòÉΓòÉ
  3462.  
  3463. getTextColor() const 
  3464.  
  3465. Returns color of text display. 
  3466.  
  3467. MColor 
  3468.  
  3469.  
  3470. ΓòÉΓòÉΓòÉ 2.8.2.14. MFormat::getUnderline() ΓòÉΓòÉΓòÉ
  3471.  
  3472. getUnderline() const 
  3473.  
  3474. Returns underline setting (see "Underline constants"). 
  3475.  
  3476. int 
  3477.  
  3478.  
  3479. ΓòÉΓòÉΓòÉ 2.8.2.15. MFormat::getVertAlign() ΓòÉΓòÉΓòÉ
  3480.  
  3481. getVertAlign() const 
  3482.  
  3483. Returns vertical alignment (see "Alignment constants"). 
  3484.  
  3485. int 
  3486.  
  3487.  
  3488. ΓòÉΓòÉΓòÉ 2.8.2.16. MFormat::getWrap() ΓòÉΓòÉΓòÉ
  3489.  
  3490. getWrap() const 
  3491.  
  3492. Returns 1 if word-wrapping is enabled, 0 otherwise (see "Alignment constants"). 
  3493.  
  3494. int 
  3495.  
  3496.  
  3497. ΓòÉΓòÉΓòÉ 2.8.2.17. MFormat::hasBorders() ΓòÉΓòÉΓòÉ
  3498.  
  3499. hasBorders() const 
  3500.  
  3501. Returns 1 if any borders are set to non-zero widths; 0 otherwise. 
  3502.  
  3503. int 
  3504.  
  3505.  
  3506. ΓòÉΓòÉΓòÉ 2.8.3. Retrieving merge flags from an MFormat instance ΓòÉΓòÉΓòÉ
  3507.  
  3508. Open the Contents view and expand this section to see a list of methods. 
  3509.  
  3510.  
  3511. ΓòÉΓòÉΓòÉ 2.8.3.1. MFormat::getMergeAlignment() ΓòÉΓòÉΓòÉ
  3512.  
  3513. getMergeAlignment() const 
  3514.  
  3515. Returns 1 if the merge operation will include the horizontal alignment, 0 
  3516. otherwise. 
  3517.  
  3518. int 
  3519.  
  3520.  
  3521. ΓòÉΓòÉΓòÉ 2.8.3.2. MFormat::getMergeBkgColor() ΓòÉΓòÉΓòÉ
  3522.  
  3523. getMergeBkgColor() const 
  3524.  
  3525. Returns 1 if the merge operation will include the background color, 0 
  3526. otherwise. 
  3527.  
  3528. int 
  3529.  
  3530.  
  3531. ΓòÉΓòÉΓòÉ 2.8.3.3. MFormat::getMergeBorder1() ΓòÉΓòÉΓòÉ
  3532.  
  3533. getMergeBorder1() const 
  3534.  
  3535. Returns 1 if the merge operation will include left border width, 0 otherwise. 
  3536.  
  3537. int 
  3538.  
  3539.  
  3540. ΓòÉΓòÉΓòÉ 2.8.3.4. MFormat::getMergeBorder2() ΓòÉΓòÉΓòÉ
  3541.  
  3542. getMergeBorder2() const 
  3543.  
  3544. Returns 1 if the merge operation will include right border width, 0 otherwise. 
  3545.  
  3546. int 
  3547.  
  3548.  
  3549. ΓòÉΓòÉΓòÉ 2.8.3.5. MFormat::getMergeBorder3() ΓòÉΓòÉΓòÉ
  3550.  
  3551. getMergeBorder3() const 
  3552.  
  3553. Returns 1 if the merge operation will include top border width, 0 otherwise. 
  3554.  
  3555. int 
  3556.  
  3557.  
  3558. ΓòÉΓòÉΓòÉ 2.8.3.6. MFormat::getMergeBorder4() ΓòÉΓòÉΓòÉ
  3559.  
  3560. getMergeBorder4() const 
  3561.  
  3562. Returns 1 if the merge operation will include bottom border width, 0 otherwise. 
  3563.  
  3564. int 
  3565.  
  3566.  
  3567. ΓòÉΓòÉΓòÉ 2.8.3.7. MFormat::getMergeBorderColor1() ΓòÉΓòÉΓòÉ
  3568.  
  3569. getMergeBorderColor1() const 
  3570.  
  3571. Returns 1 if the merge operation will include left border color, 0 otherwise. 
  3572.  
  3573. int 
  3574.  
  3575.  
  3576. ΓòÉΓòÉΓòÉ 2.8.3.8. MFormat::getMergeBorderColor2() ΓòÉΓòÉΓòÉ
  3577.  
  3578. getMergeBorderColor2() const 
  3579.  
  3580. Returns 1 if the merge operation will include right border color, 0 otherwise. 
  3581.  
  3582. int 
  3583.  
  3584.  
  3585. ΓòÉΓòÉΓòÉ 2.8.3.9. MFormat::getMergeBorderColor3() ΓòÉΓòÉΓòÉ
  3586.  
  3587. getMergeBorderColor3() const 
  3588.  
  3589. Returns 1 if the merge operation will include top border color, 0 otherwise. 
  3590.  
  3591. int 
  3592.  
  3593.  
  3594. ΓòÉΓòÉΓòÉ 2.8.3.10. MFormat::getMergeBorderColor4() ΓòÉΓòÉΓòÉ
  3595.  
  3596. getMergeBorderColor4() const 
  3597.  
  3598. Returns 1 if the merge operation will include bottom border color, 0 otherwise. 
  3599.  
  3600. int 
  3601.  
  3602.  
  3603. ΓòÉΓòÉΓòÉ 2.8.3.11. MFormat::getMergeFont() ΓòÉΓòÉΓòÉ
  3604.  
  3605. getMergeFont() const 
  3606.  
  3607. Returns 1 if the merge operation will include the font, 0 otherwise. 
  3608.  
  3609. int 
  3610.  
  3611.  
  3612. ΓòÉΓòÉΓòÉ 2.8.3.12. MFormat::getMergeFormat() ΓòÉΓòÉΓòÉ
  3613.  
  3614. getMergeFormat() const 
  3615.  
  3616. Returns 1 if the merge operation will include the display format ID, 0 
  3617. otherwise. 
  3618.  
  3619. int 
  3620.  
  3621.  
  3622. ΓòÉΓòÉΓòÉ 2.8.3.13. MFormat::getMergeHidden() ΓòÉΓòÉΓòÉ
  3623.  
  3624. getMergeHidden() const 
  3625.  
  3626. Returns 1 if the merge operation will include the hidden status, 0 otherwise. 
  3627.  
  3628. int 
  3629.  
  3630.  
  3631. ΓòÉΓòÉΓòÉ 2.8.3.14. MFormat::getMergeInputType() ΓòÉΓòÉΓòÉ
  3632.  
  3633. getMergeInputType() const 
  3634.  
  3635. Returns 1 if the merge operation will include the input type, 0 otherwise. 
  3636.  
  3637. int 
  3638.  
  3639.  
  3640. ΓòÉΓòÉΓòÉ 2.8.3.15. MFormat::getMergePrecision() ΓòÉΓòÉΓòÉ
  3641.  
  3642. getMergePrecision() const 
  3643.  
  3644. Returns 1 if the merge operation will include the precision status, 0 
  3645. otherwise. 
  3646.  
  3647. int 
  3648.  
  3649.  
  3650. ΓòÉΓòÉΓòÉ 2.8.3.16. MFormat::getMergeProtected() ΓòÉΓòÉΓòÉ
  3651.  
  3652. getMergeProtected() const 
  3653.  
  3654. Returns 1 if the merge operation will include the protected status, 0 
  3655. otherwise. 
  3656.  
  3657. int 
  3658.  
  3659.  
  3660. ΓòÉΓòÉΓòÉ 2.8.3.17. MFormat::getMergeTextColor() ΓòÉΓòÉΓòÉ
  3661.  
  3662. getMergeTextColor() const 
  3663.  
  3664. Returns 1 if the merge operation will include the text color, 0 otherwise. 
  3665.  
  3666. int 
  3667.  
  3668.  
  3669. ΓòÉΓòÉΓòÉ 2.8.3.18. MFormat::getMergeScriptOnInput() ΓòÉΓòÉΓòÉ
  3670.  
  3671. getMergeScriptOnInput() const 
  3672.  
  3673. Returns 1 if the merge operation will include the script to run on user-input, 
  3674. 0 otherwise. 
  3675.  
  3676. int 
  3677.  
  3678.  
  3679. ΓòÉΓòÉΓòÉ 2.8.3.19. MFormat::getMergeUnderline() ΓòÉΓòÉΓòÉ
  3680.  
  3681. getMergeUnderline() const 
  3682.  
  3683. Returns 1 if the merge operation will include the underline status, 0 
  3684. otherwise. 
  3685.  
  3686. int 
  3687.  
  3688.  
  3689. ΓòÉΓòÉΓòÉ 2.8.3.20. MFormat::getMergeVertAlign() ΓòÉΓòÉΓòÉ
  3690.  
  3691. getMergeVertAlign() const 
  3692.  
  3693. Returns 1 if the merge operation will include the vertical alignment status, 0 
  3694. otherwise. 
  3695.  
  3696. int 
  3697.  
  3698.  
  3699. ΓòÉΓòÉΓòÉ 2.8.3.21. MFormat::getMergeWrap() ΓòÉΓòÉΓòÉ
  3700.  
  3701. getMergeWrap() const 
  3702.  
  3703. Returns 1 if the merge operation will include the word-wrap status, 0 
  3704. otherwise. 
  3705.  
  3706. int 
  3707.  
  3708.  
  3709. ΓòÉΓòÉΓòÉ 2.8.4. Setting merge flags in an MFormat instance ΓòÉΓòÉΓòÉ
  3710.  
  3711. Open the Contents view and expand this section to see a list of methods. 
  3712.  
  3713.  
  3714. ΓòÉΓòÉΓòÉ 2.8.4.1. MFormat::setMergeAlignment() ΓòÉΓòÉΓòÉ
  3715.  
  3716. setMergeAlignment(int i) 
  3717.  
  3718.       int i   1 to merge, 0 to not merge 
  3719.  
  3720.  Sets the merge flag for horizontal alignment. 
  3721.  
  3722.  void 
  3723.  
  3724.  
  3725. ΓòÉΓòÉΓòÉ 2.8.4.2. MFormat::setMergeBkgColor() ΓòÉΓòÉΓòÉ
  3726.  
  3727. setMergeBkgColor(int i) 
  3728.  
  3729.       int i   1 to merge, 0 to not merge 
  3730.  
  3731.  Sets the merge flag for background color. 
  3732.  
  3733.  void 
  3734.  
  3735.  
  3736. ΓòÉΓòÉΓòÉ 2.8.4.3. MFormat::setMergeBorder1() ΓòÉΓòÉΓòÉ
  3737.  
  3738. setMergeBorder1(int i) 
  3739.  
  3740.       int i   1 to merge, 0 to not merge 
  3741.  
  3742.  Sets the merge flag for the left border width. 
  3743.  
  3744.  void 
  3745.  
  3746.  
  3747. ΓòÉΓòÉΓòÉ 2.8.4.4. MFormat::setMergeBorder2() ΓòÉΓòÉΓòÉ
  3748.  
  3749. setMergeBorder2(int i) 
  3750.  
  3751.       int i   1 to merge, 0 to not merge 
  3752.  
  3753.  Sets the merge flag for the right border width. 
  3754.  
  3755.  void 
  3756.  
  3757.  
  3758. ΓòÉΓòÉΓòÉ 2.8.4.5. MFormat::setMergeBorder3() ΓòÉΓòÉΓòÉ
  3759.  
  3760. setMergeBorder3(int i) 
  3761.  
  3762.       int i   1 to merge, 0 to not merge 
  3763.  
  3764.  Sets the merge flag for the top border width. 
  3765.  
  3766.  void 
  3767.  
  3768.  
  3769. ΓòÉΓòÉΓòÉ 2.8.4.6. MFormat::setMergeBorder4() ΓòÉΓòÉΓòÉ
  3770.  
  3771. setMergeBorder4(int i) 
  3772.  
  3773.       int i   1 to merge, 0 to not merge 
  3774.  
  3775.  Sets the merge flag for the bottom border width. 
  3776.  
  3777.  void 
  3778.  
  3779.  
  3780. ΓòÉΓòÉΓòÉ 2.8.4.7. MFormat::setMergeBorderColor1() ΓòÉΓòÉΓòÉ
  3781.  
  3782. setMergeBorderColor1(int i) 
  3783.  
  3784.       int i   1 to merge, 0 to not merge 
  3785.  
  3786.  Sets the merge flag for the left border color. 
  3787.  
  3788.  void 
  3789.  
  3790.  
  3791. ΓòÉΓòÉΓòÉ 2.8.4.8. MFormat::setMergeBorderColor2() ΓòÉΓòÉΓòÉ
  3792.  
  3793. setMergeBorderColor2(int i) 
  3794.  
  3795.       int i   1 to merge, 0 to not merge 
  3796.  
  3797.  Sets the merge flag for the right border color. 
  3798.  
  3799.  void 
  3800.  
  3801.  
  3802. ΓòÉΓòÉΓòÉ 2.8.4.9. MFormat::setMergeBorderColor3() ΓòÉΓòÉΓòÉ
  3803.  
  3804. setMergeBorderColor3(int i) 
  3805.  
  3806.       int i   1 to merge, 0 to not merge 
  3807.  
  3808.  Sets the merge flag for the top border color. 
  3809.  
  3810.  void 
  3811.  
  3812.  
  3813. ΓòÉΓòÉΓòÉ 2.8.4.10. MFormat::setMergeBorderColor4() ΓòÉΓòÉΓòÉ
  3814.  
  3815. setMergeBorderColor4(int i) 
  3816.  
  3817.       int i   1 to merge, 0 to not merge 
  3818.  
  3819.  Sets the merge flag for the bottom border color. 
  3820.  
  3821.  void 
  3822.  
  3823.  
  3824. ΓòÉΓòÉΓòÉ 2.8.4.11. MFormat::setMergeFont() ΓòÉΓòÉΓòÉ
  3825.  
  3826. setMergeFont(int i) 
  3827.  
  3828.       int i   1 to merge, 0 to not merge 
  3829.  
  3830.  Sets the merge flag for the font. 
  3831.  
  3832.  void 
  3833.  
  3834.  
  3835. ΓòÉΓòÉΓòÉ 2.8.4.12. MFormat::setMergeFormat() ΓòÉΓòÉΓòÉ
  3836.  
  3837. setMergeFormat(int i) 
  3838.  
  3839.       int i   1 to merge, 0 to not merge 
  3840.  
  3841.  Sets the merge flag for the display format ID. 
  3842.  
  3843.  void 
  3844.  
  3845.  
  3846. ΓòÉΓòÉΓòÉ 2.8.4.13. MFormat::setMergeHidden() ΓòÉΓòÉΓòÉ
  3847.  
  3848. setMergeHidden(int i) 
  3849.  
  3850.       int i   1 to merge, 0 to not merge 
  3851.  
  3852.  Sets the merge flag for hidden status. 
  3853.  
  3854.  void 
  3855.  
  3856.  
  3857. ΓòÉΓòÉΓòÉ 2.8.4.14. MFormat::setMergeInputType() ΓòÉΓòÉΓòÉ
  3858.  
  3859. setMergeInputType(int i) 
  3860.  
  3861.       int i   1 to merge, 0 to not merge 
  3862.  
  3863.  Sets the merge flag for input type. 
  3864.  
  3865.  void 
  3866.  
  3867.  
  3868. ΓòÉΓòÉΓòÉ 2.8.4.15. MFormat::setMergePrecision() ΓòÉΓòÉΓòÉ
  3869.  
  3870. setMergePrecision(int i) 
  3871.  
  3872.       int i   1 to merge, 0 to not merge 
  3873.  
  3874.  Sets the merge flag for precision. 
  3875.  
  3876.  void 
  3877.  
  3878.  
  3879. ΓòÉΓòÉΓòÉ 2.8.4.16. MFormat::setMergeProtected() ΓòÉΓòÉΓòÉ
  3880.  
  3881. setMergeProtected(int i) 
  3882.  
  3883.       int i   1 to merge, 0 to not merge 
  3884.  
  3885.  Sets the merge flag for protected status. 
  3886.  
  3887.  void 
  3888.  
  3889.  
  3890. ΓòÉΓòÉΓòÉ 2.8.4.17. MFormat::setMergeTextColor() ΓòÉΓòÉΓòÉ
  3891.  
  3892. setMergeTextColor(int i) 
  3893.  
  3894.       int i   1 to merge, 0 to not merge 
  3895.  
  3896.  Sets the merge flag for text color. 
  3897.  
  3898.  void 
  3899.  
  3900.  
  3901. ΓòÉΓòÉΓòÉ 2.8.4.18. MFormat::setMergeUnderline() ΓòÉΓòÉΓòÉ
  3902.  
  3903. setMergeUnderline(int i) 
  3904.  
  3905.       int i   1 to merge, 0 to not merge 
  3906.  
  3907.  Sets the merge flag for underline setting. 
  3908.  
  3909.  void 
  3910.  
  3911.  
  3912. ΓòÉΓòÉΓòÉ 2.8.4.19. MFormat::setMergeVertAlign() ΓòÉΓòÉΓòÉ
  3913.  
  3914. setMergeVertAlign(int i) 
  3915.  
  3916.       int i   1 to merge, 0 to not merge 
  3917.  
  3918.  Sets the merge flag for vertical alignment. 
  3919.  
  3920.  void 
  3921.  
  3922.  
  3923. ΓòÉΓòÉΓòÉ 2.8.4.20. MFormat::setMergeWrap() ΓòÉΓòÉΓòÉ
  3924.  
  3925. setMergeWrap(int i) 
  3926.  
  3927.       int i   1 to merge, 0 to not merge 
  3928.  
  3929.  Sets the merge flag for word-wrapping status. 
  3930.  
  3931.  void 
  3932.  
  3933.  
  3934. ΓòÉΓòÉΓòÉ 2.8.5. Changing values in an MFormat instance ΓòÉΓòÉΓòÉ
  3935.  
  3936. Open the Contents view and expand this section to see a list of methods. 
  3937.  
  3938.  
  3939. ΓòÉΓòÉΓòÉ 2.8.5.1. MFormat::mergeFormat() ΓòÉΓòÉΓòÉ
  3940.  
  3941. mergeFormat(const MFormat &fm) 
  3942.  
  3943.       const MFormat &fm   Source MFormat instance to be merged into current 
  3944.       instance 
  3945.  
  3946.  Sets some, though not all, of the properties of the current MFormat instance 
  3947.  to the values of those properties within fm. Only those properties for which 
  3948.  the associated merge flag has been set in fm are changed. 
  3949.  
  3950.  void 
  3951.  
  3952.  
  3953. ΓòÉΓòÉΓòÉ 2.8.5.2. MFormat::setAlignment() ΓòÉΓòÉΓòÉ
  3954.  
  3955. setAlignment(int) 
  3956.  
  3957.       int   New horizontal alignment. 
  3958.  
  3959.  Sets horizontal alignment (see "Alignment constants"). 
  3960.  
  3961.  void 
  3962.  
  3963.  
  3964. ΓòÉΓòÉΓòÉ 2.8.5.3. MFormat::setBkgColor() ΓòÉΓòÉΓòÉ
  3965.  
  3966. setBkgColor(int) 
  3967.  
  3968.       int   Color constant 
  3969.  
  3970.  Sets background to the given color (see "Color constants"). 
  3971.  
  3972.  void 
  3973.  
  3974.  setBkgColor(MColor) 
  3975.  
  3976.       MColor   MColor instance 
  3977.  
  3978.  Sets background color identical to the given MColor (see MColor). 
  3979.  
  3980.  void 
  3981.  
  3982.  
  3983. ΓòÉΓòÉΓòÉ 2.8.5.4. MFormat::setBorder() ΓòÉΓòÉΓòÉ
  3984.  
  3985. setBorder(int, int) 
  3986.  
  3987.       int   Which border? 
  3988.  
  3989.       int   Size of border 
  3990.  
  3991.  Sets the given border to the given width (see "Border constants"). 
  3992.  
  3993.  void 
  3994.  
  3995.  
  3996. ΓòÉΓòÉΓòÉ 2.8.5.5. MFormat::setBorderColor() ΓòÉΓòÉΓòÉ
  3997.  
  3998. setBorderColor(int, MColor) 
  3999.  
  4000.       int   Which border 
  4001.  
  4002.       MColor   New color 
  4003.  
  4004.  Sets the given border to the given color (see "Border constants"). 
  4005.  
  4006.  void 
  4007.  
  4008.  
  4009. ΓòÉΓòÉΓòÉ 2.8.5.6. MFormat::setClearBkg() ΓòÉΓòÉΓòÉ
  4010.  
  4011. setClearBkg(int clr) 
  4012.  
  4013.       int clr   Clear (1) or opaque (0)? 
  4014.  
  4015.  Sets the background clear or opaque based on the value of clr. 
  4016.  
  4017.  void 
  4018.  
  4019.  
  4020. ΓòÉΓòÉΓòÉ 2.8.5.7. MFormat::setFont() ΓòÉΓòÉΓòÉ
  4021.  
  4022. setFont(int N) 
  4023.  
  4024.       int N   Index into MFont array 
  4025.  
  4026.  Sets the font to the Nth item in the model's MFont array. For more 
  4027.  information, see "MFont". 
  4028.  
  4029.  void 
  4030.  
  4031.  
  4032. ΓòÉΓòÉΓòÉ 2.8.5.8. MFormat::setFormat() ΓòÉΓòÉΓòÉ
  4033.  
  4034. setFormat(const char *, int) 
  4035.  
  4036.       const char *   Name of new display format 
  4037.  
  4038.       int   New precision 
  4039.  
  4040.  Looks up the display format ID for the named display format, and sets the 
  4041.  display and precision accordingly (see "Display format constants"). Returns 1 
  4042.  if the named display format actually exists, 0 otherwise. 
  4043.  
  4044.  int 
  4045.  
  4046.  setFormat(int) 
  4047.  
  4048.       int   New display format ID 
  4049.  
  4050.  Sets the display format ID and precision to the values passed in (see "Display 
  4051.  format constants"). 
  4052.  
  4053.  void 
  4054.  
  4055.  
  4056. ΓòÉΓòÉΓòÉ 2.8.5.9. MFormat::setHidden() ΓòÉΓòÉΓòÉ
  4057.  
  4058. setHidden(int) 
  4059.  
  4060.       int   New hidden status (TRUE for hidden, FALSE for unhidden) 
  4061.  
  4062.  Sets hidden status (see "Display format constants"). 
  4063.  
  4064.  void 
  4065.  
  4066.  
  4067. ΓòÉΓòÉΓòÉ 2.8.5.10. MFormat::setInputType() ΓòÉΓòÉΓòÉ
  4068.  
  4069. setInputType(int) 
  4070.  
  4071.       int   New input type 
  4072.  
  4073.  Sets input type (see "Input type constants"). 
  4074.  
  4075.  void 
  4076.  
  4077.  
  4078. ΓòÉΓòÉΓòÉ 2.8.5.11. MFormat::setPrecision() ΓòÉΓòÉΓòÉ
  4079.  
  4080. setPrecision(int) 
  4081.  
  4082.       int   New precision 
  4083.  
  4084.  Sets precision (see "Display format constants"). 
  4085.  
  4086.  void 
  4087.  
  4088.  
  4089. ΓòÉΓòÉΓòÉ 2.8.5.12. MFormat::setProtected() ΓòÉΓòÉΓòÉ
  4090.  
  4091. setProtected(int) 
  4092.  
  4093.       int   1 for protected, 0 for unprotected. 
  4094.  
  4095.  Sets protection status (see "Input type constants"). 
  4096.  
  4097.  void 
  4098.  
  4099.  
  4100. ΓòÉΓòÉΓòÉ 2.8.5.13. MFormat::setTextColor() ΓòÉΓòÉΓòÉ
  4101.  
  4102. setTextColor(int col) 
  4103.  
  4104.       int col   New color for text 
  4105.  
  4106.  Sets the text color to col, where col is a packed data structure of the form 
  4107.  r<<16 + g <<8 + b. 
  4108.  
  4109.  void 
  4110.  
  4111.  setTextColor(MColor) 
  4112.  
  4113.       MColor   New MColor instance for text 
  4114.  
  4115.  Sets the text color to the value passed in. 
  4116.  
  4117.  void 
  4118.  
  4119.  
  4120. ΓòÉΓòÉΓòÉ 2.8.5.14. MFormat::setUnderline() ΓòÉΓòÉΓòÉ
  4121.  
  4122. setUnderline(int) 
  4123.  
  4124.       int   New underline value 
  4125.  
  4126.  Sets underline setting to the value passed in (see "Underline constants"). 
  4127.  
  4128.  void 
  4129.  
  4130.  
  4131. ΓòÉΓòÉΓòÉ 2.8.5.15. MFormat::setVertAlign() ΓòÉΓòÉΓòÉ
  4132.  
  4133. setVertAlign(int) 
  4134.  
  4135.       int   New vertical alignment setting 
  4136.  
  4137.  Sets vertical alignment (see "Alignment constants"). 
  4138.  
  4139.  void 
  4140.  
  4141.  
  4142. ΓòÉΓòÉΓòÉ 2.8.5.16. MFormat::setWrap() ΓòÉΓòÉΓòÉ
  4143.  
  4144. setWrap(int) 
  4145.  
  4146.       int   1 for word-wrap, 0 for no word-wrap 
  4147.  
  4148.  Turns word-wrapping on or off. 
  4149.  
  4150.  void 
  4151.  
  4152.  
  4153. ΓòÉΓòÉΓòÉ 2.8.6. Outputting an MFormat instance ΓòÉΓòÉΓòÉ
  4154.  
  4155. Open the Contents view and expand this section to see a list of methods. 
  4156.  
  4157.  
  4158. ΓòÉΓòÉΓòÉ 2.8.6.1. MFormat::write() ΓòÉΓòÉΓòÉ
  4159.  
  4160. write(MStream *st) 
  4161.  
  4162.       MStream *st   Output stream 
  4163.  
  4164.  Outputs the format to st (see MStream). 
  4165.  
  4166.  void 
  4167.  
  4168.  
  4169. ΓòÉΓòÉΓòÉ 2.8.7. MFormat operators ΓòÉΓòÉΓòÉ
  4170.  
  4171. Open the Contents view and expand this section to see a list of methods. 
  4172.  
  4173.  
  4174. ΓòÉΓòÉΓòÉ 2.8.7.1. MFormat::operator==() ΓòÉΓòÉΓòÉ
  4175.  
  4176. operator==(const MFormat &mf) const 
  4177.  
  4178.       const MFormat &   MFormat instance to compare to 
  4179.  
  4180.  Returns 1 if all properties of the two formats are identical, 0 otherwise. 
  4181.  Ignores merge flags. 
  4182.  
  4183.  int 
  4184.  
  4185.  
  4186. ΓòÉΓòÉΓòÉ 2.9. MFrameXfer ΓòÉΓòÉΓòÉ
  4187.  
  4188. xfer.h is the source file for this class. 
  4189.  
  4190. This class inherits from MObject 
  4191.  
  4192. Stores information about a Mesa graphic object (for example, a graph or a 
  4193. geometric shape),otherwise known as a frame. 
  4194.  
  4195. Mesa frames are represented by some subclass of MFrame, and each model 
  4196. maintains a list of existing frames (see MMesaModel). An MFrameXfer instance is 
  4197. used to query the properties of an existing frame by means of various accessor 
  4198. member functions. It can also be merged with an existing frame, thereby 
  4199. altering the frame's properties. MFrameXfer is almost completely made up of 
  4200. accessor and initializer member functions. 
  4201.  
  4202.  
  4203. ΓòÉΓòÉΓòÉ 2.9.1. Contents of a frame ΓòÉΓòÉΓòÉ
  4204.  
  4205. Open the Contents view and expand this section to see a list of methods. 
  4206.  
  4207. Each frame can contain the following information, which can be accessed and 
  4208. altered through an MFrameXfer instance: 
  4209.  
  4210.      Frame type (see "Frame constants") 
  4211.  
  4212.      Name 
  4213.  
  4214.       Each frame is automatically named "Graph #" when it is created, where # 
  4215.       is the next available number. That is, the first three frames created 
  4216.       within a model will be automatically named "Graph 1", "Graph 2", and 
  4217.       "Graph 3". 
  4218.  
  4219.      Location and size (see MRect) 
  4220.  
  4221.      Z-order - if multiple frames overlap one another, which one is drawn on 
  4222.       top? 
  4223.  
  4224.      Border width and color (if a graph, border width also controls several 
  4225.       other line widths) 
  4226.  
  4227.      Background color (see MColor) 
  4228.  
  4229.      Anchor cell (every frame is associated with a single cell in the model; 
  4230.       A1 by default) 
  4231.  
  4232.      Should the frame execute a REXX script when selected? If so, what's the 
  4233.       script? 
  4234.  
  4235.  If the frame is a graph, the following additional data is available: 
  4236.  
  4237.      The range being graphed, its orientation (see "Graph orientation 
  4238.       constants"), how many X axes it contains (single or multiple), and 
  4239.       whether it contains headings as well as data. 
  4240.  
  4241.      What color are the axes? 
  4242.  
  4243.       Note that while many axis elements are controllable separately for the X 
  4244.       and Y axis (see below), the two axes are treated as a single element for 
  4245.       color and font purposes. 
  4246.  
  4247.      How many graph elements (e.g.; columns) are there to draw? 
  4248.  
  4249.      Should a legend be drawn? If so, where (see "Graph legend constants"), 
  4250.       and what should it look like (foreground and background color, font, 
  4251.       etc.)? 
  4252.  
  4253.      Should a title and/or subtitle be included? If so, what should they look 
  4254.       like (colors, fonts, etc.)? 
  4255.  
  4256.      If a line or scatter graph, should the lines be drawn, or just the 
  4257.       points, or both? 
  4258.  
  4259.      Widths of bars and columns 
  4260.  
  4261.  If the graph contains axes (e.g; a bar graph), the following additional data 
  4262.  is available for each axis: 
  4263.  
  4264.      Does it have a title? If so, what should it look like (foreground and 
  4265.       background color, font, etc.)? 
  4266.  
  4267.      Where is it located (e.g.; is the Y axis at the left, the right, or the 
  4268.       zero-point of the X axis)? 
  4269.  
  4270.      What are the sizes and locations of ticks on this axis? 
  4271.  
  4272.       Each axis contains major ticks and minor ticks, the length and alignment 
  4273.       of which is user-customizable, and the location of which is derived from 
  4274.       the data being graphed. 
  4275.  
  4276.      Are there gridlines drawn from the ticks on this axis? If so, from which 
  4277.       ticks and in what color? 
  4278.  
  4279.      What are the minimum and maximum values that appear on the axis? Is it 
  4280.       linear or logarythmic? 
  4281.  
  4282.      Where are the axis labels drawn from? What should they look like 
  4283.       (rotation, display format, etc.)? 
  4284.  
  4285.  If the frame is a three-dimensional graph, the following additional data is 
  4286.  available: 
  4287.  
  4288.      Background color for the three-dimensional "wall". 
  4289.  
  4290.      Should the graph elements be drawn in solid colors or as "wire frame" 
  4291.       outlines? 
  4292.  
  4293.  Additionally, every MFrameXfer instance contains a merge flag for each of the 
  4294.  abovementioned properties, which controls whether or not that property is 
  4295.  changed when an MFrameXfer instance is merged with an MFrame instance. 
  4296.  Whenever the value of an MFrameXfer property is set, the merge flag for that 
  4297.  property is also set. 
  4298.  
  4299.  
  4300. ΓòÉΓòÉΓòÉ 2.9.2. Creating, destroying, and initializing an MFrameXfer instance ΓòÉΓòÉΓòÉ
  4301.  
  4302. Open the Contents view and expand this section to see a list of methods. 
  4303.  
  4304.  
  4305. ΓòÉΓòÉΓòÉ 2.9.2.1. MFrameXfer::MFrameXfer() ΓòÉΓòÉΓòÉ
  4306.  
  4307. MFrameXfer(MStream *st) 
  4308.  
  4309.       MStream *st   Input stream 
  4310.  
  4311.  Creates a new MFrameXfer instance with values read from st (see MStream). 
  4312.  
  4313.  void 
  4314.  
  4315.  MFrameXfer() 
  4316.  
  4317.  Creates a new MFrameXfer instance with default values. 
  4318.  
  4319.  void 
  4320.  
  4321.  MFrameXfer(const MFrameXfer *) 
  4322.  
  4323.       const MFrameXfer * 
  4324.  
  4325.  Creates a new MFrameXfer instance with values read from the instance passed 
  4326.  in. 
  4327.  
  4328.  void 
  4329.  
  4330.  
  4331. ΓòÉΓòÉΓòÉ 2.9.2.2. MFrameXfer::~MFrameXfer() ΓòÉΓòÉΓòÉ
  4332.  
  4333. ~MFrameXfer() [virtual] 
  4334.  
  4335. Destroys the instance and frees all allocated resources. 
  4336.  
  4337. void 
  4338.  
  4339.  
  4340. ΓòÉΓòÉΓòÉ 2.9.3. Identifying the frame type ΓòÉΓòÉΓòÉ
  4341.  
  4342. Open the Contents view and expand this section to see a list of methods. 
  4343.  
  4344.  
  4345. ΓòÉΓòÉΓòÉ 2.9.3.1. MFrameXfer::getFrameClass() ΓòÉΓòÉΓòÉ
  4346.  
  4347. getFrameClass() const [virtual] 
  4348.  
  4349. Returns the type of frame (see "Frame constants"). 
  4350.  
  4351. int 
  4352.  
  4353.  
  4354. ΓòÉΓòÉΓòÉ 2.9.3.2. MFrameXfer::isChartClass() ΓòÉΓòÉΓòÉ
  4355.  
  4356. isChartClass() const [virtual] 
  4357.  
  4358. Returns 1 if the frame is a graph, 0 otherwise (see "Frame constants"). 
  4359.  
  4360. int 
  4361.  
  4362.  
  4363. ΓòÉΓòÉΓòÉ 2.9.3.3. MFrameXfer::isImageClass() ΓòÉΓòÉΓòÉ
  4364.  
  4365. isImageClass() const [virtual] 
  4366.  
  4367. Returns 1 if the frame is an imported bitmap, 0 otherwise (see "Frame 
  4368. constants"). 
  4369.  
  4370. int 
  4371.  
  4372.  
  4373. ΓòÉΓòÉΓòÉ 2.9.3.4. MFrameXfer::isShapeClass() ΓòÉΓòÉΓòÉ
  4374.  
  4375. isShapeClass() const [virtual] 
  4376.  
  4377. Returns 1 if the frame is a shape, 0 otherwise (see "Frame constants"). 
  4378.  
  4379. int 
  4380.  
  4381.  
  4382. ΓòÉΓòÉΓòÉ 2.9.4. Setting the frame type ΓòÉΓòÉΓòÉ
  4383.  
  4384. Open the Contents view and expand this section to see a list of methods. 
  4385.  
  4386.  
  4387. ΓòÉΓòÉΓòÉ 2.9.4.1. MFrameXfer::setFrameClass() ΓòÉΓòÉΓòÉ
  4388.  
  4389. setFrameClass(int i) [virtual] 
  4390.  
  4391.       int i 
  4392.  
  4393.  Sets the type of frame (see "Frame constants"). 
  4394.  
  4395.  void 
  4396.  
  4397.  
  4398. ΓòÉΓòÉΓòÉ 2.9.5. Retrieving general information about a generic frame ΓòÉΓòÉΓòÉ
  4399.  
  4400. Open the Contents view and expand this section to see a list of methods. 
  4401.  
  4402.  
  4403. ΓòÉΓòÉΓòÉ 2.9.5.1. MFrameXfer::getAnchor() ΓòÉΓòÉΓòÉ
  4404.  
  4405. getAnchor() const [virtual] 
  4406.  
  4407. Returns address of the anchor cell. 
  4408.  
  4409. const MAddress * 
  4410.  
  4411.  
  4412. ΓòÉΓòÉΓòÉ 2.9.5.2. MFrameXfer::getBkgColor() ΓòÉΓòÉΓòÉ
  4413.  
  4414. getBkgColor() const [virtual] 
  4415.  
  4416. Returns background color of the frame. 
  4417.  
  4418. const MColor * 
  4419.  
  4420.  
  4421. ΓòÉΓòÉΓòÉ 2.9.5.3. MFrameXfer::getBorderCol() ΓòÉΓòÉΓòÉ
  4422.  
  4423. getBorderCol() const [virtual] 
  4424.  
  4425. Returns border color of the frame. 
  4426.  
  4427. const MColor * 
  4428.  
  4429.  
  4430. ΓòÉΓòÉΓòÉ 2.9.5.4. MFrameXfer::getFrameColor() ΓòÉΓòÉΓòÉ
  4431.  
  4432. getFrameColor() const [virtual] 
  4433.  
  4434. Returns foreground color of the frame. 
  4435.  
  4436. const MColor * 
  4437.  
  4438.  
  4439. ΓòÉΓòÉΓòÉ 2.9.5.5. MFrameXfer::getName() ΓòÉΓòÉΓòÉ
  4440.  
  4441. getName() const [virtual] 
  4442.  
  4443. Returns the name of the frame. 
  4444.  
  4445. const char * 
  4446.  
  4447.  
  4448. ΓòÉΓòÉΓòÉ 2.9.5.6. MFrameXfer::getPos() ΓòÉΓòÉΓòÉ
  4449.  
  4450. getPos() const [virtual] 
  4451.  
  4452. Returns the location and size of the frame. 
  4453.  
  4454. const MRect * 
  4455.  
  4456.  
  4457. ΓòÉΓòÉΓòÉ 2.9.5.7. MFrameXfer::getScript() ΓòÉΓòÉΓòÉ
  4458.  
  4459. getScript() const [virtual] 
  4460.  
  4461. Returns the text of the REXX script to be executed. 
  4462.  
  4463. const char * 
  4464.  
  4465.  
  4466. ΓòÉΓòÉΓòÉ 2.9.5.8. MFrameXfer::getFrameSize() ΓòÉΓòÉΓòÉ
  4467.  
  4468. getFrameSize() const [virtual] 
  4469.  
  4470. Returns the width of the line drawn as the frame, in pixels. 
  4471.  
  4472. int 
  4473.  
  4474.  
  4475. ΓòÉΓòÉΓòÉ 2.9.5.9. MFrameXfer::getOrder() ΓòÉΓòÉΓòÉ
  4476.  
  4477. getOrder() const [virtual] 
  4478.  
  4479. Returns the Z-order of the frame. 
  4480.  
  4481. int 
  4482.  
  4483.  
  4484. ΓòÉΓòÉΓòÉ 2.9.6. Retrieving general information about a graph frame ΓòÉΓòÉΓòÉ
  4485.  
  4486. Open the Contents view and expand this section to see a list of methods. 
  4487.  
  4488.  
  4489. ΓòÉΓòÉΓòÉ 2.9.6.1. MFrameXfer::getGraphElements() ΓòÉΓòÉΓòÉ
  4490.  
  4491. getGraphElements() const [virtual] 
  4492.  
  4493. Returns a list of the elements to be drawn in the frame, if any (e.g.; rows, 
  4494. columns, legends, etc.), and information regarding the appearance of each 
  4495. element (see MFrameXfer). 
  4496.  
  4497. For more information, see "MGraphElement". 
  4498.  
  4499. MGraphElement * 
  4500.  
  4501.  
  4502. ΓòÉΓòÉΓòÉ 2.9.6.2. MFrameXfer::getLegendInfo() ΓòÉΓòÉΓòÉ
  4503.  
  4504. getLegendInfo() const [virtual] 
  4505.  
  4506. Returns information regarding the appearance of the legend, if one exists. 
  4507.  
  4508. For more information, see "MGraphElement". 
  4509.  
  4510. const MGraphElement * 
  4511.  
  4512.  
  4513. ΓòÉΓòÉΓòÉ 2.9.6.3. MFrameXfer::getRange() ΓòÉΓòÉΓòÉ
  4514.  
  4515. getRange() const [virtual] 
  4516.  
  4517. Returns the range of data being graphed. 
  4518.  
  4519. const MRange * 
  4520.  
  4521.  
  4522. ΓòÉΓòÉΓòÉ 2.9.6.4. MFrameXfer::getTitleInfo() ΓòÉΓòÉΓòÉ
  4523.  
  4524. getTitleInfo(int x) const [virtual] 
  4525.  
  4526.       int x   Which title? 
  4527.  
  4528.  Returns information regarding the appearance of the given title. A graph frame 
  4529.  can include up to four titles (see "Graph title constants"). 
  4530.  
  4531.  For more information, see "MGraphElement". 
  4532.  
  4533.  const MGraphElement * 
  4534.  
  4535.  
  4536. ΓòÉΓòÉΓòÉ 2.9.6.5. MFrameXfer::getTitles() ΓòÉΓòÉΓòÉ
  4537.  
  4538. getTitles(int x) const [virtual] 
  4539.  
  4540.       int x   Which title? 
  4541.  
  4542.  Returns the text of the given title. A graph frame can include up to four 
  4543.  titles (see "Graph title constants"). 
  4544.  
  4545.  const char * 
  4546.  
  4547.  
  4548. ΓòÉΓòÉΓòÉ 2.9.6.6. MFrameXfer::getBarColWid() ΓòÉΓòÉΓòÉ
  4549.  
  4550. getBarColWid() const [virtual] 
  4551.  
  4552. Returns the width of a bar or column. 
  4553.  
  4554. int 
  4555.  
  4556.  
  4557. ΓòÉΓòÉΓòÉ 2.9.6.7. MFrameXfer::getGraphBorder() ΓòÉΓòÉΓòÉ
  4558.  
  4559. getGraphBorder() const [virtual] 
  4560.  
  4561. Returns 1 if there is a border around the graph, 0 otherwise. 
  4562.  
  4563. int 
  4564.  
  4565.  
  4566. ΓòÉΓòÉΓòÉ 2.9.6.8. MFrameXfer::getLegendPosition() ΓòÉΓòÉΓòÉ
  4567.  
  4568. getLegendPosition() const [virtual] 
  4569.  
  4570. Returns the position of the legend (see "Graph legend constants"). 
  4571.  
  4572. int 
  4573.  
  4574.  
  4575. ΓòÉΓòÉΓòÉ 2.9.6.9. MFrameXfer::getLineWid() ΓòÉΓòÉΓòÉ
  4576.  
  4577. getLineWid() const [virtual] 
  4578.  
  4579. Returns the width of the line to be drawn in a line graph. 
  4580.  
  4581. int 
  4582.  
  4583.  
  4584. ΓòÉΓòÉΓòÉ 2.9.6.10. MFrameXfer::getNumElements() ΓòÉΓòÉΓòÉ
  4585.  
  4586. getNumElements() const [virtual] 
  4587.  
  4588. Returns the number of elements included in the graph. 
  4589.  
  4590. int 
  4591.  
  4592.  
  4593. ΓòÉΓòÉΓòÉ 2.9.6.11. MFrameXfer::getOrientation() ΓòÉΓòÉΓòÉ
  4594.  
  4595. getOrientation() const [virtual] 
  4596.  
  4597. Returns the orientation of the data to be graphed (see "Graph orientation 
  4598. constants"). 
  4599.  
  4600. int 
  4601.  
  4602.  
  4603. ΓòÉΓòÉΓòÉ 2.9.6.12. MFrameXfer::getShowLine() ΓòÉΓòÉΓòÉ
  4604.  
  4605. getShowLine() const [virtual] 
  4606.  
  4607. Returns 1 if the line should be drawn on a line/scatter graph, 0 otherwise. 
  4608.  
  4609. int 
  4610.  
  4611.  
  4612. ΓòÉΓòÉΓòÉ 2.9.6.13. MFrameXfer::getShowPoint() ΓòÉΓòÉΓòÉ
  4613.  
  4614. getShowPoint() const [virtual] 
  4615.  
  4616. Returns 1 if the points should be drawn on a line/scatter graph, 0 otherwise. 
  4617.  
  4618. int 
  4619.  
  4620.  
  4621. ΓòÉΓòÉΓòÉ 2.9.6.14. MFrameXfer::getSideTitles() ΓòÉΓòÉΓòÉ
  4622.  
  4623. getSideTitles() const [virtual] 
  4624.  
  4625. Returns 1 if the range being graphed includes headings in the first row (if 
  4626. graph is oriented by column) or in the first column (if graph is oriented by 
  4627. row), 0 otherwise (see "Graph orientation constants"). 
  4628.  
  4629. int 
  4630.  
  4631.  
  4632. ΓòÉΓòÉΓòÉ 2.9.6.15. MFrameXfer::getSingleXRange() ΓòÉΓòÉΓòÉ
  4633.  
  4634. getSingleXRange() const [virtual] 
  4635.  
  4636. Returns 1 if the X values in an X-Y graph are to drawn from only the first data 
  4637. series (a column or row of data); returns 0 if alternating X and Y data series 
  4638. are used. 
  4639.  
  4640. int 
  4641.  
  4642.  
  4643. ΓòÉΓòÉΓòÉ 2.9.6.16. MFrameXfer::getTopTitles() ΓòÉΓòÉΓòÉ
  4644.  
  4645. getTopTitles() const [virtual] 
  4646.  
  4647. Returns 1 if the range being graphed includes headings in the first row (if 
  4648. graph is oriented by row) or in the first column (if graph is oriented by 
  4649. column), 0 otherwise (see "Graph orientation constants"). 
  4650.  
  4651. int 
  4652.  
  4653.  
  4654. ΓòÉΓòÉΓòÉ 2.9.7. Retrieving X and Y axis information about a graph frame ΓòÉΓòÉΓòÉ
  4655.  
  4656. Open the Contents view and expand this section to see a list of methods. 
  4657.  
  4658.  
  4659. ΓòÉΓòÉΓòÉ 2.9.7.1. MFrameXfer::getAxisInfo() ΓòÉΓòÉΓòÉ
  4660.  
  4661. getAxisInfo() const [virtual] 
  4662.  
  4663. Returns information regarding the appearance of the combined X and Y axes. 
  4664.  
  4665. const MGraphElement * 
  4666.  
  4667.  
  4668. ΓòÉΓòÉΓòÉ 2.9.7.2. MFrameXfer::getDisplayFormat() ΓòÉΓòÉΓòÉ
  4669.  
  4670. getDisplayFormat(int i) const [virtual] 
  4671.  
  4672.       int i   Which axis? 
  4673.  
  4674.  Returns the display format for the labels for the given axis. 
  4675.  
  4676.  int 
  4677.  
  4678.  
  4679. ΓòÉΓòÉΓòÉ 2.9.7.3. MFrameXfer::getMaxX() ΓòÉΓòÉΓòÉ
  4680.  
  4681. getMaxX() const [virtual] 
  4682.  
  4683. Returns the highest value to be graphed on the X axis. 
  4684.  
  4685. double 
  4686.  
  4687.  
  4688. ΓòÉΓòÉΓòÉ 2.9.7.4. MFrameXfer::getMaxY() ΓòÉΓòÉΓòÉ
  4689.  
  4690. getMaxY() const [virtual] 
  4691.  
  4692. Returns highest value to be graphed on the Y axis. 
  4693.  
  4694. double 
  4695.  
  4696.  
  4697. ΓòÉΓòÉΓòÉ 2.9.7.5. MFrameXfer::getMinX() ΓòÉΓòÉΓòÉ
  4698.  
  4699. getMinX() const [virtual] 
  4700.  
  4701. Returns the lowest value to be graphed on the X axis. 
  4702.  
  4703. double 
  4704.  
  4705.  
  4706. ΓòÉΓòÉΓòÉ 2.9.7.6. MFrameXfer::getMinY() ΓòÉΓòÉΓòÉ
  4707.  
  4708. getMinY() const [virtual] 
  4709.  
  4710. Returns the lowest value to be graphed on theY axis. 
  4711.  
  4712. double 
  4713.  
  4714.  
  4715. ΓòÉΓòÉΓòÉ 2.9.7.7. MFrameXfer::getXAutoScale() ΓòÉΓòÉΓòÉ
  4716.  
  4717. getXAutoScale() const [virtual] 
  4718.  
  4719. Returns 1 if the maximum and minimum X values should be automatically 
  4720. calculated based on the data in the range to be graphed, 0 otherwise. 
  4721.  
  4722. int 
  4723.  
  4724.  
  4725. ΓòÉΓòÉΓòÉ 2.9.7.8. MFrameXfer::getXAxisLoc() ΓòÉΓòÉΓòÉ
  4726.  
  4727. getXAxisLoc() const [virtual] 
  4728.  
  4729. Returns the location of the X axis on the Y axis (see "Graph axis constants"). 
  4730.  
  4731. int 
  4732.  
  4733.  
  4734. ΓòÉΓòÉΓòÉ 2.9.7.9. MFrameXfer::getXAxisRot() ΓòÉΓòÉΓòÉ
  4735.  
  4736. getXAxisRot() const [virtual] 
  4737.  
  4738. Returns the angle to which the X-axis labels are being rotated. 
  4739.  
  4740. int 
  4741.  
  4742.  
  4743. ΓòÉΓòÉΓòÉ 2.9.7.10. MFrameXfer::getXGridCol() ΓòÉΓòÉΓòÉ
  4744.  
  4745. getXGridCol() const [virtual] 
  4746.  
  4747. Returns the color of the X axis grid lines, if any. 
  4748.  
  4749. const MColor * 
  4750.  
  4751.  
  4752. ΓòÉΓòÉΓòÉ 2.9.7.11. MFrameXfer::getXLogScale() ΓòÉΓòÉΓòÉ
  4753.  
  4754. getXLogScale() const [virtual] 
  4755.  
  4756. Returns 1 if the X axis is logarythmic, 0 otherwise. 
  4757.  
  4758. int 
  4759.  
  4760.  
  4761. ΓòÉΓòÉΓòÉ 2.9.7.12. MFrameXfer::getXMajTickSize() ΓòÉΓòÉΓòÉ
  4762.  
  4763. getXMajTickSize() const [virtual] 
  4764.  
  4765. Returns the size, in pixels, of major ticks on the X axis. 
  4766.  
  4767. int 
  4768.  
  4769.  
  4770. ΓòÉΓòÉΓòÉ 2.9.7.13. MFrameXfer::getXMajorGrid() ΓòÉΓòÉΓòÉ
  4771.  
  4772. getXMajorGrid() const [virtual] 
  4773.  
  4774. Returns 1 if grid lines should be drawn from the major ticks on the X axis, 0 
  4775. otherwise. 
  4776.  
  4777. int 
  4778.  
  4779.  
  4780. ΓòÉΓòÉΓòÉ 2.9.7.14. MFrameXfer::getXMajorTicks() ΓòÉΓòÉΓòÉ
  4781.  
  4782. getXMajorTicks() const [virtual] 
  4783.  
  4784. Returns position of the X major ticks relative to the X axis (see "Graph axis 
  4785. constants"). 
  4786.  
  4787. int 
  4788.  
  4789.  
  4790. ΓòÉΓòÉΓòÉ 2.9.7.15. MFrameXfer::getXMinTickSize() ΓòÉΓòÉΓòÉ
  4791.  
  4792. getXMinTickSize() const [virtual] 
  4793.  
  4794. Returns the size, in pixels, of minor ticks on the X axis. 
  4795.  
  4796. int 
  4797.  
  4798.  
  4799. ΓòÉΓòÉΓòÉ 2.9.7.16. MFrameXfer::getXMinorGrid() ΓòÉΓòÉΓòÉ
  4800.  
  4801. getXMinorGrid() const [virtual] 
  4802.  
  4803. Returns 1 if grid lines should be drawn from the minor ticks on the X axis, 0 
  4804. otherwise. 
  4805.  
  4806. int 
  4807.  
  4808.  
  4809. ΓòÉΓòÉΓòÉ 2.9.7.17. MFrameXfer::getXMinorTicks() ΓòÉΓòÉΓòÉ
  4810.  
  4811. getXMinorTicks()const [virtual] 
  4812.  
  4813. Returns position of the X minor ticks relative to the X axis (see "Graph axis 
  4814. constants"). 
  4815.  
  4816. int 
  4817.  
  4818.  
  4819. ΓòÉΓòÉΓòÉ 2.9.7.18. MFrameXfer::getYAutoScale() ΓòÉΓòÉΓòÉ
  4820.  
  4821. getYAutoScale() const [virtual] 
  4822.  
  4823. Returns 1 if the maximum and minimum X values should be automatically 
  4824. calculated based on the data in the range to be graphed, 0 otherwise. 
  4825.  
  4826. int 
  4827.  
  4828.  
  4829. ΓòÉΓòÉΓòÉ 2.9.7.19. MFrameXfer::getYAxisLoc() ΓòÉΓòÉΓòÉ
  4830.  
  4831. getYAxisLoc()const [virtual] 
  4832.  
  4833. Returns the location of the Y axis on the X axis (see "Graph axis constants"). 
  4834.  
  4835. int 
  4836.  
  4837.  
  4838. ΓòÉΓòÉΓòÉ 2.9.7.20. MFrameXfer::getYAxisRot() ΓòÉΓòÉΓòÉ
  4839.  
  4840. getYAxisRot() const [virtual] 
  4841.  
  4842. Returns the angle to which the Y-axis labels are being rotated. 
  4843.  
  4844. int 
  4845.  
  4846.  
  4847. ΓòÉΓòÉΓòÉ 2.9.7.21. MFrameXfer::getYGridCol() ΓòÉΓòÉΓòÉ
  4848.  
  4849. getYGridCol() const [virtual] 
  4850.  
  4851. Returns the color of the Y axis grid lines, if any. 
  4852.  
  4853. const MColor * 
  4854.  
  4855.  
  4856. ΓòÉΓòÉΓòÉ 2.9.7.22. MFrameXfer::getYLogScale() ΓòÉΓòÉΓòÉ
  4857.  
  4858. getYLogScale() const [virtual] 
  4859.  
  4860. Returns 1 if the Y axis is logarythmic, 0 otherwise. 
  4861.  
  4862. int 
  4863.  
  4864.  
  4865. ΓòÉΓòÉΓòÉ 2.9.7.23. MFrameXfer::getYMajTickSize() ΓòÉΓòÉΓòÉ
  4866.  
  4867. getYMajTickSize() const [virtual] 
  4868.  
  4869. Returns the size, in pixels, of major ticks on theY axis. 
  4870.  
  4871. int 
  4872.  
  4873.  
  4874. ΓòÉΓòÉΓòÉ 2.9.7.24. MFrameXfer::getYMajorGrid() ΓòÉΓòÉΓòÉ
  4875.  
  4876. getYMajorGrid() const [virtual] 
  4877.  
  4878. Returns 1 if grid lines should be drawn from the major ticks on the Y axis, 0 
  4879. otherwise. 
  4880.  
  4881. int 
  4882.  
  4883.  
  4884. ΓòÉΓòÉΓòÉ 2.9.7.25. MFrameXfer::getYMajorTicks() ΓòÉΓòÉΓòÉ
  4885.  
  4886. getYMajorTicks() const [virtual] 
  4887.  
  4888. Returns position of the Y major ticks relative to the Y axis (see "Graph axis 
  4889. constants"). 
  4890.  
  4891. int 
  4892.  
  4893.  
  4894. ΓòÉΓòÉΓòÉ 2.9.7.26. MFrameXfer::getYMinTickSize() ΓòÉΓòÉΓòÉ
  4895.  
  4896. getYMinTickSize() const [virtual] 
  4897.  
  4898. Returns the size, in pixels, of minor ticks on the Y axis. 
  4899.  
  4900. int 
  4901.  
  4902.  
  4903. ΓòÉΓòÉΓòÉ 2.9.7.27. MFrameXfer::getYMinorGrid() ΓòÉΓòÉΓòÉ
  4904.  
  4905. getYMinorGrid() const [virtual] 
  4906.  
  4907. Returns 1 if grid lines should be drawn from the minor ticks on the Y axis, 0 
  4908. otherwise. 
  4909.  
  4910. int 
  4911.  
  4912.  
  4913. ΓòÉΓòÉΓòÉ 2.9.7.28. MFrameXfer::getYMinorTicks() ΓòÉΓòÉΓòÉ
  4914.  
  4915. getYMinorTicks() const [virtual] 
  4916.  
  4917. Returns position of the Y minor ticks relative to the Y axis (see "Graph axis 
  4918. constants"). 
  4919.  
  4920. int 
  4921.  
  4922.  
  4923. ΓòÉΓòÉΓòÉ 2.9.8. Retrieving 3-d information about a graph frame ΓòÉΓòÉΓòÉ
  4924.  
  4925. Open the Contents view and expand this section to see a list of methods. 
  4926.  
  4927.  
  4928. ΓòÉΓòÉΓòÉ 2.9.8.1. MFrameXfer::getWallCol() ΓòÉΓòÉΓòÉ
  4929.  
  4930. getWallCol() const [virtual] 
  4931.  
  4932. Returns the color of the "wall" that is drawn behind the graphed data on a 
  4933. three-dimensional graph. 
  4934.  
  4935. const MColor * 
  4936.  
  4937.  
  4938. ΓòÉΓòÉΓòÉ 2.9.8.2. MFrameXfer::getWireFrame() ΓòÉΓòÉΓòÉ
  4939.  
  4940. getWireFrame() const [virtual] 
  4941.  
  4942. Returns 1 if the three-dimensional graph elements should be drawn in 
  4943. transparent "wire-frame" form, 0 if they should be drawn in solid form. 
  4944.  
  4945. int 
  4946.  
  4947.  
  4948. ΓòÉΓòÉΓòÉ 2.9.8.3. MFrameXfer::getXRot() ΓòÉΓòÉΓòÉ
  4949.  
  4950. getXRot() const [virtual] 
  4951.  
  4952. Returns the X rotation of a three-dimensional graph. 
  4953.  
  4954. int 
  4955.  
  4956.  
  4957. ΓòÉΓòÉΓòÉ 2.9.8.4. MFrameXfer::getYRot() ΓòÉΓòÉΓòÉ
  4958.  
  4959. getYRot() const [virtual] 
  4960.  
  4961. Returns the Y rotation of a three-dimensional graph. 
  4962.  
  4963. int 
  4964.  
  4965.  
  4966. ΓòÉΓòÉΓòÉ 2.9.9. Retrieving merge flags from an MFrameXfer instance ΓòÉΓòÉΓòÉ
  4967.  
  4968. Open the Contents view and expand this section to see a list of methods. 
  4969.  
  4970.  
  4971. ΓòÉΓòÉΓòÉ 2.9.9.1. MFrameXfer::getMergeAnchor() ΓòÉΓòÉΓòÉ
  4972.  
  4973. getMergeAnchor() const [virtual] 
  4974.  
  4975. Returns setting of the merge flag for anchor cell. 
  4976.  
  4977. int 
  4978.  
  4979.  
  4980. ΓòÉΓòÉΓòÉ 2.9.9.2. MFrameXfer::getMergeAxisInfo() ΓòÉΓòÉΓòÉ
  4981.  
  4982. getMergeAxisInfo() const [virtual] 
  4983.  
  4984. Returns setting of the merge flag for axis appearance. 
  4985.  
  4986. int 
  4987.  
  4988.  
  4989. ΓòÉΓòÉΓòÉ 2.9.9.3. MFrameXfer::getMergeBarColWid() ΓòÉΓòÉΓòÉ
  4990.  
  4991. getMergeBarColWid() const [virtual] 
  4992.  
  4993. Returns setting of the merge flag for bar or column width. 
  4994.  
  4995. int 
  4996.  
  4997.  
  4998. ΓòÉΓòÉΓòÉ 2.9.9.4. MFrameXfer::getMergeBkgColor() ΓòÉΓòÉΓòÉ
  4999.  
  5000. getMergeBkgColor() const [virtual] 
  5001.  
  5002. Returns setting of the merge flag for background color. 
  5003.  
  5004. int 
  5005.  
  5006.  
  5007. ΓòÉΓòÉΓòÉ 2.9.9.5. MFrameXfer::getMergeBorderCol() ΓòÉΓòÉΓòÉ
  5008.  
  5009. getMergeBorderCol() const [virtual] 
  5010.  
  5011. Returns setting of the merge flag for border color. 
  5012.  
  5013. int 
  5014.  
  5015.  
  5016. ΓòÉΓòÉΓòÉ 2.9.9.6. MFrameXfer::getMergeDisplayFormat() ΓòÉΓòÉΓòÉ
  5017.  
  5018. getMergeDisplayFormat() const [virtual] 
  5019.  
  5020. Returns setting of the merge flag for axis display formats. 
  5021.  
  5022. int 
  5023.  
  5024.  
  5025. ΓòÉΓòÉΓòÉ 2.9.9.7. MFrameXfer::getMergeElements() ΓòÉΓòÉΓòÉ
  5026.  
  5027. getMergeElements() const [virtual] 
  5028.  
  5029. Returns setting of the merge flag for list of graph elements. 
  5030.  
  5031. int 
  5032.  
  5033.  
  5034. ΓòÉΓòÉΓòÉ 2.9.9.8. MFrameXfer::getMergeFrameColor() ΓòÉΓòÉΓòÉ
  5035.  
  5036. getMergeFrameColor() const [virtual] 
  5037.  
  5038. Returns setting of the merge flag for frame color. 
  5039.  
  5040. int 
  5041.  
  5042.  
  5043. ΓòÉΓòÉΓòÉ 2.9.9.9. MFrameXfer::getMergeFrameSize() ΓòÉΓòÉΓòÉ
  5044.  
  5045. getMergeFrameSize() const [virtual] 
  5046.  
  5047. Returns setting of the merge flag for frame size. 
  5048.  
  5049. int 
  5050.  
  5051.  
  5052. ΓòÉΓòÉΓòÉ 2.9.9.10. MFrameXfer::getMergeGraphBorder() ΓòÉΓòÉΓòÉ
  5053.  
  5054. getMergeGraphBorder() const [virtual] 
  5055.  
  5056. Returns setting of the merge flag for graph-border setting. 
  5057.  
  5058. int 
  5059.  
  5060.  
  5061. ΓòÉΓòÉΓòÉ 2.9.9.11. MFrameXfer::getMergeLegendInfo() ΓòÉΓòÉΓòÉ
  5062.  
  5063. getMergeLegendInfo() const [virtual] 
  5064.  
  5065. Returns setting of the merge flag for legend appearance. 
  5066.  
  5067. int 
  5068.  
  5069.  
  5070. ΓòÉΓòÉΓòÉ 2.9.9.12. MFrameXfer::getMergeLegendPosition() ΓòÉΓòÉΓòÉ
  5071.  
  5072. getMergeLegendPosition() const [virtual] 
  5073.  
  5074. Returns setting of the merge flag for legend position. 
  5075.  
  5076. int 
  5077.  
  5078.  
  5079. ΓòÉΓòÉΓòÉ 2.9.9.13. MFrameXfer::getMergeLineWid() ΓòÉΓòÉΓòÉ
  5080.  
  5081. getMergeLineWid() const [virtual] 
  5082.  
  5083. Returns setting of the merge flag for line width in line graphs. 
  5084.  
  5085. int 
  5086.  
  5087.  
  5088. ΓòÉΓòÉΓòÉ 2.9.9.14. MFrameXfer::getMergeName() ΓòÉΓòÉΓòÉ
  5089.  
  5090. getMergeName() const [virtual] 
  5091.  
  5092. Returns setting of the merge flag for frame name. 
  5093.  
  5094. int 
  5095.  
  5096.  
  5097. ΓòÉΓòÉΓòÉ 2.9.9.15. MFrameXfer::getMergeOrder() ΓòÉΓòÉΓòÉ
  5098.  
  5099. getMergeOrder() const [virtual] 
  5100.  
  5101. Returns setting of the merge flag for Z-order. 
  5102.  
  5103. int 
  5104.  
  5105.  
  5106. ΓòÉΓòÉΓòÉ 2.9.9.16. MFrameXfer::getMergeOrientation() ΓòÉΓòÉΓòÉ
  5107.  
  5108. getMergeOrientation() const [virtual] 
  5109.  
  5110. Returns setting of the merge flag for orientation. 
  5111.  
  5112. int 
  5113.  
  5114.  
  5115. ΓòÉΓòÉΓòÉ 2.9.9.17. MFrameXfer::getMergePos() ΓòÉΓòÉΓòÉ
  5116.  
  5117. getMergePos() const [virtual] 
  5118.  
  5119. Returns setting of the merge flag for frame position. 
  5120.  
  5121. int 
  5122.  
  5123.  
  5124. ΓòÉΓòÉΓòÉ 2.9.9.18. MFrameXfer::getMergeRange() ΓòÉΓòÉΓòÉ
  5125.  
  5126. getMergeRange() const [virtual] 
  5127.  
  5128. Returns setting of the merge flag for range to graph. 
  5129.  
  5130. int 
  5131.  
  5132.  
  5133. ΓòÉΓòÉΓòÉ 2.9.9.19. MFrameXfer::getMergeScale() ΓòÉΓòÉΓòÉ
  5134.  
  5135. getMergeScale() const [virtual] 
  5136.  
  5137. Returns setting of the merge flag for WHAT. 
  5138.  
  5139. int 
  5140.  
  5141.  
  5142. ΓòÉΓòÉΓòÉ 2.9.9.20. MFrameXfer::getMergeScript() ΓòÉΓòÉΓòÉ
  5143.  
  5144. getMergeScript() const [virtual] 
  5145.  
  5146. Returns setting of the merge flag for the script to execute. 
  5147.  
  5148. int 
  5149.  
  5150.  
  5151. ΓòÉΓòÉΓòÉ 2.9.9.21. MFrameXfer::getMergeShowLine() ΓòÉΓòÉΓòÉ
  5152.  
  5153. getMergeShowLine() const [virtual] 
  5154.  
  5155. Returns setting of the merge flag for the show-line flag. 
  5156.  
  5157. int 
  5158.  
  5159.  
  5160. ΓòÉΓòÉΓòÉ 2.9.9.22. MFrameXfer::getMergeShowPoint() ΓòÉΓòÉΓòÉ
  5161.  
  5162. getMergeShowPoint() const [virtual] 
  5163.  
  5164. Returns setting of the merge flag for show-point flag. 
  5165.  
  5166. int 
  5167.  
  5168.  
  5169. ΓòÉΓòÉΓòÉ 2.9.9.23. MFrameXfer::getMergeSideTitles() ΓòÉΓòÉΓòÉ
  5170.  
  5171. getMergeSideTitles() const [virtual] 
  5172.  
  5173. Returns setting of the merge flag for side-titles flag. 
  5174.  
  5175. int 
  5176.  
  5177.  
  5178. ΓòÉΓòÉΓòÉ 2.9.9.24. MFrameXfer::getMergeSingleXRange() ΓòÉΓòÉΓòÉ
  5179.  
  5180. getMergeSingleXRange() const [virtual] 
  5181.  
  5182. Returns setting of the merge flag for X-ranges flag. 
  5183.  
  5184. int 
  5185.  
  5186.  
  5187. ΓòÉΓòÉΓòÉ 2.9.9.25. MFrameXfer::getMergeTitleInfo() ΓòÉΓòÉΓòÉ
  5188.  
  5189. getMergeTitleInfo(int x) const [virtual] 
  5190.  
  5191.       int x   Which title? 
  5192.  
  5193.  Returns setting of the merge flag for the appearance of the given title. 
  5194.  
  5195.  int 
  5196.  
  5197.  
  5198. ΓòÉΓòÉΓòÉ 2.9.9.26. MFrameXfer::getMergeTitles() ΓòÉΓòÉΓòÉ
  5199.  
  5200. getMergeTitles(int x) const [virtual] 
  5201.  
  5202.       int x   Which title? 
  5203.  
  5204.  Returns setting of the merge flag for the text of the given title. 
  5205.  
  5206.  int 
  5207.  
  5208.  
  5209. ΓòÉΓòÉΓòÉ 2.9.9.27. MFrameXfer::getMergeTopTitles() ΓòÉΓòÉΓòÉ
  5210.  
  5211. getMergeTopTitles() const [virtual] 
  5212.  
  5213. Returns setting of the merge flag for top-titles flag. 
  5214.  
  5215. int 
  5216.  
  5217.  
  5218. ΓòÉΓòÉΓòÉ 2.9.9.28. MFrameXfer::getMergeWallCol() ΓòÉΓòÉΓòÉ
  5219.  
  5220. getMergeWallCol() const [virtual] 
  5221.  
  5222. Returns setting of the merge flag for 3-d wall color. 
  5223.  
  5224. int 
  5225.  
  5226.  
  5227. ΓòÉΓòÉΓòÉ 2.9.9.29. MFrameXfer::getMergeWireFrame() ΓòÉΓòÉΓòÉ
  5228.  
  5229. getMergeWireFrame() const [virtual] 
  5230.  
  5231. Returns setting of the merge flag for wire-frame flag. 
  5232.  
  5233. int 
  5234.  
  5235.  
  5236. ΓòÉΓòÉΓòÉ 2.9.9.30. MFrameXfer::getMergeXAutoScale() ΓòÉΓòÉΓòÉ
  5237.  
  5238. getMergeXAutoScale() const [virtual] 
  5239.  
  5240. Returns setting of the merge flag for X auto-scale flag. 
  5241.  
  5242. int 
  5243.  
  5244.  
  5245. ΓòÉΓòÉΓòÉ 2.9.9.31. MFrameXfer::getMergeXAxisLoc() ΓòÉΓòÉΓòÉ
  5246.  
  5247. getMergeXAxisLoc() const [virtual] 
  5248.  
  5249. Returns setting of the merge flag for X axis location. 
  5250.  
  5251. int 
  5252.  
  5253.  
  5254. ΓòÉΓòÉΓòÉ 2.9.9.32. MFrameXfer::getMergeXAxisRot() ΓòÉΓòÉΓòÉ
  5255.  
  5256. getMergeXAxisRot() const [virtual] 
  5257.  
  5258. Returns setting of the merge flag for X-axis label rotation. 
  5259.  
  5260. int 
  5261.  
  5262.  
  5263. ΓòÉΓòÉΓòÉ 2.9.9.33. MFrameXfer::getMergeXGridCol() ΓòÉΓòÉΓòÉ
  5264.  
  5265. getMergeXGridCol() const [virtual] 
  5266.  
  5267. Returns setting of the merge flag for X-axis gridline color. 
  5268.  
  5269. int 
  5270.  
  5271.  
  5272. ΓòÉΓòÉΓòÉ 2.9.9.34. MFrameXfer::getMergeXLogScale() ΓòÉΓòÉΓòÉ
  5273.  
  5274. getMergeXLogScale() const [virtual] 
  5275.  
  5276. Returns setting of the merge flag for X-axis logarythmic-scale flag. 
  5277.  
  5278. int 
  5279.  
  5280.  
  5281. ΓòÉΓòÉΓòÉ 2.9.9.35. MFrameXfer::getMergeXMajTickSize() ΓòÉΓòÉΓòÉ
  5282.  
  5283. getMergeXMajTickSize() const [virtual] 
  5284.  
  5285. Returns setting of the merge flag for X major tick size. 
  5286.  
  5287. int 
  5288.  
  5289.  
  5290. ΓòÉΓòÉΓòÉ 2.9.9.36. MFrameXfer::getMergeXMajorGrid() ΓòÉΓòÉΓòÉ
  5291.  
  5292. getMergeXMajorGrid() const [virtual] 
  5293.  
  5294. Returns setting of the merge flag for X-axis major gridline flag. 
  5295.  
  5296. int 
  5297.  
  5298.  
  5299. ΓòÉΓòÉΓòÉ 2.9.9.37. MFrameXfer::getMergeXMajorTicks() ΓòÉΓòÉΓòÉ
  5300.  
  5301. getMergeXMajorTicks() const [virtual] 
  5302.  
  5303. Returns setting of the merge flag for X-axis major tick flag. 
  5304.  
  5305. int 
  5306.  
  5307.  
  5308. ΓòÉΓòÉΓòÉ 2.9.9.38. MFrameXfer::getMergeXMinTickSize() ΓòÉΓòÉΓòÉ
  5309.  
  5310. getMergeXMinTickSize() const [virtual] 
  5311.  
  5312. Returns setting of the merge flag for X minor tick size. 
  5313.  
  5314. int 
  5315.  
  5316.  
  5317. ΓòÉΓòÉΓòÉ 2.9.9.39. MFrameXfer::getMergeXMinorGrid() ΓòÉΓòÉΓòÉ
  5318.  
  5319. getMergeXMinorGrid() const [virtual] 
  5320.  
  5321. Returns setting of the merge flag for X-axis minor gridline flag. 
  5322.  
  5323. int 
  5324.  
  5325.  
  5326. ΓòÉΓòÉΓòÉ 2.9.9.40. MFrameXfer::getMergeXMinorTicks() ΓòÉΓòÉΓòÉ
  5327.  
  5328. getMergeXMinorTicks() const [virtual] 
  5329.  
  5330. Returns setting of the merge flag for X-axis minor tick flag. 
  5331.  
  5332. int 
  5333.  
  5334.  
  5335. ΓòÉΓòÉΓòÉ 2.9.9.41. MFrameXfer::getMergeXRot() ΓòÉΓòÉΓòÉ
  5336.  
  5337. getMergeXRot() const [virtual] 
  5338.  
  5339. Returns setting of the merge flag for 3-d X rotation. 
  5340.  
  5341. int 
  5342.  
  5343.  
  5344. ΓòÉΓòÉΓòÉ 2.9.9.42. MFrameXfer::getMergeYAutoScale() ΓòÉΓòÉΓòÉ
  5345.  
  5346. getMergeYAutoScale() const [virtual] 
  5347.  
  5348. Returns setting of the merge flag for Y auto-scale flag. 
  5349.  
  5350. int 
  5351.  
  5352.  
  5353. ΓòÉΓòÉΓòÉ 2.9.9.43. MFrameXfer::getMergeYAxisLoc() ΓòÉΓòÉΓòÉ
  5354.  
  5355. getMergeYAxisLoc() const [virtual] 
  5356.  
  5357. Returns setting of the merge flag for Y axis location. 
  5358.  
  5359. int 
  5360.  
  5361.  
  5362. ΓòÉΓòÉΓòÉ 2.9.9.44. MFrameXfer::getMergeYAxisRot() ΓòÉΓòÉΓòÉ
  5363.  
  5364. getMergeYAxisRot() const [virtual] 
  5365.  
  5366. Returns setting of the merge flag for Y-axis label rotation. 
  5367.  
  5368. int 
  5369.  
  5370.  
  5371. ΓòÉΓòÉΓòÉ 2.9.9.45. MFrameXfer::getMergeYGridCol() ΓòÉΓòÉΓòÉ
  5372.  
  5373. getMergeYGridCol() const [virtual] 
  5374.  
  5375. Returns setting of the merge flag for Y-axis gridline color. 
  5376.  
  5377. int 
  5378.  
  5379.  
  5380. ΓòÉΓòÉΓòÉ 2.9.9.46. MFrameXfer::getMergeYLogScale() ΓòÉΓòÉΓòÉ
  5381.  
  5382. getMergeYLogScale() const [virtual] 
  5383.  
  5384. Returns setting of the merge flag for Y-axis logarythmic-scale flag. 
  5385.  
  5386. int 
  5387.  
  5388.  
  5389. ΓòÉΓòÉΓòÉ 2.9.9.47. MFrameXfer::getMergeYMajTickSize() ΓòÉΓòÉΓòÉ
  5390.  
  5391. getMergeYMajTickSize() const [virtual] 
  5392.  
  5393. Returns setting of the merge flag for Y major tick size. 
  5394.  
  5395. int 
  5396.  
  5397.  
  5398. ΓòÉΓòÉΓòÉ 2.9.9.48. MFrameXfer::getMergeYMajorGrid() ΓòÉΓòÉΓòÉ
  5399.  
  5400. getMergeYMajorGrid() const [virtual] 
  5401.  
  5402. Returns setting of the merge flag for Y-axis major gridline flag. 
  5403.  
  5404. int 
  5405.  
  5406.  
  5407. ΓòÉΓòÉΓòÉ 2.9.9.49. MFrameXfer::getMergeYMajorTicks() ΓòÉΓòÉΓòÉ
  5408.  
  5409. getMergeYMajorTicks() const [virtual] 
  5410.  
  5411. Returns setting of the merge flag for Y-axis major tick flag. 
  5412.  
  5413. int 
  5414.  
  5415.  
  5416. ΓòÉΓòÉΓòÉ 2.9.9.50. MFrameXfer::getMergeYMinTickSize() ΓòÉΓòÉΓòÉ
  5417.  
  5418. getMergeYMinTickSize() const [virtual] 
  5419.  
  5420. Returns setting of the merge flag for Y minor tick size. 
  5421.  
  5422. int 
  5423.  
  5424.  
  5425. ΓòÉΓòÉΓòÉ 2.9.9.51. MFrameXfer::getMergeYMinorGrid() ΓòÉΓòÉΓòÉ
  5426.  
  5427. getMergeYMinorGrid() const [virtual] 
  5428.  
  5429. Returns setting of the merge flag for Y-axis minor gridline flag. 
  5430.  
  5431. int 
  5432.  
  5433.  
  5434. ΓòÉΓòÉΓòÉ 2.9.9.52. MFrameXfer::getMergeYMinorTicks() ΓòÉΓòÉΓòÉ
  5435.  
  5436. getMergeYMinorTicks() const [virtual] 
  5437.  
  5438. Returns setting of the merge flag for Y-axis minor tick flag. 
  5439.  
  5440. int 
  5441.  
  5442.  
  5443. ΓòÉΓòÉΓòÉ 2.9.9.53. MFrameXfer::getMergeYRot() ΓòÉΓòÉΓòÉ
  5444.  
  5445. getMergeYRot() const [virtual] 
  5446.  
  5447. Returns setting of the merge flag for 3-d Y rotation. 
  5448.  
  5449. int 
  5450.  
  5451.  
  5452. ΓòÉΓòÉΓòÉ 2.9.10. Setting merge flags in an MFrameXfer instance ΓòÉΓòÉΓòÉ
  5453.  
  5454. Open the Contents view and expand this section to see a list of methods. 
  5455.  
  5456. There are no explicit methods for setting merge flags on. However, whenever a 
  5457. value is set within an MFrameXfer instance, its associated merge flag is also 
  5458. set. 
  5459.  
  5460.  
  5461. ΓòÉΓòÉΓòÉ 2.9.10.1. MFrameXfer::setNoMerge() ΓòÉΓòÉΓòÉ
  5462.  
  5463. setNoMerge() [virtual] 
  5464.  
  5465. Turns off all the merge flags. 
  5466.  
  5467. void 
  5468.  
  5469.  
  5470. ΓòÉΓòÉΓòÉ 2.9.11. Setting generic-frame values in an MFrameXfer instance ΓòÉΓòÉΓòÉ
  5471.  
  5472. Open the Contents view and expand this section to see a list of methods. 
  5473.  
  5474.  
  5475. ΓòÉΓòÉΓòÉ 2.9.11.1. MFrameXfer::setAnchor() ΓòÉΓòÉΓòÉ
  5476.  
  5477. setAnchor(const MAddress *ad) [virtual] 
  5478.  
  5479.       const MAddress *ad   New anchor cell 
  5480.  
  5481.  Sets address of the anchor cell. 
  5482.  
  5483.  void 
  5484.  
  5485.  
  5486. ΓòÉΓòÉΓòÉ 2.9.11.2. MFrameXfer::setBkgColor() ΓòÉΓòÉΓòÉ
  5487.  
  5488. setBkgColor(const MColor *c) [virtual] 
  5489.  
  5490.       const MColor *c 
  5491.  
  5492.  Sets background color of the frame. 
  5493.  
  5494.  void 
  5495.  
  5496.  
  5497. ΓòÉΓòÉΓòÉ 2.9.11.3. MFrameXfer::setBorderCol() ΓòÉΓòÉΓòÉ
  5498.  
  5499. setBorderCol(const MColor *c) [virtual] 
  5500.  
  5501.       const MColor *c 
  5502.  
  5503.  Sets border color of the frame. 
  5504.  
  5505.  void 
  5506.  
  5507.  
  5508. ΓòÉΓòÉΓòÉ 2.9.11.4. MFrameXfer::setFrameColor() ΓòÉΓòÉΓòÉ
  5509.  
  5510. setFrameColor(const MColor *c) [virtual] 
  5511.  
  5512.       const MColor *c 
  5513.  
  5514.  Sets foreground color of the frame. 
  5515.  
  5516.  void 
  5517.  
  5518.  
  5519. ΓòÉΓòÉΓòÉ 2.9.11.5. MFrameXfer::setFrameSize() ΓòÉΓòÉΓòÉ
  5520.  
  5521. setFrameSize(int i) [virtual] 
  5522.  
  5523.       int i   New line width 
  5524.  
  5525.  Sets the width of the line drawn as the frame, in pixels. 
  5526.  
  5527.  void 
  5528.  
  5529.  
  5530. ΓòÉΓòÉΓòÉ 2.9.11.6. MFrameXfer::setName() ΓòÉΓòÉΓòÉ
  5531.  
  5532. setName(const char *) [virtual] 
  5533.  
  5534.       const char *   New name 
  5535.  
  5536.  Sets the name of the frame. 
  5537.  
  5538.  void 
  5539.  
  5540.  
  5541. ΓòÉΓòÉΓòÉ 2.9.11.7. MFrameXfer::setOrder() ΓòÉΓòÉΓòÉ
  5542.  
  5543. setOrder(int i) [virtual] 
  5544.  
  5545.       int i   New position in Z order 
  5546.  
  5547.  Sets the Z-order of the frame. 
  5548.  
  5549.  void 
  5550.  
  5551.  
  5552. ΓòÉΓòÉΓòÉ 2.9.11.8. MFrameXfer::setPos() ΓòÉΓòÉΓòÉ
  5553.  
  5554. setPos(const MRect *re) [virtual] 
  5555.  
  5556.       const MRect *re   Rectangle defining the new frame position 
  5557.  
  5558.  Sets the location and size of the frame to re. 
  5559.  
  5560.  void 
  5561.  
  5562.  
  5563. ΓòÉΓòÉΓòÉ 2.9.11.9. MFrameXfer::setScript() ΓòÉΓòÉΓòÉ
  5564.  
  5565. setScript(const char *) [virtual] 
  5566.  
  5567.       const char *   New script to be executed 
  5568.  
  5569.  Sets the text of the REXX script to be executed when the frame is selected. 
  5570.  
  5571.  void 
  5572.  
  5573.  
  5574. ΓòÉΓòÉΓòÉ 2.9.12. Setting general graph-frame values in an MFrameXfer instance ΓòÉΓòÉΓòÉ
  5575.  
  5576. Open the Contents view and expand this section to see a list of methods. 
  5577.  
  5578.  
  5579. ΓòÉΓòÉΓòÉ 2.9.12.1. MFrameXfer::setBarColWid() ΓòÉΓòÉΓòÉ
  5580.  
  5581. setBarColWid(int i) [virtual] 
  5582.  
  5583.       int i   New width, in pixels 
  5584.  
  5585.  Sets the width of a bar or column. 
  5586.  
  5587.  void 
  5588.  
  5589.  
  5590. ΓòÉΓòÉΓòÉ 2.9.12.2. MFrameXfer::setGraphBorder() ΓòÉΓòÉΓòÉ
  5591.  
  5592. setGraphBorder(int i) [virtual] 
  5593.  
  5594.       int i   Ne w border flag value 
  5595.  
  5596.  1 if there is to be a border around the graph, 0 otherwise. 
  5597.  
  5598.  void 
  5599.  
  5600.  
  5601. ΓòÉΓòÉΓòÉ 2.9.12.3. MFrameXfer::setGraphElements() ΓòÉΓòÉΓòÉ
  5602.  
  5603. setGraphElements(int n, const MGraphElement *) [virtual] 
  5604.  
  5605.       int n   Number of elements being passed in 
  5606.  
  5607.       const MGraphElement *   New array of graph elements 
  5608.  
  5609.  Deletes the existing array of graph elements and replaces it with the list of 
  5610.  elements passed in. 
  5611.  
  5612.  For more information, see "MGraphElement". 
  5613.  
  5614.  void 
  5615.  
  5616.  
  5617. ΓòÉΓòÉΓòÉ 2.9.12.4. MFrameXfer::setLegendInfo() ΓòÉΓòÉΓòÉ
  5618.  
  5619. setLegendInfo(const MGraphElement *ge) [virtual] 
  5620.  
  5621.       const MGraphElement *ge 
  5622.  
  5623.  Sets information regarding the appearance of the legend. 
  5624.  
  5625.  For more information, see "MGraphElement". 
  5626.  
  5627.  void 
  5628.  
  5629.  
  5630. ΓòÉΓòÉΓòÉ 2.9.12.5. MFrameXfer::setLegendPosition() ΓòÉΓòÉΓòÉ
  5631.  
  5632. setLegendPosition(int i) [virtual] 
  5633.  
  5634.       int i   New legend position 
  5635.  
  5636.  Sets the position of the legend (see "Graph legend constants"). 
  5637.  
  5638.  void 
  5639.  
  5640.  
  5641. ΓòÉΓòÉΓòÉ 2.9.12.6. MFrameXfer::setLineWid() ΓòÉΓòÉΓòÉ
  5642.  
  5643. setLineWid(int i) [virtual] 
  5644.  
  5645.       int i   New line width, in pixels 
  5646.  
  5647.  Sets the width of the line to be drawn in a line graph. 
  5648.  
  5649.  void 
  5650.  
  5651.  
  5652. ΓòÉΓòÉΓòÉ 2.9.12.7. MFrameXfer::setOrientation() ΓòÉΓòÉΓòÉ
  5653.  
  5654. setOrientation(int i) [virtual] 
  5655.  
  5656.       int i   New data orientation 
  5657.  
  5658.  Sets the orientation of the data to be graphed (see "Graph orientation 
  5659.  constants"). 
  5660.  
  5661.  void 
  5662.  
  5663.  
  5664. ΓòÉΓòÉΓòÉ 2.9.12.8. MFrameXfer::setRange() ΓòÉΓòÉΓòÉ
  5665.  
  5666. setRange(const MRange *ra) [virtual] 
  5667.  
  5668.       const MRange *ra   New range to graph 
  5669.  
  5670.  Sets the range of data being graphed. 
  5671.  
  5672.  void 
  5673.  
  5674.  
  5675. ΓòÉΓòÉΓòÉ 2.9.12.9. MFrameXfer::setShowLine() ΓòÉΓòÉΓòÉ
  5676.  
  5677. setShowLine(int i) [virtual] 
  5678.  
  5679.       int i   New flag value 
  5680.  
  5681.  If 1, the line is drawn on a line/scatter graph; if 0, the line is not drawn. 
  5682.  
  5683.  void 
  5684.  
  5685.  
  5686. ΓòÉΓòÉΓòÉ 2.9.12.10. MFrameXfer::setShowPoint() ΓòÉΓòÉΓòÉ
  5687.  
  5688. setShowPoint(int i) [virtual] 
  5689.  
  5690.       int i   New flag value 
  5691.  
  5692.  If 1, the points are drawn on a line/scatter graph; if 0, the points are not 
  5693.  drawn. 
  5694.  
  5695.  void 
  5696.  
  5697.  
  5698. ΓòÉΓòÉΓòÉ 2.9.12.11. MFrameXfer::setSideTitles() ΓòÉΓòÉΓòÉ
  5699.  
  5700. setSideTitles(int i) [virtual] 
  5701.  
  5702.       int i   New flag value 
  5703.  
  5704.  If 1, the range being graphed includes headings in the first row (if graph is 
  5705.  oriented by column) or in the first column (if graph is oriented by row); if 
  5706.  0, it doesn't (see "Graph orientation constants"). 
  5707.  
  5708.  void 
  5709.  
  5710.  
  5711. ΓòÉΓòÉΓòÉ 2.9.12.12. MFrameXfer::setSingleXRange() ΓòÉΓòÉΓòÉ
  5712.  
  5713. setSingleXRange(int i) [virtual] 
  5714.  
  5715.       int i   New flag value 
  5716.  
  5717.  If 1, the X values in an X-Y graph will be drawn from only the first data 
  5718.  series (a column or row of data); if 0, alternating X and Y data series will 
  5719.  be used. 
  5720.  
  5721.  void 
  5722.  
  5723.  
  5724. ΓòÉΓòÉΓòÉ 2.9.12.13. MFrameXfer::setTitleInfo() ΓòÉΓòÉΓòÉ
  5725.  
  5726. setTitleInfo(int x, const MGraphElement *ge) [virtual] 
  5727.  
  5728.       int x   Which title? 
  5729.  
  5730.       const MGraphElement *ge   What should the title look like? 
  5731.  
  5732.  Sets information regarding the appearance of the given title. A graph frame 
  5733.  can include up to four titles (see "Graph title constants"). 
  5734.  
  5735.  For more information, see "MGraphElement". 
  5736.  
  5737.  void 
  5738.  
  5739.  
  5740. ΓòÉΓòÉΓòÉ 2.9.12.14. MFrameXfer::setTitles() ΓòÉΓòÉΓòÉ
  5741.  
  5742. setTitles(int, const char *) [virtual] 
  5743.  
  5744.       int   Which title?
  5745.  
  5746.       const char *   New text 
  5747.  
  5748.  Sets the text of the given title. A graph frame can include up to four titles 
  5749.  (see "Graph title constants"). 
  5750.  
  5751.  void 
  5752.  
  5753.  
  5754. ΓòÉΓòÉΓòÉ 2.9.12.15. MFrameXfer::setTopTitles() ΓòÉΓòÉΓòÉ
  5755.  
  5756. setTopTitles(int i) [virtual] 
  5757.  
  5758.       int i   New flag value 
  5759.  
  5760.  If 1, the range being graphed will include headings in the first row (if graph 
  5761.  is oriented by row) or in the first column (if graph is oriented by column); 
  5762.  if 0, it won't (see "Graph orientation constants"). 
  5763.  
  5764.  void 
  5765.  
  5766.  
  5767. ΓòÉΓòÉΓòÉ 2.9.13. Setting X and Y axis values in an MFrameXfer instance ΓòÉΓòÉΓòÉ
  5768.  
  5769. Open the Contents view and expand this section to see a list of methods. 
  5770.  
  5771.  
  5772. ΓòÉΓòÉΓòÉ 2.9.13.1. MFrameXfer::setAxisInfo() ΓòÉΓòÉΓòÉ
  5773.  
  5774. setAxisInfo(const MGraphElement *ge) [virtual] 
  5775.  
  5776.       const MGraphElement *ge   New appearance of the axes 
  5777.  
  5778.  Sets information regarding the appearance of the combined X and Y axes. 
  5779.  
  5780.  void 
  5781.  
  5782.  
  5783. ΓòÉΓòÉΓòÉ 2.9.13.2. MFrameXfer::setDisplayFormat() ΓòÉΓòÉΓòÉ
  5784.  
  5785. setDisplayFormat(int n, int df) [virtual] 
  5786.  
  5787.       int n      Which axis? 
  5788.  
  5789.       int df   Display format ID (see "Display format constants") 
  5790.  
  5791.  Sets the display format for the labels for the given axis. 
  5792.  
  5793.  void 
  5794.  
  5795.  
  5796. ΓòÉΓòÉΓòÉ 2.9.13.3. MFrameXfer::setMaxX() ΓòÉΓòÉΓòÉ
  5797.  
  5798. setMaxX(double d) [virtual] 
  5799.  
  5800.       double d   New maximum X 
  5801.  
  5802.  Sets the highest value to be graphed on the X axis. 
  5803.  
  5804.  void 
  5805.  
  5806.  
  5807. ΓòÉΓòÉΓòÉ 2.9.13.4. MFrameXfer::setMaxY() ΓòÉΓòÉΓòÉ
  5808.  
  5809. setMaxY(double d) [virtual] 
  5810.  
  5811.       double d   New maximum Y 
  5812.  
  5813.  Sets highest value to be graphed on the Y axis. 
  5814.  
  5815.  void 
  5816.  
  5817.  
  5818. ΓòÉΓòÉΓòÉ 2.9.13.5. MFrameXfer::setMinX() ΓòÉΓòÉΓòÉ
  5819.  
  5820. setMinX(double d) [virtual] 
  5821.  
  5822.       double d   New minimum X 
  5823.  
  5824.  Sets the lowest value to be graphed on the X axis. 
  5825.  
  5826.  void 
  5827.  
  5828.  
  5829. ΓòÉΓòÉΓòÉ 2.9.13.6. MFrameXfer::setMinY() ΓòÉΓòÉΓòÉ
  5830.  
  5831. setMinY(double d) [virtual] 
  5832.  
  5833.       double d   New minimum Y 
  5834.  
  5835.  Sets the lowest value to be graphed on theY axis. 
  5836.  
  5837.  void 
  5838.  
  5839.  
  5840. ΓòÉΓòÉΓòÉ 2.9.13.7. MFrameXfer::setXAutoScale() ΓòÉΓòÉΓòÉ
  5841.  
  5842. setXAutoScale(int i) [virtual] 
  5843.  
  5844.       int i   New flag value 
  5845.  
  5846.  If 1, the maximum and minimum X values will be automatically calculated based 
  5847.  on the data in the range to be graphed; if 0, they won't. 
  5848.  
  5849.  void 
  5850.  
  5851.  
  5852. ΓòÉΓòÉΓòÉ 2.9.13.8. MFrameXfer::setXAxisLoc() ΓòÉΓòÉΓòÉ
  5853.  
  5854. setXAxisLoc(int i) [virtual] 
  5855.  
  5856.       int i   New axis location 
  5857.  
  5858.  Sets the location of the X axis on the Y axis (see "Graph axis constants"). 
  5859.  
  5860.  void 
  5861.  
  5862.  
  5863. ΓòÉΓòÉΓòÉ 2.9.13.9. MFrameXfer::setXAxisRot() ΓòÉΓòÉΓòÉ
  5864.  
  5865. setXAxisRot(int i) [virtual] 
  5866.  
  5867.       int i   New axis label rotation 
  5868.  
  5869.  Sets the angle to which the X-axis labels are being rotated. 
  5870.  
  5871.  void 
  5872.  
  5873.  
  5874. ΓòÉΓòÉΓòÉ 2.9.13.10. MFrameXfer::setXGridCol() ΓòÉΓòÉΓòÉ
  5875.  
  5876. setXGridCol(const MColor *c) [virtual] 
  5877.  
  5878.       const MColor *c   New gridline color 
  5879.  
  5880.  Sets the color of the X axis grid lines. 
  5881.  
  5882.  void 
  5883.  
  5884.  
  5885. ΓòÉΓòÉΓòÉ 2.9.13.11. MFrameXfer::setXLogScale() ΓòÉΓòÉΓòÉ
  5886.  
  5887. setXLogScale(int i) [virtual] 
  5888.  
  5889.       int i   New flag value 
  5890.  
  5891.  If 1, the X axis is logarythmic; if 0, it isn't. 
  5892.  
  5893.  void 
  5894.  
  5895.  
  5896. ΓòÉΓòÉΓòÉ 2.9.13.12. MFrameXfer::setXMajTickSize() ΓòÉΓòÉΓòÉ
  5897.  
  5898. setXMajTickSize(int i) [virtual] 
  5899.  
  5900.       int i   New tick size 
  5901.  
  5902.  Sets the size, in pixels, of major ticks on the X axis. 
  5903.  
  5904.  void 
  5905.  
  5906.  
  5907. ΓòÉΓòÉΓòÉ 2.9.13.13. MFrameXfer::setXMajorGrid() ΓòÉΓòÉΓòÉ
  5908.  
  5909. setXMajorGrid(int i) [virtual] 
  5910.  
  5911.       int i   New flag value 
  5912.  
  5913.  If 1, grid lines will be drawn from the major ticks on the X axis; if 0, they 
  5914.  won't. 
  5915.  
  5916.  void 
  5917.  
  5918.  
  5919. ΓòÉΓòÉΓòÉ 2.9.13.14. MFrameXfer::setXMajorTicks() ΓòÉΓòÉΓòÉ
  5920.  
  5921. setXMajorTicks(int i) [virtual] 
  5922.  
  5923.       int i   New tick position 
  5924.  
  5925.  Sets position of the X major ticks relative to the X axis (see "Graph axis 
  5926.  constants"). 
  5927.  
  5928.  void 
  5929.  
  5930.  
  5931. ΓòÉΓòÉΓòÉ 2.9.13.15. MFrameXfer::setXMinTickSize() ΓòÉΓòÉΓòÉ
  5932.  
  5933. setXMinTickSize(int i) [virtual] 
  5934.  
  5935.       int i   New tick size 
  5936.  
  5937.  Sets the size, in pixels, of minor ticks on the X axis. 
  5938.  
  5939.  void 
  5940.  
  5941.  
  5942. ΓòÉΓòÉΓòÉ 2.9.13.16. MFrameXfer::setXMinorGrid() ΓòÉΓòÉΓòÉ
  5943.  
  5944. setXMinorGrid(int i) [virtual] 
  5945.  
  5946.       int i   New flag value 
  5947.  
  5948.  If 1, grid lines will be drawn from the minor ticks on the X axis; if 0, they 
  5949.  won't. 
  5950.  
  5951.  void 
  5952.  
  5953.  
  5954. ΓòÉΓòÉΓòÉ 2.9.13.17. MFrameXfer::setXMinorTicks() ΓòÉΓòÉΓòÉ
  5955.  
  5956. setXMinorTicks(int i) [virtual] 
  5957.  
  5958.       int i   New tick position 
  5959.  
  5960.  Sets position of the X minor ticks relative to the X axis (see "Graph axis 
  5961.  constants"). 
  5962.  
  5963.  void 
  5964.  
  5965.  
  5966. ΓòÉΓòÉΓòÉ 2.9.13.18. MFrameXfer::setYAutoScale() ΓòÉΓòÉΓòÉ
  5967.  
  5968. setYAutoScale(int i) [virtual] 
  5969.  
  5970.       int i   New flag value 
  5971.  
  5972.  If 1, the maximum and minimum X values will be automatically calculated based 
  5973.  on the data in the range to be graphed; if 0, they won't. 
  5974.  
  5975.  void 
  5976.  
  5977.  
  5978. ΓòÉΓòÉΓòÉ 2.9.13.19. MFrameXfer::setYAxisLoc() ΓòÉΓòÉΓòÉ
  5979.  
  5980. setYAxisLoc(int i) [virtual] 
  5981.  
  5982.       int i   New axis location 
  5983.  
  5984.  Sets the location of the Y axis on the X axis (see "Graph axis constants"). 
  5985.  
  5986.  void 
  5987.  
  5988.  
  5989. ΓòÉΓòÉΓòÉ 2.9.13.20. MFrameXfer::setYAxisRot() ΓòÉΓòÉΓòÉ
  5990.  
  5991. setYAxisRot(int i) [virtual] 
  5992.  
  5993.       int i   New label rotation 
  5994.  
  5995.  Sets the angle to which the Y-axis labels are being rotated. 
  5996.  
  5997.  void 
  5998.  
  5999.  
  6000. ΓòÉΓòÉΓòÉ 2.9.13.21. MFrameXfer::setYGridCol() ΓòÉΓòÉΓòÉ
  6001.  
  6002. setYGridCol(const MColor *c) [virtual] 
  6003.  
  6004.       const MColor *c   New grid color 
  6005.  
  6006.  Sets the color of the Y axis grid lines. 
  6007.  
  6008.  void 
  6009.  
  6010.  
  6011. ΓòÉΓòÉΓòÉ 2.9.13.22. MFrameXfer::setYLogScale() ΓòÉΓòÉΓòÉ
  6012.  
  6013. setYLogScale(int i) [virtual] 
  6014.  
  6015.       int i   New flag value 
  6016.  
  6017.  If 1, the Y axis is logarythmic; if 0, it is linear. 
  6018.  
  6019.  void 
  6020.  
  6021.  
  6022. ΓòÉΓòÉΓòÉ 2.9.13.23. MFrameXfer::setYMajTickSize() ΓòÉΓòÉΓòÉ
  6023.  
  6024. setYMajTickSize(int i) [virtual] 
  6025.  
  6026.       int i   New tick size 
  6027.  
  6028.  Sets the size, in pixels, of major ticks on theY axis. 
  6029.  
  6030.  void 
  6031.  
  6032.  
  6033. ΓòÉΓòÉΓòÉ 2.9.13.24. MFrameXfer::setYMajorGrid() ΓòÉΓòÉΓòÉ
  6034.  
  6035. setYMajorGrid(int i) [virtual] 
  6036.  
  6037.       int i   New flag value 
  6038.  
  6039.  If 1, grid lines will be drawn from the major ticks on the Y axis; if 0, they 
  6040.  won't. 
  6041.  
  6042.  void 
  6043.  
  6044.  
  6045. ΓòÉΓòÉΓòÉ 2.9.13.25. MFrameXfer::setYMajorTicks() ΓòÉΓòÉΓòÉ
  6046.  
  6047. setYMajorTicks(int i) [virtual] 
  6048.  
  6049.       int i   New tick position 
  6050.  
  6051.  Sets position of the Y major ticks relative to the Y axis (see "Graph axis 
  6052.  constants"). 
  6053.  
  6054.  void 
  6055.  
  6056.  
  6057. ΓòÉΓòÉΓòÉ 2.9.13.26. MFrameXfer::setYMinTickSize() ΓòÉΓòÉΓòÉ
  6058.  
  6059. setYMinTickSize(int i) [virtual] 
  6060.  
  6061.       int i   New tick size 
  6062.  
  6063.  Sets the size, in pixels, of minor ticks on the Y axis. 
  6064.  
  6065.  void 
  6066.  
  6067.  
  6068. ΓòÉΓòÉΓòÉ 2.9.13.27. MFrameXfer::setYMinorGrid() ΓòÉΓòÉΓòÉ
  6069.  
  6070. setYMinorGrid(int i) [virtual] 
  6071.  
  6072.       int i   New flag value 
  6073.  
  6074.  If 1, grid lines will be drawn from the minor ticks on the Y axis; if 0, they 
  6075.  won't. 
  6076.  
  6077.  void 
  6078.  
  6079.  
  6080. ΓòÉΓòÉΓòÉ 2.9.13.28. MFrameXfer::setYMinorTicks() ΓòÉΓòÉΓòÉ
  6081.  
  6082. setYMinorTicks(int i) [virtual] 
  6083.  
  6084.       int i   New tick position 
  6085.  
  6086.  Sets position of the Y minor ticks relative to the Y axis (see "Graph axis 
  6087.  constants"). 
  6088.  
  6089.  void 
  6090.  
  6091.  
  6092. ΓòÉΓòÉΓòÉ 2.9.14. Setting 3-d values in an MFrameXfer instance ΓòÉΓòÉΓòÉ
  6093.  
  6094. Open the Contents view and expand this section to see a list of methods. 
  6095.  
  6096.  
  6097. ΓòÉΓòÉΓòÉ 2.9.14.1. MFrameXfer::setWallCol() ΓòÉΓòÉΓòÉ
  6098.  
  6099. setWallCol(const MColor *c) [virtual] 
  6100.  
  6101.       const MColor *c   New wall color 
  6102.  
  6103.  Sets the color of the "wall" that is drawn behind the graphed data on a 
  6104.  three-dimensional graph. 
  6105.  
  6106.  void 
  6107.  
  6108.  
  6109. ΓòÉΓòÉΓòÉ 2.9.14.2. MFrameXfer::setWireFrame() ΓòÉΓòÉΓòÉ
  6110.  
  6111. setWireFrame(int i) [virtual] 
  6112.  
  6113.       int i   New flag value 
  6114.  
  6115.  If 1, the three-dimensional graph elements will be drawn in transparent 
  6116.  "wire-frame" form; if 0, they will be drawn in solid form. 
  6117.  
  6118.  void 
  6119.  
  6120.  
  6121. ΓòÉΓòÉΓòÉ 2.9.14.3. MFrameXfer::setXRot() ΓòÉΓòÉΓòÉ
  6122.  
  6123. setXRot(int i) [virtual] 
  6124.  
  6125.       int i   New X rotation 
  6126.  
  6127.  Sets the X rotation of a three-dimensional graph. 
  6128.  
  6129.  void 
  6130.  
  6131.  
  6132. ΓòÉΓòÉΓòÉ 2.9.14.4. MFrameXfer::setYRot() ΓòÉΓòÉΓòÉ
  6133.  
  6134. setYRot(int i) [virtual] 
  6135.  
  6136.       int i   New Y rotation 
  6137.  
  6138.  Sets the Y rotation of a three-dimensional graph. 
  6139.  
  6140.  void 
  6141.  
  6142.  
  6143. ΓòÉΓòÉΓòÉ 2.9.15. MFrameXfer operators ΓòÉΓòÉΓòÉ
  6144.  
  6145. Open the Contents view and expand this section to see a list of methods. 
  6146.  
  6147.  
  6148. ΓòÉΓòÉΓòÉ 2.9.15.1. MFrameXfer::operator=() ΓòÉΓòÉΓòÉ
  6149.  
  6150. operator=(const MFrameXfer &) 
  6151.  
  6152.       const MFrameXfer &   Parameter to compare to 
  6153.  
  6154.  Copies the values from the parameter to the current instance. Returns 
  6155.  reference to current instance. 
  6156.  
  6157.  MFrameXfer & 
  6158.  
  6159.  
  6160. ΓòÉΓòÉΓòÉ 2.10. MGController ΓòÉΓòÉΓòÉ
  6161.  
  6162. controller.h is the source file for this class. 
  6163.  
  6164. This class inherits from MObject 
  6165.  
  6166. An application-specific, abstract base class that handles application-wide 
  6167. message passing. Essentially, any information or task that is not file-specific 
  6168. is stored in and handled by the controller. 
  6169.  
  6170. There is only one controller object instantiated for the application, and a 
  6171. pointer to it is passed to each model when the model is instantiated, so that 
  6172. the model can access the controller functions. The MGController header file 
  6173. references an external MGController *theMesa. 
  6174.  
  6175. In order to use the Mesa DLLs, you must create and instantiate a subclass of 
  6176. MGController that properly handles message-passing between the DLLs and your 
  6177. application. Many MGController methods do not do anything directly, but rather 
  6178. rely on your application to handle the message. 
  6179.  
  6180. The controller keeps track of the following information: 
  6181.  
  6182.      Is the application currently running? 
  6183.  
  6184.      A list of open models 
  6185.  
  6186.      A set of window-buffering caches for faster display 
  6187.  
  6188.      An atom table 
  6189.  
  6190.      List of AddIns loaded into Mesa 
  6191.  
  6192.      A history buffer, containing the REXX equivalents of commands recently 
  6193.       executed 
  6194.  
  6195.      Localization data (default currency symbols, thousands-place separator, 
  6196.       date and time separator, decimal marker, precision, units, etc.) 
  6197.  
  6198.      A list of "pings" (time-delayed messages) that must be delivered 
  6199.  
  6200.      License status - are we in demo mode? What license has been entered (if 
  6201.       any)? Is it valid? 
  6202.  
  6203.      Real-time feed status - when was the real-time feed last run? What thread 
  6204.       is it running in? 
  6205.  
  6206.      Are we using RGB colors? 
  6207.  
  6208.  
  6209. ΓòÉΓòÉΓòÉ 2.10.1. Creating, destroying, and setting up an MGController instance ΓòÉΓòÉΓòÉ
  6210.  
  6211. Open the Contents view and expand this section to see a list of methods. 
  6212.  
  6213.  
  6214. ΓòÉΓòÉΓòÉ 2.10.1.1. MGController::MGController() ΓòÉΓòÉΓòÉ
  6215.  
  6216. MGController(const char *lic, int &licStatus, HAB, int useRGB, int 
  6217. bufferRedraw) 
  6218.  
  6219.       const char *lic   License string 
  6220.  
  6221.       int &licStatus   Storage location for license status 
  6222.  
  6223.       HAB   Anchor block for the Mesa application 
  6224.  
  6225.       int useRGB   Should we be using RGB colors? 
  6226.  
  6227.       int bufferRedraw   What's the buffer redraw? 
  6228.  
  6229.  Queries the license manager for status of lic and stores the result in 
  6230.  licStatus (see "License status constants"). Initializes controller contents 
  6231.  and stores the HAB, buffer redraw status, and RGB color status. 
  6232.  
  6233.  void 
  6234.  
  6235.  
  6236. ΓòÉΓòÉΓòÉ 2.10.1.2. MGController::~MGController() ΓòÉΓòÉΓòÉ
  6237.  
  6238. ~MGController() [virtual] 
  6239.  
  6240. Attempts to kill the real-time-data feed thread, frees the models, resets 
  6241. screen bitmap, and deletes all other GPI resources that were created. 
  6242.  
  6243. void 
  6244.  
  6245.  
  6246. ΓòÉΓòÉΓòÉ 2.10.1.3. MGController::cleanUp() ΓòÉΓòÉΓòÉ
  6247.  
  6248. cleanUp() [virtual] 
  6249.  
  6250. Frees all AddIns and registers that the application is no longer running (see 
  6251. also MGController::isRunning() ). 
  6252.  
  6253. void 
  6254.  
  6255.  
  6256. ΓòÉΓòÉΓòÉ 2.10.1.4. MGController::setUp() ΓòÉΓòÉΓòÉ
  6257.  
  6258. setUp() [virtual] 
  6259.  
  6260. Forks two new threads, one for the real-time feed table and to watch for 
  6261. "pings" (see MGController::watchPing()). 
  6262.  
  6263. void 
  6264.  
  6265.  
  6266. ΓòÉΓòÉΓòÉ 2.10.1.5. MGController::setupAddIns() ΓòÉΓòÉΓòÉ
  6267.  
  6268. setupAddIns() [virtual] 
  6269.  
  6270. Initializes the AddIns using PrfQueryProfileString and DosLoadModule. This must 
  6271. be called after the application is started, because many AddIns may need 
  6272. application-state information. 
  6273.  
  6274. void 
  6275.  
  6276.  
  6277. ΓòÉΓòÉΓòÉ 2.10.1.6. MGController::setupFuncs() ΓòÉΓòÉΓòÉ
  6278.  
  6279. setupFuncs() 
  6280.  
  6281. Sets up sorted lists of functions, unary operators, binary operators, and 
  6282. constants. 
  6283.  
  6284. static void 
  6285.  
  6286.  
  6287. ΓòÉΓòÉΓòÉ 2.10.2. Files and models ΓòÉΓòÉΓòÉ
  6288.  
  6289. Open the Contents view and expand this section to see a list of methods. 
  6290.  
  6291.  
  6292. ΓòÉΓòÉΓòÉ 2.10.2.1. MGController::addModel() ΓòÉΓòÉΓòÉ
  6293.  
  6294. addModel(MMesaModel *) [virtual] 
  6295.  
  6296.       MMesaModel *   Model to add to the model list 
  6297.  
  6298.  If the model doesn't already exist in the controller's model list, and it 
  6299.  refers to a unique pathname, it is added to the model list. 
  6300.  
  6301.  Returns 1 if the model is successfully added, 0 otherwise. 
  6302.  
  6303.  int 
  6304.  
  6305.  
  6306. ΓòÉΓòÉΓòÉ 2.10.2.2. MGController::findModel() ΓòÉΓòÉΓòÉ
  6307.  
  6308. findModel(MMesaModel *) [virtual] 
  6309.  
  6310.       MMesaModel *   Model to look for 
  6311.  
  6312.  Looks for a match to the given model in the model list. 
  6313.  
  6314.  Returns an index into the model list for the requested model, or -1 if the 
  6315.  model was not found. 
  6316.  
  6317.  int 
  6318.  
  6319.  findModel(const char *, int) [virtual] 
  6320.  
  6321.       const char *   File name of model to look for 
  6322.  
  6323.       int   Does this need to have a default path added to it? 1 to add path, 0 
  6324.       otherwise. Default is 1. 
  6325.  
  6326.  Scrolls through the model list looking for a model with the given filename. If 
  6327.  found, runs MGController::_findModel(), locking the model temporarily in order 
  6328.  to do so safely. 
  6329.  
  6330.  Returns pointer to the file/model in question. 
  6331.  
  6332.  MMesaModel * 
  6333.  
  6334.  
  6335. ΓòÉΓòÉΓòÉ 2.10.2.3. MGController::_findModel() ΓòÉΓòÉΓòÉ
  6336.  
  6337. _findModel(const char *, int) [virtual] 
  6338.  
  6339.       const char *   File name of model to look for 
  6340.  
  6341.       int   Does this need to have a default path added to it? 1 to add path, 0 
  6342.       otherwise. Default is 1. 
  6343.  
  6344.  Scrolls through the model list looking for a model with the given fileame. If 
  6345.  found, returns pointer to the file/model in question. 
  6346.  
  6347.  MMesaModel * 
  6348.  
  6349.  
  6350. ΓòÉΓòÉΓòÉ 2.10.2.4. MGController::getActiveModel() ΓòÉΓòÉΓòÉ
  6351.  
  6352. getActiveModel() [virtual] 
  6353.  
  6354. Within MGController, returns 0. Classes that inherit from MGController can 
  6355. implement this method to return the currently active model. This method is 
  6356. called by Mesa AddIns. 
  6357.  
  6358. MMesaModel * 
  6359.  
  6360.  
  6361. ΓòÉΓòÉΓòÉ 2.10.2.5. MGController::lockModel() ΓòÉΓòÉΓòÉ
  6362.  
  6363. lockModel() [virtual] 
  6364.  
  6365. Locks the current model (see also MGController::unlockModel() ). 
  6366.  
  6367. void 
  6368.  
  6369.  
  6370. ΓòÉΓòÉΓòÉ 2.10.2.6. MGController::makeBackup() ΓòÉΓòÉΓòÉ
  6371.  
  6372. makeBackup() [virtual] 
  6373.  
  6374. Within MGController, returns 0. Classes that inherit from MGController can 
  6375. implement this method to indicate whether a backup file should be created when 
  6376. a file is loaded/saved (see MFileStream). Should return 1 to make a backup, 0 
  6377. otherwise. 
  6378.  
  6379. int 
  6380.  
  6381.  
  6382. ΓòÉΓòÉΓòÉ 2.10.2.7. MGController::newModel() ΓòÉΓòÉΓòÉ
  6383.  
  6384. newModel() [virtual] 
  6385.  
  6386. Within MGController, returns 0. Classes that inherit from MGController can 
  6387. implement this method to create a new model and add it to the model list. This 
  6388. method is called by Mesa AddIns. 
  6389.  
  6390. MMesaModel * 
  6391.  
  6392.  
  6393. ΓòÉΓòÉΓòÉ 2.10.2.8. MGController::openFile() ΓòÉΓòÉΓòÉ
  6394.  
  6395. openFile(const char *) [virtual] 
  6396.  
  6397.       const char * 
  6398.  
  6399.  Within MGController, returns 0. Classes that inherit from MGController can 
  6400.  implement this method to handle opening files on the file server - for 
  6401.  example, by opening the OS/2 File Open dialog panel. This method is called 
  6402.  when executing REXX scripts and by Mesa AddIns. 
  6403.  
  6404.  MMesaModel * 
  6405.  
  6406.  
  6407. ΓòÉΓòÉΓòÉ 2.10.2.9. MGController::removeModel() ΓòÉΓòÉΓòÉ
  6408.  
  6409. removeModel(MMesaModel *) [virtual] 
  6410.  
  6411.       MMesaModel *   MMesaModel instance to remove 
  6412.  
  6413.  Removes the model from the model list. 
  6414.  
  6415.  void 
  6416.  
  6417.  
  6418. ΓòÉΓòÉΓòÉ 2.10.2.10. MGController::setAllModelsToSaved() ΓòÉΓòÉΓòÉ
  6419.  
  6420. setAllModelsToSaved() [virtual] 
  6421.  
  6422. For each model within the controller, set the "has it been changed since 
  6423. saving?" flag to 0, for no. 
  6424.  
  6425. void 
  6426.  
  6427.  
  6428. ΓòÉΓòÉΓòÉ 2.10.2.11. MGController::unlockModel() ΓòÉΓòÉΓòÉ
  6429.  
  6430. unlockModel() [virtual] 
  6431.  
  6432. Unlocks the mutex semaphore, allowing others to lock and make controller-wide 
  6433. changes (see also MGController::lockModel() ). 
  6434.  
  6435. void 
  6436.  
  6437.  
  6438. ΓòÉΓòÉΓòÉ 2.10.2.12. MGController::unsavedModel() ΓòÉΓòÉΓòÉ
  6439.  
  6440. unsavedModel() [virtual] 
  6441.  
  6442. Returns 1 if there are unsaved models in the model list, 0 otherwise. 
  6443.  
  6444. int 
  6445.  
  6446.  
  6447. ΓòÉΓòÉΓòÉ 2.10.3. AddIns ΓòÉΓòÉΓòÉ
  6448.  
  6449. Open the Contents view and expand this section to see a list of methods. 
  6450.  
  6451.  
  6452. ΓòÉΓòÉΓòÉ 2.10.3.1. MGController::addInAboutToClose() ΓòÉΓòÉΓòÉ
  6453.  
  6454. addInAboutToClose(MMesaModel *) [virtual] 
  6455.  
  6456.       MMesaModel *   Model parameter 
  6457.  
  6458.  Retrieves the function for the function type aboutToCloseAddInType (see "AddIn 
  6459.  type constants") from the first AddIn in the controller's AddIn list that has 
  6460.  a function set for that type (see MGController::registerAddIn()). If such an 
  6461.  AddIn is found, the controller executes it using the given model parameter and 
  6462.  returns the result. Otherwise, does nothing and returns 0. 
  6463.  
  6464.  int 
  6465.  
  6466.  
  6467. ΓòÉΓòÉΓòÉ 2.10.3.2. MGController::addInAboutToSave() ΓòÉΓòÉΓòÉ
  6468.  
  6469. addInAboutToSave(MMesaModel *) [virtual] 
  6470.  
  6471.       MMesaModel *   Model parameter 
  6472.  
  6473.  Retrieves the function for the function type aboutToSaveAddInType (see "AddIn 
  6474.  type constants") from the first AddIn in the controller's AddIn list that has 
  6475.  a function set for that type (see MGController::registerAddIn()). If such an 
  6476.  AddIn is found, the controller executes it using the given model parameter and 
  6477.  returns the result. Otherwise, does nothing and returns 0. 
  6478.  
  6479.  int 
  6480.  
  6481.  
  6482. ΓòÉΓòÉΓòÉ 2.10.3.3. MGController::addInDataAboutToBeEntered() ΓòÉΓòÉΓòÉ
  6483.  
  6484. addInDataAboutToBeEntered(MMesaModel *, const MAddress *, const char *) 
  6485. [virtual] 
  6486.  
  6487.       MMesaModel *   Model parameter 
  6488.  
  6489.       const MAddress *   Address parameter 
  6490.  
  6491.       const char *   String parameter 
  6492.  
  6493.  Retrieves the function for the function type dataEnteredAddInType (see "AddIn 
  6494.  type constants") from the first AddIn in the controller's AddIn list that has 
  6495.  a function set for that type (see MGController::registerAddIn()). If such an 
  6496.  AddIn is found, the controller executes it using the given model parameter, 
  6497.  string parameter, and the layer, row and column fields of the given address 
  6498.  parameter (see MAddress), and returns the result. Otherwise, does nothing and 
  6499.  returns 0. 
  6500.  
  6501.  int 
  6502.  
  6503.  
  6504. ΓòÉΓòÉΓòÉ 2.10.3.4. MGController::addInDoubleClick() ΓòÉΓòÉΓòÉ
  6505.  
  6506. addInDoubleClick(MMesaModel *, const MAddress *) [virtual] 
  6507.  
  6508.       MMesaModel *   Model parameter 
  6509.  
  6510.       const MAddress *   Address parameter 
  6511.  
  6512.  Retrieves the function for the function type doubleClickAddInType (see "AddIn 
  6513.  type constants") from the first AddIn in the controller's AddIn list that has 
  6514.  a function set for that type (see MGController::registerAddIn()). If such an 
  6515.  AddIn is found, the controller executes it using the given model parameter and 
  6516.  the layer, row and column fields of the given address parameter (see 
  6517.  MAddress), and returns the result. Otherwise, does nothing and returns 0. 
  6518.  
  6519.  void 
  6520.  
  6521.  
  6522. ΓòÉΓòÉΓòÉ 2.10.3.5. MGController::addInOpened() ΓòÉΓòÉΓòÉ
  6523.  
  6524. addInOpened(MMesaModel *) [virtual] 
  6525.  
  6526.       MMesaModel *   Model parameter 
  6527.  
  6528.  Retrieves the function for the function type openedAddInType (see "AddIn type 
  6529.  constants") from the first AddIn in the controller's AddIn list that has a 
  6530.  function set for that type (see MGController::registerAddIn()). If such an 
  6531.  AddIn is found, the controller executes it using the given model parameter and 
  6532.  returns the result. Otherwise, does nothing and returns 0. 
  6533.  
  6534.  void 
  6535.  
  6536.  
  6537. ΓòÉΓòÉΓòÉ 2.10.3.6. MGController::addInPMMessage() ΓòÉΓòÉΓòÉ
  6538.  
  6539. addInPMMessage(int, int, int, int) [virtual] 
  6540.  
  6541.       MMesaModel *   Model parameter 
  6542.  
  6543.  Retrieves the function for the function type pmMessageAddInType (see "AddIn 
  6544.  type constants") from the first AddIn in the controller's AddIn list that has 
  6545.  a function set for that type (see MGController::registerAddIn()). If such an 
  6546.  AddIn is found, the controller executes it using the given model parameter and 
  6547.  returns the result. Otherwise, does nothing and returns 0. 
  6548.  
  6549.  int 
  6550.  
  6551.  
  6552. ΓòÉΓòÉΓòÉ 2.10.3.7. MGController::doAddInMenuFunction() ΓòÉΓòÉΓòÉ
  6553.  
  6554. doAddInMenuFunction(int com, int type) [virtual] 
  6555.  
  6556.       int com   Menu command ID 
  6557.  
  6558.       int type   What should be done with the command? (0 to execute it, 1 to 
  6559.       return "can execute" setting for it, and 2 to trigger context-sensitive 
  6560.       help for it) 
  6561.  
  6562.  Retrieves the function for the function type menuAddInType (see "AddIn type 
  6563.  constants") from the first AddIn in the controller's AddIn list that has a 
  6564.  function set for that type (see MGController::registerAddIn()). If such an 
  6565.  AddIn is found, the controller either executes it, retrieves its "can execute" 
  6566.  setting, or triggers its context-sensitive help (depending on the value of 
  6567.  type) and returns the result. Otherwise, does nothing and returns 0. 
  6568.  
  6569.  int 
  6570.  
  6571.  
  6572. ΓòÉΓòÉΓòÉ 2.10.3.8. MGController::findFuncAddIns() ΓòÉΓòÉΓòÉ
  6573.  
  6574. findFuncAddIns(const char *, int = -1) [virtual] 
  6575.  
  6576.       const char *   Function name 
  6577.  
  6578.       int   Optional cached index into function AddIn list (for speeding 
  6579.       searches) 
  6580.  
  6581.  If a function AddIn with the given name exists in the function AddIn list, 
  6582.  returns an index into that list for that function. Otherwise, returns -1. 
  6583.  
  6584.  int 
  6585.  
  6586.  
  6587. ΓòÉΓòÉΓòÉ 2.10.3.9. MGController::getFuncAddInFBDescription() ΓòÉΓòÉΓòÉ
  6588.  
  6589. getFuncAddInFBDescription(int) [virtual] 
  6590.  
  6591.       int   Index into function AddIn list 
  6592.  
  6593.  Returns the description string defined in the given function AddIn, or a NULL 
  6594.  pointer if none exists (see also MGController::registerFunctionAddIn() ). 
  6595.  
  6596.  const char * 
  6597.  
  6598.  
  6599. ΓòÉΓòÉΓòÉ 2.10.3.10. MGController::getFuncAddInFBExample() ΓòÉΓòÉΓòÉ
  6600.  
  6601. getFuncAddInFBExample(int) [virtual] 
  6602.  
  6603.       int   Index into function AddIn list 
  6604.  
  6605.  Returns the example string defined in the given function AddIn, or a NULL 
  6606.  pointer if none exists (see also MGController::registerFunctionAddIn() ). 
  6607.  
  6608.  const char * 
  6609.  
  6610.  
  6611. ΓòÉΓòÉΓòÉ 2.10.3.11. MGController::getFuncAddInFBMembers() ΓòÉΓòÉΓòÉ
  6612.  
  6613. getFuncAddInFBMembers(int) [virtual] 
  6614.  
  6615.       int   Index into function AddIn list 
  6616.  
  6617.  Returns a list of function category IDs defined in the given function AddIn, 
  6618.  or a NULL pointer if none exists (see "Function category constants") (see also 
  6619.  MGController::registerFunctionAddIn() ). 
  6620.  
  6621.  const int * 
  6622.  
  6623.  
  6624. ΓòÉΓòÉΓòÉ 2.10.3.12. MGController::getFuncAddInFBName() ΓòÉΓòÉΓòÉ
  6625.  
  6626. getFuncAddInFBName(int) [virtual] 
  6627.  
  6628.       int   Index into function AddIn list 
  6629.  
  6630.  Returns the human-readable function name defined in the given function AddIn, 
  6631.  or a NULL pointer if none exists. Two functions can have the same 
  6632.  human-readable function name, and the name is not intended for anything but 
  6633.  display purposes (see also MGController::registerFunctionAddIn() ). (Compare 
  6634.  with MGController::getFuncAddInName().) 
  6635.  
  6636.  const char * 
  6637.  
  6638.  
  6639. ΓòÉΓòÉΓòÉ 2.10.3.13. MGController::getFuncAddInFBPrototype() ΓòÉΓòÉΓòÉ
  6640.  
  6641. getFuncAddInFBPrototype(int) [virtual] 
  6642.  
  6643.       int   Index into function AddIn list 
  6644.  
  6645.  Returns the prototype string defined in the given function AddIn, or a NULL 
  6646.  pointer if none exists (see also MGController::registerFunctionAddIn() ). 
  6647.  
  6648.  const char * 
  6649.  
  6650.  
  6651. ΓòÉΓòÉΓòÉ 2.10.3.14. MGController::getFuncAddInName() ΓòÉΓòÉΓòÉ
  6652.  
  6653. getFuncAddInName(int) [virtual] 
  6654.  
  6655.       int   Index into function AddIn list 
  6656.  
  6657.  Returns the name defined in the given function AddIn, or a NULL pointer if 
  6658.  none exists. Function names must be unique and are used to parse function 
  6659.  entries (see also MGController::registerFunctionAddIn() ). (Compare with 
  6660.  MGController::getFuncAddInFBName().) 
  6661.  
  6662.  const char * 
  6663.  
  6664.  
  6665. ΓòÉΓòÉΓòÉ 2.10.3.15. MGController::getNumFuncAddIns() ΓòÉΓòÉΓòÉ
  6666.  
  6667. getNumFuncAddIns() [virtual] 
  6668.  
  6669. Returns the number of function AddIns that have been loaded into the 
  6670. controller. 
  6671.  
  6672. int 
  6673.  
  6674.  
  6675. ΓòÉΓòÉΓòÉ 2.10.3.16. MGController::performAddInFunction() ΓòÉΓòÉΓòÉ
  6676.  
  6677. performAddInFunction(const char *, int numberOfParams, int cache, MStack 
  6678. *stack, MMesaModel *model) [virtual] 
  6679.  
  6680.       const char *   Name of function 
  6681.  
  6682.       int numberOfParams   Number of parameters in function 
  6683.  
  6684.       int cache   Cached AddIns (used to facilitate searching) 
  6685.  
  6686.       MStack *stack   Stack of parameters to pass to the function being 
  6687.       performed 
  6688.  
  6689.       MMesaModel *model   Model parameter to pass to the function being 
  6690.       performed 
  6691.  
  6692.  If the named function AddIn can be found in the AddIn list (see 
  6693.  MGController::findFuncAddIns()), then retrieves the function from that AddIn 
  6694.  (see MGController::registerAddIn()) and executes it using the given stack and 
  6695.  model as parameters, and returns index into the AddIn list. Otherwise, returns 
  6696.  -1 and does nothing. 
  6697.  
  6698.  int 
  6699.  
  6700.  
  6701. ΓòÉΓòÉΓòÉ 2.10.3.17. MGController::registerAddIn() ΓòÉΓòÉΓòÉ
  6702.  
  6703. registerAddIn(void *,void *,int) [virtual] 
  6704.  
  6705.       void *   Module to search for 
  6706.  
  6707.       void *   Function 
  6708.  
  6709.       int   AddIn function type 
  6710.  
  6711.  Finds the given module in the AddIn list or creates a new module and adds it 
  6712.  to the list; the associates the given function type in that AddIn (see "AddIn 
  6713.  type constants") with the given function. 
  6714.  
  6715.  void 
  6716.  
  6717.  
  6718. ΓòÉΓòÉΓòÉ 2.10.3.18. MGController::registerFunctionAddIn() ΓòÉΓòÉΓòÉ
  6719.  
  6720. registerFunctionAddIn(const char *name, const char *fbName, const char 
  6721. *fbProto, const char *fbDesc, const char *fbExample, int *fbMembers, void 
  6722. *callBack) [virtual] 
  6723.  
  6724.       const char *name   Function name, for formula-parsing purposes. 
  6725.  
  6726.       const char *fbName   Function name, for human-readable display purposes. 
  6727.  
  6728.       const char *fbProto   Function prototype, for human-readable display 
  6729.       purposes 
  6730.  
  6731.       const char *fbDesc   Function description, for human-readable display 
  6732.       purposes 
  6733.  
  6734.       const char *fbExampleFunction example, for human-readable display 
  6735.       purposes 
  6736.  
  6737.       int *fbMembers   What function categories does the function belong to 
  6738.       (see "Function category constants")? 
  6739.  
  6740.       void *callBack
  6741.  
  6742.  Finds the given function AddIn or creates a new one, and sets its fields to 
  6743.  the given values. 
  6744.  
  6745.  void 
  6746.  
  6747.  
  6748. ΓòÉΓòÉΓòÉ 2.10.4. Atoms and resources ΓòÉΓòÉΓòÉ
  6749.  
  6750. Open the Contents view and expand this section to see a list of methods. 
  6751.  
  6752.  
  6753. ΓòÉΓòÉΓòÉ 2.10.4.1. MGController::addStringToHistoryBuffer() ΓòÉΓòÉΓòÉ
  6754.  
  6755. addStringToHistoryBuffer(const char *) [virtual] 
  6756.  
  6757.       const char *   String to add 
  6758.  
  6759.  Within MGController, does nothing. Classes that inherit from MGController may 
  6760.  maintain a history buffer if desired; if so, this method should add the given 
  6761.  line to the buffer. 
  6762.  
  6763.  Various methods within DOK will execute this method - for example, 
  6764.  MSheetView::mouse1MotionEnd() may result in selecting a range, which will 
  6765.  attempt to add a line to the history buffer. 
  6766.  
  6767.  void 
  6768.  
  6769.  
  6770. ΓòÉΓòÉΓòÉ 2.10.4.2. MGController::findAtom() ΓòÉΓòÉΓòÉ
  6771.  
  6772. findAtom(const char *) [virtual] 
  6773.  
  6774.       const char *   String to search for in atom table 
  6775.  
  6776.  Pass-through to WinFindAtom(), or to WinAddAtom() if the string is not found. 
  6777.  
  6778.  int 
  6779.  
  6780.  
  6781. ΓòÉΓòÉΓòÉ 2.10.4.3. MGController::getAtom() ΓòÉΓòÉΓòÉ
  6782.  
  6783. getAtom(int) [virtual] 
  6784.  
  6785. Pass-through to WinQueryAtomName(). 
  6786.  
  6787. char * 
  6788.  
  6789.  
  6790. ΓòÉΓòÉΓòÉ 2.10.4.4. MGController::getAtomForMesa() ΓòÉΓòÉΓòÉ
  6791.  
  6792. getAtomForMesa() [virtual] 
  6793.  
  6794. Pass-through to MGController::findAtom(), using the application name. 
  6795.  
  6796. int 
  6797.  
  6798.  
  6799. ΓòÉΓòÉΓòÉ 2.10.4.5. MGController::getCharRes() ΓòÉΓòÉΓòÉ
  6800.  
  6801. getCharRes(int) [virtual] 
  6802.  
  6803.       int   Resource ID 
  6804.  
  6805.  Returns the string associated with the given resource ID in the resource 
  6806.  tables. 
  6807.  
  6808.  char * 
  6809.  
  6810.  
  6811. ΓòÉΓòÉΓòÉ 2.10.4.6. MGController::getErrorString() ΓòÉΓòÉΓòÉ
  6812.  
  6813. getErrorString(int, char *) [virtual] 
  6814.  
  6815.       int   Error number 
  6816.  
  6817.       char *   Buffer to hold string 
  6818.  
  6819.  Given an error number, copy the corresponding string into the buffer provided. 
  6820.  
  6821.  void 
  6822.  
  6823.  
  6824. ΓòÉΓòÉΓòÉ 2.10.4.7. MGController::getShortErrorString() ΓòÉΓòÉΓòÉ
  6825.  
  6826. getShortErrorString(int, char *) [virtual] 
  6827.  
  6828.       int   Error number 
  6829.  
  6830.       char *   Storage buffer 
  6831.  
  6832.  Stores the defined short error string for the given error number. 
  6833.  
  6834.  void 
  6835.  
  6836.  
  6837. ΓòÉΓòÉΓòÉ 2.10.4.8. MGController::getMaxErrorNumber() ΓòÉΓòÉΓòÉ
  6838.  
  6839. getMaxErrorNumber() [virtual] 
  6840.  
  6841. Returns largest known error number. 
  6842.  
  6843. int 
  6844.  
  6845.  
  6846. ΓòÉΓòÉΓòÉ 2.10.4.9. MGController::loadResString() ΓòÉΓòÉΓòÉ
  6847.  
  6848. loadResString(int, char *) [virtual] 
  6849.  
  6850.       int   Resource ID 
  6851.  
  6852.       char *   Storage location 
  6853.  
  6854.  Pass-through to WinLoadString() to store the string for the given resource ID. 
  6855.  Returns 1 if successful, 0 otherwise. 
  6856.  
  6857.   int 
  6858.  
  6859.  
  6860. ΓòÉΓòÉΓòÉ 2.10.5. REXX scripts ΓòÉΓòÉΓòÉ
  6861.  
  6862. Open the Contents view and expand this section to see a list of methods. 
  6863.  
  6864.  
  6865. ΓòÉΓòÉΓòÉ 2.10.5.1. MGController::addScriptToQueue() ΓòÉΓòÉΓòÉ
  6866.  
  6867. addScriptToQueue(const char *) [virtual] 
  6868.  
  6869.       const char *   Script to add 
  6870.  
  6871.  Within MGController, does nothing. Classes that inherit from MGController may 
  6872.  maintain a script queue if desired; if so, this method should add the given 
  6873.  script to the queue. 
  6874.  
  6875.  Various methods within DOK will execute this method - for example, 
  6876.  MSheetView::mouse1MotionEnd() may result in selecting a frame, which may 
  6877.  attempt to add a script to the queue if one is associated with that frame. 
  6878.  
  6879.  void 
  6880.  
  6881.  
  6882. ΓòÉΓòÉΓòÉ 2.10.5.2. MGController::runScript()=0 ΓòÉΓòÉΓòÉ
  6883.  
  6884. runScript(const char *, MException *) = 0 [virtual] 
  6885.  
  6886.       const char *   Script to run 
  6887.  
  6888.       MException *   MException instance for storing error/warning messages 
  6889.  
  6890.  Within MGController, does nothing. Classes that inherit from MGController can 
  6891.  implement this method to execute the given REXX script in a new thread. 
  6892.  
  6893.  void 
  6894.  
  6895.  
  6896. ΓòÉΓòÉΓòÉ 2.10.6. Windows ΓòÉΓòÉΓòÉ
  6897.  
  6898. Open the Contents view and expand this section to see a list of methods. 
  6899.  
  6900.  
  6901. ΓòÉΓòÉΓòÉ 2.10.6.1. MGController::addToDestroyList()=0 ΓòÉΓòÉΓòÉ
  6902.  
  6903. addToDestroyList(HWND) = 0 [virtual] 
  6904.  
  6905.       HWND   HWND to add to the destroy list. 
  6906.  
  6907.  Within MGController, does nothing. Classes that inherit from MGController may 
  6908.  maintain a destroy list which keeps track of windows that should be destroyed. 
  6909.  
  6910.  void 
  6911.  
  6912.  
  6913. ΓòÉΓòÉΓòÉ 2.10.6.2. MGController::getActiveWindow() ΓòÉΓòÉΓòÉ
  6914.  
  6915. getActiveWindow() [virtual] 
  6916.  
  6917. Within MGController, returns 0. Classes that inherit from MGController can 
  6918. implement this method to return a handle to the currently active window. This 
  6919. method is called during REXX script execution and by Mesa AddIns. 
  6920.  
  6921. HWND 
  6922.  
  6923.  
  6924. ΓòÉΓòÉΓòÉ 2.10.6.3. MGController::getApplicationClientWindow()=0 ΓòÉΓòÉΓòÉ
  6925.  
  6926. getApplicationClientWindow() = 0 [virtual] 
  6927.  
  6928. Within MGController, does nothing. Classes that inherit from MGController can 
  6929. implement this method to return a handle to the client window for the 
  6930. application. 
  6931.  
  6932. HWND 
  6933.  
  6934.  
  6935. ΓòÉΓòÉΓòÉ 2.10.6.4. MGController::getApplicationWindow() ΓòÉΓòÉΓòÉ
  6936.  
  6937. getApplicationWindow() [virtual] 
  6938.  
  6939. Within MGController, returns 0. Classes that inherit from MGController can 
  6940. implement this method to return a handle to the main application window. This 
  6941. method is called by Mesa AddIns. 
  6942.  
  6943. HWND 
  6944.  
  6945.  
  6946. ΓòÉΓòÉΓòÉ 2.10.6.5. MGController::getApplicationFrameWindow()=0 ΓòÉΓòÉΓòÉ
  6947.  
  6948. getApplicationFrameWindow() = 0 [virtual] 
  6949.  
  6950. Within MGController, does nothing. Classes that inherit from MGController can 
  6951. implement this method to return a handle to the frame window for the 
  6952. application. 
  6953.  
  6954. HWND 
  6955.  
  6956.  
  6957. ΓòÉΓòÉΓòÉ 2.10.6.6. MGController::getBufferRedraw() ΓòÉΓòÉΓòÉ
  6958.  
  6959. getBufferRedraw() [virtual] 
  6960.  
  6961. Returns 1 if the buffer should be redrawn, 0 otherwise. 
  6962.  
  6963. int 
  6964.  
  6965.  
  6966. ΓòÉΓòÉΓòÉ 2.10.6.7. MGController::getMenuWindow()=0 ΓòÉΓòÉΓòÉ
  6967.  
  6968. getMenuWindow()= 0 [virtual] 
  6969.  
  6970. Within MGController, does nothing. Classes that inherit from MGController can 
  6971. implement this method to return a handle to the main menu. This method is 
  6972. called by Mesa AddIns. 
  6973.  
  6974. int 
  6975.  
  6976.  
  6977. ΓòÉΓòÉΓòÉ 2.10.7. Event queue ΓòÉΓòÉΓòÉ
  6978.  
  6979. Open the Contents view and expand this section to see a list of methods. 
  6980.  
  6981.  
  6982. ΓòÉΓòÉΓòÉ 2.10.7.1. MGController::beAlive()=0 ΓòÉΓòÉΓòÉ
  6983.  
  6984. beAlive() = 0 [virtual] 
  6985.  
  6986. Within MGController, does nothing. Each class that inherits from MGController 
  6987. must provide a method to look at the message queue and process events in a 
  6988. timely fashion. 
  6989.  
  6990. Returns 1 to keep running, 0 to terminate application. 
  6991.  
  6992. int 
  6993.  
  6994.  
  6995. ΓòÉΓòÉΓòÉ 2.10.7.2. MGController::ping() ΓòÉΓòÉΓòÉ
  6996.  
  6997. ping(int, HWND, MPARAM=0, MPARAM=0) [virtual] 
  6998.  
  6999.       int   Duration in microseconds before sending the ping 
  7000.  
  7001.       HWND   HWND of the window to ping 
  7002.  
  7003.       MPARAM=0   Message Parameter 1 to send; defaults to 0 
  7004.  
  7005.       MPARAM=0   Message Parameter 2 to send; defaults to 0 
  7006.  
  7007.  Waits a given number of microseconds and then sends a MEM_PING message to the 
  7008.  given window, including the two message parameters. 
  7009.  
  7010.  void 
  7011.  
  7012.  
  7013. ΓòÉΓòÉΓòÉ 2.10.7.3. MGController::watchPing() ΓòÉΓòÉΓòÉ
  7014.  
  7015. watchPing() [virtual] 
  7016.  
  7017. This method is run when the controller is first created (see 
  7018. MGController::setUp()), and continues to run until the application stops 
  7019. running (see also MGController::cleanUp() ). Every 50 milliseconds, it runs 
  7020. through the event queue and posts messages to the appropriate windows. 
  7021.  
  7022. void 
  7023.  
  7024.  
  7025. ΓòÉΓòÉΓòÉ 2.10.8. Commands ΓòÉΓòÉΓòÉ
  7026.  
  7027. Open the Contents view and expand this section to see a list of methods. 
  7028.  
  7029.  
  7030. ΓòÉΓòÉΓòÉ 2.10.8.1. MGController::canExecute() ΓòÉΓòÉΓòÉ
  7031.  
  7032. canExecute(int, int &flags) [virtual] 
  7033.  
  7034.       int   Command ID 
  7035.  
  7036.       int &flags   Storage location for flags 
  7037.  
  7038.  Returns 1 if the command can be executed. Within MGController, returns 0 and 
  7039.  sets flags to 0. Classes that inherit from MGController should include tests 
  7040.  for application-specific commands to determine whether those commands can be 
  7041.  executed when this method is called (see also MWindow::canExecute() ). 
  7042.  
  7043.  int 
  7044.  
  7045.  
  7046. ΓòÉΓòÉΓòÉ 2.10.9. Status indicators ΓòÉΓòÉΓòÉ
  7047.  
  7048. Open the Contents view and expand this section to see a list of methods. 
  7049.  
  7050.  
  7051. ΓòÉΓòÉΓòÉ 2.10.9.1. MGController::cycleCalcIndicator() ΓòÉΓòÉΓòÉ
  7052.  
  7053. cycleCalcIndicator() [virtual] 
  7054.  
  7055. Within MGController, does nothing. Classes that inherit from MGController can 
  7056. implement this method to activate a visual indicator that recalculation is 
  7057. occurring. This method is called during recalculation (see recalc(const 
  7058. MAddress *, int) [virtual]). 
  7059.  
  7060. void 
  7061.  
  7062.  
  7063. ΓòÉΓòÉΓòÉ 2.10.9.2. MGController::displayException()=0 ΓòÉΓòÉΓòÉ
  7064.  
  7065. displayException(const MException *) = 0 [virtual] 
  7066.  
  7067.       const MException *   MException reference 
  7068.  
  7069.  Within MGController, does nothing. Classes that inherit from MGController must 
  7070.  handle displaying values from an MException instance, such as errors and 
  7071.  warnings (see MException). 
  7072.  
  7073.  void 
  7074.  
  7075.  
  7076. ΓòÉΓòÉΓòÉ 2.10.9.3. MGController::percentComplete()=0 ΓòÉΓòÉΓòÉ
  7077.  
  7078. percentComplete(int) = 0 [virtual] 
  7079.  
  7080.       int   What percent complete the operation is. 
  7081.  
  7082.  Within MGController, does nothing. Classes that inherit from MGController can 
  7083.  implement this method to display some indication that an operation is a 
  7084.  certain percent complete. This method is called by models at many different 
  7085.  times by Mesa models. 
  7086.  
  7087.  void 
  7088.  
  7089.  
  7090. ΓòÉΓòÉΓòÉ 2.10.9.4. MGController::seriousError() ΓòÉΓòÉΓòÉ
  7091.  
  7092. seriousError(const char *) [virtual] 
  7093.  
  7094.       const char *   Error message 
  7095.  
  7096.  A serious error is one which will terminate the Mesa 2 application after 
  7097.  display. This method creates a WinMessageBox that prints the error message 
  7098.  along with the results of WinGetLastError(). The controller also deallocates 
  7099.  all memory allocated to AddIns. 
  7100.  
  7101.  void 
  7102.  
  7103.  
  7104. ΓòÉΓòÉΓòÉ 2.10.9.5. MGController::setStatusMessage()=0 ΓòÉΓòÉΓòÉ
  7105.  
  7106. setStatusMessage(const char *) = 0 [virtual] 
  7107.  
  7108.       const char *   Current status message 
  7109.  
  7110.  Within MGController, does nothing. Classes that inherit from MGController can 
  7111.  implement this method to display a current-status message. 
  7112.  
  7113.  void 
  7114.  
  7115.  
  7116. ΓòÉΓòÉΓòÉ 2.10.10. Display formats ΓòÉΓòÉΓòÉ
  7117.  
  7118. Open the Contents view and expand this section to see a list of methods. 
  7119.  
  7120.  
  7121. ΓòÉΓòÉΓòÉ 2.10.10.1. MGController::getCurrency() ΓòÉΓòÉΓòÉ
  7122.  
  7123. getCurrency() [virtual] 
  7124.  
  7125. Returns the currency character, which is either the prefix or the trailing 
  7126. character, for the current default first currency type. This is $ by default 
  7127. (see also MGController::getCurrencyChars() ). 
  7128.  
  7129. const char * 
  7130.  
  7131.  
  7132. ΓòÉΓòÉΓòÉ 2.10.10.2. MGController::getCurrencyChars() ΓòÉΓòÉΓòÉ
  7133.  
  7134. getCurrencyChars(int, int) [virtual] 
  7135.  
  7136.       int    Which currency type? (0 for dollars, 1 for yen, 2 for pounds, 3 
  7137.       for generic American numeric format) 
  7138.  
  7139.       int    Which field to retrieve? (0 for decimal marker, 1 for thousands 
  7140.       separator, 2 for prefix, 3 for trailing character.) 
  7141.  
  7142.  Returns the character or characters for the given field of the given currency 
  7143.  type from the default initial currency formats. (Compare with 
  7144.  MMesaModel::getCurSymbols().) For more information, see "Currency and numeric 
  7145.  symbols". 
  7146.  
  7147.  For example, getCurrencyChars(0,2) will return $, while getCurrencyChars(2,2) 
  7148.  will return an empty string (since pound format does not have a prefix 
  7149.  character). 
  7150.  
  7151.  const char * 
  7152.  
  7153.  
  7154. ΓòÉΓòÉΓòÉ 2.10.10.3. MGController::getCurrencyPrefix() ΓòÉΓòÉΓòÉ
  7155.  
  7156. getCurrencyPrefix() [virtual] 
  7157.  
  7158. Returns 1 if the current default first currency type has a prefix currency 
  7159. symbol (e.g; the American dollar) and 0 otherwise. 
  7160.  
  7161. const int 
  7162.  
  7163.  
  7164. ΓòÉΓòÉΓòÉ 2.10.10.4. MGController::getDateFormat() ΓòÉΓòÉΓòÉ
  7165.  
  7166. getDateFormat() [virtual] 
  7167.  
  7168. Returns the current default date format (see "Display format constants"). 
  7169.  
  7170. const unsigned int 
  7171.  
  7172.  
  7173. ΓòÉΓòÉΓòÉ 2.10.10.5. MGController::getDateOrder() ΓòÉΓòÉΓòÉ
  7174.  
  7175. getDateOrder() [virtual] 
  7176.  
  7177. Returns 0 if the current default date format lists month first, then day, then 
  7178. year. 
  7179.  
  7180. Returns 1 if the current default date format lists day first, then month, then 
  7181. year. 
  7182.  
  7183. Returns 2 if the current default date format lists year first, then month, then 
  7184. day. 
  7185.  
  7186. For example, if the current default date format is dateDMYFormat, 
  7187. getDateOrder() will return 1 (see "Display format constants"). 
  7188.  
  7189. const int 
  7190.  
  7191.  
  7192. ΓòÉΓòÉΓòÉ 2.10.10.6. MGController::getDateSep() ΓòÉΓòÉΓòÉ
  7193.  
  7194. getDateSep() [virtual] 
  7195.  
  7196. Returns the character used to separate month, date and year in the current 
  7197. default date format. 
  7198.  
  7199. For example, if the current default date format is dateDMYFormat, getDateSep() 
  7200. will return / (see "Display format constants"). 
  7201.  
  7202. const char * 
  7203.  
  7204.  
  7205. ΓòÉΓòÉΓòÉ 2.10.10.7. MGController::getDecSep() ΓòÉΓòÉΓòÉ
  7206.  
  7207. getDecSep() [virtual] 
  7208.  
  7209. Returns the decimal marker used in the default first currency format (see also 
  7210. MGController::getCurrencyChars() ). 
  7211.  
  7212. const char * 
  7213.  
  7214.  
  7215. ΓòÉΓòÉΓòÉ 2.10.10.8. MGController::getThousandsSep() ΓòÉΓòÉΓòÉ
  7216.  
  7217. getThousandsSep() [virtual] 
  7218.  
  7219. Returns the thousands-place separator defined for the current default first 
  7220. currency format. (Compare with MGController::getCurrencyChars().) 
  7221.  
  7222. const char * 
  7223.  
  7224.  
  7225. ΓòÉΓòÉΓòÉ 2.10.10.9. MGController::getTimeAM() ΓòÉΓòÉΓòÉ
  7226.  
  7227. getTimeAM() [virtual] 
  7228.  
  7229. Returns the string used to indicate morning in 12-hour time formats (see 
  7230. "Display format constants"). 
  7231.  
  7232. const char * 
  7233.  
  7234.  
  7235. ΓòÉΓòÉΓòÉ 2.10.10.10. MGController::getTimeFormat() ΓòÉΓòÉΓòÉ
  7236.  
  7237. getTimeFormat() [virtual] 
  7238.  
  7239. Returns the time format ID (see "Display format constants"). 
  7240.  
  7241. const unsigned int 
  7242.  
  7243.  
  7244. ΓòÉΓòÉΓòÉ 2.10.10.11. MGController::getTimePM() ΓòÉΓòÉΓòÉ
  7245.  
  7246. getTimePM() [virtual] 
  7247.  
  7248. Returns the string used to indicate afternoon in 12-hour time formats (see 
  7249. "Display format constants"). 
  7250.  
  7251. const char * 
  7252.  
  7253.  
  7254. ΓòÉΓòÉΓòÉ 2.10.10.12. MGController::getTimeSep() ΓòÉΓòÉΓòÉ
  7255.  
  7256. getTimeSep() [virtual] 
  7257.  
  7258. Returns the string used to separate hours, minutes and seconds in time display 
  7259. formats (see "Display format constants"). 
  7260.  
  7261. const char * 
  7262.  
  7263.  
  7264. ΓòÉΓòÉΓòÉ 2.10.11. Licensing ΓòÉΓòÉΓòÉ
  7265.  
  7266. Open the Contents view and expand this section to see a list of methods. 
  7267.  
  7268.  
  7269. ΓòÉΓòÉΓòÉ 2.10.11.1. MGController::getInDemoMode() ΓòÉΓòÉΓòÉ
  7270.  
  7271. getInDemoMode() [virtual] 
  7272.  
  7273. Returns 1 if in demo mode, 0 otherwise. 
  7274.  
  7275. int 
  7276.  
  7277.  
  7278. ΓòÉΓòÉΓòÉ 2.10.11.2. MGController::getLicense() ΓòÉΓòÉΓòÉ
  7279.  
  7280. getLicense(int) [virtual] 
  7281.  
  7282.       int   Truncate hyphenated license string? 1 for yes, 0 for no. 
  7283.  
  7284.  Returns license string being used. Flag passed in controls whether the second 
  7285.  part of a hyphenated license is returned. 
  7286.  
  7287.  If the current license string is F154-14, then getLicense(1) returns F154 
  7288.  while getLicense(0) returns F154-14. (Hyphenated licenses are a site-licensing 
  7289.  convention.) 
  7290.  
  7291.  const char * 
  7292.  
  7293.  
  7294. ΓòÉΓòÉΓòÉ 2.10.12. Current selection ΓòÉΓòÉΓòÉ
  7295.  
  7296. Open the Contents view and expand this section to see a list of methods. 
  7297.  
  7298.  
  7299. ΓòÉΓòÉΓòÉ 2.10.12.1. MGController::getCurrentAddress() ΓòÉΓòÉΓòÉ
  7300.  
  7301. getCurrentAddress(MAddress *) [virtual] 
  7302.  
  7303.       MAddress *   Storage location 
  7304.  
  7305.  Within MGController, always returns 0. Classes that inherit from MGController 
  7306.  can implement this method to store the address of the current base cell; it 
  7307.  should return 1 if successful and 0 otherwise. This method is called by Mesa 
  7308.  AddIns. 
  7309.  
  7310.  int 
  7311.  
  7312.  
  7313. ΓòÉΓòÉΓòÉ 2.10.12.2. MGController::getCurrentRange() ΓòÉΓòÉΓòÉ
  7314.  
  7315. getCurrentRange(MRange *) [virtual] 
  7316.  
  7317.       MRange *   Storage location 
  7318.  
  7319.  Within MGController, returns 0. Classes that inherit from MGController can 
  7320.  implement this method to store the address of the currently selected range. 
  7321.  This method is called by Mesa AddIns. 
  7322.  
  7323.  int 
  7324.  
  7325.  
  7326. ΓòÉΓòÉΓòÉ 2.10.12.3. MGController::selectRange() ΓòÉΓòÉΓòÉ
  7327.  
  7328. selectRange(const char *) [virtual] 
  7329.  
  7330.       const char *   Address of range to select 
  7331.  
  7332.  Within MGController, does nothing. Classes that inherit from MGController can 
  7333.  implement this method to select a range in the active window with the given 
  7334.  address. This method is called by Mesa AddIns. 
  7335.  
  7336.  void 
  7337.  
  7338.  
  7339. ΓòÉΓòÉΓòÉ 2.10.13. Default dimensions ΓòÉΓòÉΓòÉ
  7340.  
  7341. Open the Contents view and expand this section to see a list of methods. 
  7342.  
  7343.  
  7344. ΓòÉΓòÉΓòÉ 2.10.13.1. MGController::getDefaultRowsAndCols() ΓòÉΓòÉΓòÉ
  7345.  
  7346. getDefaultRowsAndCols(int &, int &) [virtual] 
  7347.  
  7348.       int &   Storage for rows 
  7349.  
  7350.       int &   Storage for columns 
  7351.  
  7352.  Stores the default row/column size. In MGController, the defaults are 32x32. 
  7353.  
  7354.  void 
  7355.  
  7356.  
  7357. ΓòÉΓòÉΓòÉ 2.10.13.2. MGController::getDefaultUndoAndLayers() ΓòÉΓòÉΓòÉ
  7358.  
  7359. getDefaultUndoAndLayers(int &, int &) [virtual] 
  7360.  
  7361.       int &   Storage for number of undo levels 
  7362.  
  7363.       int &   Storage for number of layers 
  7364.  
  7365.  Stores the default undo/layer settings. In MGController, the defaults are 32 
  7366.  undo levels and 1 layer. 
  7367.  
  7368.  void 
  7369.  
  7370.  
  7371. ΓòÉΓòÉΓòÉ 2.10.14. Keyboard and mouse actions ΓòÉΓòÉΓòÉ
  7372.  
  7373. Open the Contents view and expand this section to see a list of methods. 
  7374.  
  7375.  
  7376. ΓòÉΓòÉΓòÉ 2.10.14.1. MGController::getEnterBehavior() ΓòÉΓòÉΓòÉ
  7377.  
  7378. getEnterBehavior() [virtual] 
  7379.  
  7380. Within MGController, returns 0. Classes that inherit from MGController can 
  7381. implement this method to return an ID indicating what should happen when the 
  7382. Enter key is pressed (see "Enter behavior constants"). 
  7383.  
  7384. int 
  7385.  
  7386.  
  7387. ΓòÉΓòÉΓòÉ 2.10.14.2. MGController::getHitPoint()=0 ΓòÉΓòÉΓòÉ
  7388.  
  7389. getHitPoint() = 0 [virtual] 
  7390.  
  7391. Within MGController, does nothing. Classes that inherit from MGController can 
  7392. implement this method to return most recent hit-point location of the mouse. 
  7393.  
  7394. MPoint 
  7395.  
  7396.  
  7397. ΓòÉΓòÉΓòÉ 2.10.14.3. MGController::handleKey()=0 ΓòÉΓòÉΓòÉ
  7398.  
  7399. handleKey(int, int) = 0 [virtual] 
  7400.  
  7401.       int   Character entered 
  7402.  
  7403.       int   Other key flags set (Ctrl, Alt, etc.) 
  7404.  
  7405.  Within MGController, does nothing. Classes that inherit from MGController can 
  7406.  implement this method to indicate whether the key has been handled - 0 if it 
  7407.  has, 1 if it has not. 
  7408.  
  7409.  int 
  7410.  
  7411.  
  7412. ΓòÉΓòÉΓòÉ 2.10.15. Recalculation and real-time data feeds ΓòÉΓòÉΓòÉ
  7413.  
  7414. Open the Contents view and expand this section to see a list of methods. 
  7415.  
  7416.  
  7417. ΓòÉΓòÉΓòÉ 2.10.15.1. MGController::getRealTimeValue() ΓòÉΓòÉΓòÉ
  7418.  
  7419. getRealTimeValue(const char *, const char *, double &val) [virtual] 
  7420.  
  7421.       const char *   First ID string 
  7422.  
  7423.       const char *   Second ID string 
  7424.  
  7425.       double &val   Storage buffer 
  7426.  
  7427.  Looks in the real-time feed table for an entry containing both ID strings, and 
  7428.  stores the associated value in val. Returns noError if the entry is found, or 
  7429.  feedNotFoundError otherwise. 
  7430.  
  7431.  int 
  7432.  
  7433.  
  7434. ΓòÉΓòÉΓòÉ 2.10.15.2. MGController::recalcNeedFeeds() ΓòÉΓòÉΓòÉ
  7435.  
  7436. recalcNeedFeeds() [virtual] 
  7437.  
  7438. Recalculates all models in the model list that depend on the real-time feed 
  7439. table (see MMesaModel::getHasFeed()) and are set to automatically recalculate 
  7440. (see MMesaModel::getAutoRecalc()). 
  7441.  
  7442. void 
  7443.  
  7444.  
  7445. ΓòÉΓòÉΓòÉ 2.10.15.3. MGController::setRealTimeValue() ΓòÉΓòÉΓòÉ
  7446.  
  7447. setRealTimeValue(const char *, const char *, double) [virtual] 
  7448.  
  7449.       const char *   First ID string 
  7450.  
  7451.       const char *   Second ID string 
  7452.  
  7453.       double   Value 
  7454.  
  7455.  Adds an entry to the real-time data feed table with the two identifier strings 
  7456.  and the double value. 
  7457.  
  7458.  void 
  7459.  
  7460.  
  7461. ΓòÉΓòÉΓòÉ 2.10.15.4. MGController::waitForData() ΓòÉΓòÉΓòÉ
  7462.  
  7463. waitForData() [virtual] 
  7464.  
  7465. Polls the real-time data feed table every 250 microseconds. If data has 
  7466. changed, triggers a recalculation of those models that depend on the feed table 
  7467. (see MGController::recalcNeedFeeds()). 
  7468.  
  7469. void 
  7470.  
  7471.  
  7472. ΓòÉΓòÉΓòÉ 2.10.16. Retrieving thread information ΓòÉΓòÉΓòÉ
  7473.  
  7474. Open the Contents view and expand this section to see a list of methods. 
  7475.  
  7476.  
  7477. ΓòÉΓòÉΓòÉ 2.10.16.1. MGController::getThreadNum() ΓòÉΓòÉΓòÉ
  7478.  
  7479. getThreadNum() [virtual] 
  7480.  
  7481. Returns the thread number for the controller. 
  7482.  
  7483. int 
  7484.  
  7485.  
  7486. ΓòÉΓòÉΓòÉ 2.10.17. Retrieving current status of the application ΓòÉΓòÉΓòÉ
  7487.  
  7488. Open the Contents view and expand this section to see a list of methods. 
  7489.  
  7490.  
  7491. ΓòÉΓòÉΓòÉ 2.10.17.1. MGController::getInBeAlive()=0 ΓòÉΓòÉΓòÉ
  7492.  
  7493. getInBeAlive() = 0 [virtual] 
  7494.  
  7495. Within MGController, does nothing. Classes that inherit from MGController can 
  7496. implement this method to indicate if MGController::beAlive()=0 is currently 
  7497. running (1 if so, 0 otherwise). 
  7498.  
  7499. int 
  7500.  
  7501.  
  7502. ΓòÉΓòÉΓòÉ 2.10.17.2. MGController::isApplicationActive() ΓòÉΓòÉΓòÉ
  7503.  
  7504. isApplicationActive() [virtual] 
  7505.  
  7506. Within MGController, always returns 1. Classes that inherit from MGController 
  7507. can implement this method to determine whether the application is currently 
  7508. active. This method is called by the edit view to control blinking of the 
  7509. insertion point (see MEditView::winPing()). 
  7510.  
  7511. int 
  7512.  
  7513.  
  7514. ΓòÉΓòÉΓòÉ 2.10.17.3. MGController::isEditing()=0 ΓòÉΓòÉΓòÉ
  7515.  
  7516. isEditing() = 0 [virtual] 
  7517.  
  7518. Within MGController, does nothing. Classes that inherit from MGController can 
  7519. implement this method to indicate whether a model is currently being edited (1 
  7520. if so, 0 otherwise). This method is called primarily by display classes to 
  7521. determine whether certain commands can be executed (see MWindow::canExecute()). 
  7522.  
  7523. int 
  7524.  
  7525.  
  7526. ΓòÉΓòÉΓòÉ 2.10.17.4. MGController::isEditingFormula()=0 ΓòÉΓòÉΓòÉ
  7527.  
  7528. isEditingFormula() = 0 [virtual] 
  7529.  
  7530. Within MGController, does nothing. Classes that inherit from MGController can 
  7531. implement this method to indicate whether a formula in a model is currently 
  7532. being edited (1 if so, 0 otherwise). This method is called primarily by display 
  7533. classes to allow different behavior for common actions (besides simple 
  7534. text-entry) while editing a formula; e.g. dragging the mouse to enter a range 
  7535. address rather than select the range. 
  7536.  
  7537. int 
  7538.  
  7539.  
  7540. ΓòÉΓòÉΓòÉ 2.10.17.5. MGController::isRunning() ΓòÉΓòÉΓòÉ
  7541.  
  7542. isRunning() [virtual] 
  7543.  
  7544. Returns 1 if the application is registered as running, 0 otherwise (see also 
  7545. MGController::cleanUp() ). 
  7546.  
  7547. int 
  7548.  
  7549.  
  7550. ΓòÉΓòÉΓòÉ 2.10.18. RGB colors ΓòÉΓòÉΓòÉ
  7551.  
  7552. Open the Contents view and expand this section to see a list of methods. 
  7553.  
  7554.  
  7555. ΓòÉΓòÉΓòÉ 2.10.18.1. MGController::getUseRGB() ΓòÉΓòÉΓòÉ
  7556.  
  7557. getUseRGB() [virtual] 
  7558.  
  7559. Returns 1 if using RGB colors, 0 otherwise. 
  7560.  
  7561. int 
  7562.  
  7563.  
  7564. ΓòÉΓòÉΓòÉ 2.10.19. Edit view ΓòÉΓòÉΓòÉ
  7565.  
  7566. Open the Contents view and expand this section to see a list of methods. 
  7567.  
  7568.  
  7569. ΓòÉΓòÉΓòÉ 2.10.19.1. MGController::getEditView()=0 ΓòÉΓòÉΓòÉ
  7570.  
  7571. getEditView() = 0 [virtual] 
  7572.  
  7573. Within MGController, does nothing. Classes that inherit from MGController can 
  7574. implement this method to return a pointer to the application's edit view, if 
  7575. one exists (see MEditView). 
  7576.  
  7577. MEditView * 
  7578.  
  7579.  
  7580. ΓòÉΓòÉΓòÉ 2.10.19.2. MGController::removeEdit()=0 ΓòÉΓòÉΓòÉ
  7581.  
  7582. removeEdit() = 0 [virtual] 
  7583.  
  7584. Within MGController, does nothing. Classes that inherit from MGController can 
  7585. implement this method to remove the displayed value from the edit view. 
  7586.  
  7587. void 
  7588.  
  7589.  
  7590. ΓòÉΓòÉΓòÉ 2.10.19.3. MGController::resizeFormulaView()=0 ΓòÉΓòÉΓòÉ
  7591.  
  7592. resizeFormulaView()= 0 [virtual] 
  7593.  
  7594. Within MGController, does nothing. Classes that inherit from MGController can 
  7595. implement this method to resize a "formula view" - a area that displays the 
  7596. underlying contents of the current base cell (see also 
  7597. MGController::updateFormulaView()=0 ). 
  7598.  
  7599. void 
  7600.  
  7601.  
  7602. ΓòÉΓòÉΓòÉ 2.10.19.4. MGController::updateFormulaView()=0 ΓòÉΓòÉΓòÉ
  7603.  
  7604. updateFormulaView() = 0 [virtual] 
  7605.  
  7606. Within MGController, does nothing. Classes that inherit from MGController can 
  7607. implement this method to redisplay the contents of the current base cell in a 
  7608. separate "formula view" window (see also MGController::resizeFormulaView()=0 ). 
  7609.  
  7610. void 
  7611.  
  7612.  
  7613. ΓòÉΓòÉΓòÉ 2.11. MInterest ΓòÉΓòÉΓòÉ
  7614.  
  7615. interest.h is the source file for this class. 
  7616.  
  7617. This class inherits from MObject 
  7618.  
  7619. Abstract base class that represents interest in an model, which results in 
  7620. notifications being sent when that model undergoes a state change. Each model 
  7621. maintains a list of registered interests in it (see 
  7622. MMesaModel::registerInterest()), and notifies the interest whenever an 
  7623. appropriate state change occurs. 
  7624.  
  7625. For example, when you set up an MMesaView instance (see MMesaView::setUp()), it 
  7626. instantiates a special MInterest subclass (a "display interest") that refers to 
  7627. itself, and registers that interest with its associated model. Whenever a 
  7628. format change occurs in the model, the model issues a formatsChanged() message 
  7629. to all the registered MInterest instances, including the MMesaView's display 
  7630. interest. If you want to notify your own objects of changes in a model, you can 
  7631. subclass MInterest and implement the notification functions appropriately. 
  7632.  
  7633. Whenever a model notifies an interest of a state change, it includes an MChange 
  7634. parameter. MChange is a Mesa-internal class that represents a list of cells 
  7635. that have been affected by the state change. For more information, see 
  7636. "MChange". 
  7637.  
  7638.  
  7639. ΓòÉΓòÉΓòÉ 2.11.1. Creating and destroying an MInterest instance ΓòÉΓòÉΓòÉ
  7640.  
  7641. Open the Contents view and expand this section to see a list of methods. 
  7642.  
  7643.  
  7644. ΓòÉΓòÉΓòÉ 2.11.1.1. MInterest::MInterest() ΓòÉΓòÉΓòÉ
  7645.  
  7646. MInterest() 
  7647.  
  7648. Initializes the MInterest. 
  7649.  
  7650. void 
  7651.  
  7652.  
  7653. ΓòÉΓòÉΓòÉ 2.11.1.2. MInterest::~MInterest() ΓòÉΓòÉΓòÉ
  7654.  
  7655. ~MInterest() [virtual] 
  7656.  
  7657. Destroys the MInterest instance and releases any allocated resources. 
  7658.  
  7659. void 
  7660.  
  7661.  
  7662. ΓòÉΓòÉΓòÉ 2.11.2. Notifying the interested object of a state change ΓòÉΓòÉΓòÉ
  7663.  
  7664. Open the Contents view and expand this section to see a list of methods. 
  7665.  
  7666.  
  7667. ΓòÉΓòÉΓòÉ 2.11.2.1. MInterest::changedSize()=0 ΓòÉΓòÉΓòÉ
  7668.  
  7669. changedSize(MChange *) = 0 [virtual] 
  7670.  
  7671.       MChange *   List of affected cells 
  7672.  
  7673.  Within MInterest, does nothing. Subclasses of MInterest should notify the 
  7674.  interested object appropriately. This method is called when cells in the model 
  7675.  have been resized. 
  7676.  
  7677.  void 
  7678.  
  7679.  
  7680. ΓòÉΓòÉΓòÉ 2.11.2.2. MInterest::contentsChanged()=0 ΓòÉΓòÉΓòÉ
  7681.  
  7682. contentsChanged(MChange *) = 0 [virtual] 
  7683.  
  7684.       MChange *   List of affected cells 
  7685.  
  7686.  Within MInterest, does nothing. Subclasses of MInterest should notify the 
  7687.  interested object appropriately. This method is called when the contents of 
  7688.  one or more cells in the model have been changed. 
  7689.  
  7690.  void 
  7691.  
  7692.  
  7693. ΓòÉΓòÉΓòÉ 2.11.2.3. MInterest::formatsChanged()=0 ΓòÉΓòÉΓòÉ
  7694.  
  7695. formatsChanged(MChange *) = 0 [virtual] 
  7696.  
  7697.       MChange *   List of affected cells 
  7698.  
  7699.  Within MInterest, does nothing. Subclasses of MInterest should notify the 
  7700.  interested object appropriately. This method is called when the formats of one 
  7701.  or more cells in the model have been changed. 
  7702.  
  7703.  void 
  7704.  
  7705.  
  7706. ΓòÉΓòÉΓòÉ 2.11.2.4. MInterest::redisplay()=0 ΓòÉΓòÉΓòÉ
  7707.  
  7708. redisplay(MChange *) = 0 [virtual] 
  7709.  
  7710.       MChange *   List of affected cells 
  7711.  
  7712.  Within MInterest, does nothing. Subclasses of MInterest should notify the 
  7713.  interested object appropriately. This method is called when the model is 
  7714.  redisplayed (see MMesaModel::redisplay()). 
  7715.  
  7716.  void 
  7717.  
  7718.  
  7719. ΓòÉΓòÉΓòÉ 2.11.2.5. MInterest::resetView()=0 ΓòÉΓòÉΓòÉ
  7720.  
  7721. resetView(MChange *) = 0 [virtual] 
  7722.  
  7723.       MChange *   List of affected cells 
  7724.  
  7725.  Within MInterest, does nothing. Subclasses of MInterest should notify the 
  7726.  interested object appropriately. This method is called when a script has been 
  7727.  deleted. 
  7728.  
  7729.  void 
  7730.  
  7731.  
  7732. ΓòÉΓòÉΓòÉ 2.12. MMesaModel ΓòÉΓòÉΓòÉ
  7733.  
  7734. mesamodel.h is the source file for this class. 
  7735.  
  7736. This class inherits from MObject 
  7737.  
  7738. Represents an open Mesa 2 file, often called a workbook or a model. In general, 
  7739. all information and processes specific to a single Mesa 2 file can be accessed 
  7740. and initiated by the MMesaModel instance that represents that file. 
  7741.  
  7742. Within this document, MMesaModel is often discussed as if it contained 
  7743. information about a model; in reality, most of the information is maintained in 
  7744. an instance of MModel, which is a Mesa-internal class not directly available 
  7745. through Mesa DOK. MMesaModel simply keeps track of an MModel instance, and most 
  7746. MMesaModel methods are simple pass-through functions. 
  7747.  
  7748. MMesaModel is a SOM-based class, where MModel is not (for performance reasons). 
  7749. By using MMesaModel in your SOM-based custom applications, you allow the 
  7750. application to interact with future updated versions of the Mesa DOK DLL's 
  7751. without having to be recompiled. 
  7752.  
  7753.  
  7754. ΓòÉΓòÉΓòÉ 2.12.1. MMesaModel contents ΓòÉΓòÉΓòÉ
  7755.  
  7756. Open the Contents view and expand this section to see a list of methods. 
  7757.  
  7758. Each MMesaModel instance keeps track of the following information: 
  7759.  
  7760.      a cell list, containing address, contents, value type, format, and 
  7761.       (optional) cached value for every non-empty cell in the model; 
  7762.  
  7763.      a layer list, containing name, row and column count and size information, 
  7764.       default formatting information, and protection status for each layer in 
  7765.       the model; 
  7766.  
  7767.      a label list, containing a name, range, and "autogrow" setting for all 
  7768.       labelled ranges in the model (if any); 
  7769.  
  7770.      a script list, including name, program, and execution settings for all 
  7771.       REXX scripts in the model (if any); 
  7772.  
  7773.      a frame list (see MFrameXfer), including position, type and settings for 
  7774.       all graphs, shapes, and other graphic objects (if any); 
  7775.  
  7776.      a window list, including positions and magnification settings for all 
  7777.       windows that display the model; 
  7778.  
  7779.      recalculation information: 
  7780.  
  7781.       Does the model recalculate automatically when a cell is edited? 
  7782.  
  7783.       In what order should cells be recalculated, and how often? 
  7784.  
  7785.       Has the model been changed since the last recalculation? 
  7786.  
  7787.       Which cells depend on which other cells for their values? 
  7788.  
  7789.       Do any cells in the model depend on the controller's real-time feed table 
  7790.       for their values? 
  7791.  
  7792.      a print-job header which determines the appearance of printed pages from 
  7793.       this model; 
  7794.  
  7795.      a DDE link table containing references to tagged items in other models or 
  7796.       other DDE-enabled applications; 
  7797.  
  7798.      a BLOB list, containing Binary Large OBject entries for the model; 
  7799.  
  7800.      a format list, with an entry for every unique format in the model (see 
  7801.       MFormat); 
  7802.  
  7803.      a font list, with an entry for every unique font in the model (see 
  7804.       MFont); 
  7805.  
  7806.      a currency character array which is used in numeric and currency display 
  7807.       formats; 
  7808.  
  7809.      an undo list and a redo list, used for keeping track of executed 
  7810.       commands, associated model changes, and associated selections so that the 
  7811.       model can be restored to an earlier state; 
  7812.  
  7813.      file information for the model, including file name, path name (if any), 
  7814.       and optional password. 
  7815.  
  7816.  
  7817. ΓòÉΓòÉΓòÉ 2.12.2. Creating, destroying, and setting up an MMesaModel instance ΓòÉΓòÉΓòÉ
  7818.  
  7819. Open the Contents view and expand this section to see a list of methods. 
  7820.  
  7821.  
  7822. ΓòÉΓòÉΓòÉ 2.12.2.1. MMesaModel::MMesaModel() ΓòÉΓòÉΓòÉ
  7823.  
  7824. MMesaModel() 
  7825.  
  7826. Instantiates the MMesaModel instance. 
  7827.  
  7828. void 
  7829.  
  7830.  
  7831. ΓòÉΓòÉΓòÉ 2.12.2.2. MMesaModel::~MMesaModel() ΓòÉΓòÉΓòÉ
  7832.  
  7833. ~MMesaModel() [virtual] 
  7834.  
  7835. Releases the MMesaModel instance. 
  7836.  
  7837. void 
  7838.  
  7839.  
  7840. ΓòÉΓòÉΓòÉ 2.12.2.3. MMesaModel::cleanUp() ΓòÉΓòÉΓòÉ
  7841.  
  7842. cleanUp(MGController *) [virtual] 
  7843.  
  7844.       MGController *gc   The controller (see MGController) 
  7845.  
  7846.  Deletes all items in the DDE item list for the model, freezes the event queue 
  7847.  and unsets the controller's running flag (see MGController). 
  7848.  
  7849.  void 
  7850.  
  7851.  
  7852. ΓòÉΓòÉΓòÉ 2.12.2.4. MMesaModel::setUp() ΓòÉΓòÉΓòÉ
  7853.  
  7854. setUp(MGController *) [virtual] 
  7855.  
  7856.       MGController *   Controller to associate with the model 
  7857.  
  7858.  Registers the current model with the application controller (see 
  7859.  MGController). 
  7860.  
  7861.  void 
  7862.  
  7863.  
  7864. ΓòÉΓòÉΓòÉ 2.12.3. Cell and range addresses ΓòÉΓòÉΓòÉ
  7865.  
  7866. Open the Contents view and expand this section to see a list of methods. 
  7867.  
  7868.  
  7869. ΓòÉΓòÉΓòÉ 2.12.3.1. MMesaModel::addressFromPoint() ΓòÉΓòÉΓòÉ
  7870.  
  7871. addressFromPoint(const MAddress *, const MPoint *, int) 
  7872.  
  7873.       const MAddress *   MAddress of the upper-left corner of the display 
  7874.  
  7875.       const MPoint *   Point to look up 
  7876.  
  7877.       int   Clip the address to within the window, or not? 1 to clip, 0 for no. 
  7878.       Default is 1 
  7879.  
  7880.  Returns the absolute address of the cell containing the given point (see 
  7881.  MAddress). 
  7882.  
  7883.  MAddress 
  7884.  
  7885.  
  7886. ΓòÉΓòÉΓòÉ 2.12.3.2. MMesaModel::adToStr() ΓòÉΓòÉΓòÉ
  7887.  
  7888. adToStr(const MAddress *, char *, int) 
  7889.  
  7890.       const MAddress *   Address to get the string-representation of 
  7891.  
  7892.       char *   Storage location 
  7893.  
  7894.       int    Always include layer reference ? -1 for yes (default) 
  7895.  
  7896.  Creates a character-string representation of the address (see 
  7897.  MAddress::toStr()). Stores the result in the character buffer provided. 
  7898.  
  7899.  void 
  7900.  
  7901.  
  7902. ΓòÉΓòÉΓòÉ 2.12.3.3. MMesaModel::doesCellExist() ΓòÉΓòÉΓòÉ
  7903.  
  7904. doesCellExist(const MAddress *) [virtual] 
  7905.  
  7906.       const MAddress *   Address of cell 
  7907.  
  7908.  Determines whether the cell at the given address has been created or not. 
  7909.  
  7910.  The model's cell array is a sparse matrix, containing only those cells which 
  7911.  have contents or formatting or some other actual information in them. For 
  7912.  example, a 300-row by 400-column layer has 120,000 potential cells; however, 
  7913.  if only one cell has been edited since the layer was created, then only one of 
  7914.  those cells will actually exist. 
  7915.  
  7916.  Returns 1 if the cell exists, 0 otherwise. 
  7917.  
  7918.  int 
  7919.  
  7920.  
  7921. ΓòÉΓòÉΓòÉ 2.12.3.4. MMesaModel::find() ΓòÉΓòÉΓòÉ
  7922.  
  7923. find(const char *, int, int, const MRange *, const MAddress *) [virtual] 
  7924.  
  7925.       const char *   String to search for 
  7926.  
  7927.       int   Flags controlling the search (see "Search constants") 
  7928.  
  7929.       int   Search order (1 for horizontal-first, 0 for vertical-first) 
  7930.  
  7931.       const MRange *   Range in which to search 
  7932.  
  7933.       const MAddress *   Starting address 
  7934.  
  7935.  Searches within the given range for the first cell after the starting address 
  7936.  containing the given string. Returns the address of that cell, or a null 
  7937.  address if none is found. 
  7938.  
  7939.  Note that by setting the starting address to the return value of find(), you 
  7940.  can use this method to cycle through an entire range and find all occurrances 
  7941.  of the string. 
  7942.  
  7943.  MAddress 
  7944.  
  7945.  
  7946. ΓòÉΓòÉΓòÉ 2.12.3.5. MMesaModel::findLowerRightCell() ΓòÉΓòÉΓòÉ
  7947.  
  7948. findLowerRightCell(MAddress *) [virtual] 
  7949.  
  7950.       MAddress *   Storage location 
  7951.  
  7952.  Finds and stores the address of the lower-right most cell in the layer, 
  7953.  ignoring blank cells and hidden rows/columns. 
  7954.  
  7955.  void 
  7956.  
  7957.  
  7958. ΓòÉΓòÉΓòÉ 2.12.3.6. MMesaModel::findNextCellInCol() ΓòÉΓòÉΓòÉ
  7959.  
  7960. findNextCellInCol(int type, const MAddress *, MAddress *) [virtual] 
  7961.  
  7962.       int type   Type of search (1 for blank, 0 for non-blank) 
  7963.  
  7964.       const MAddress *   Address of current cell 
  7965.  
  7966.       MAddress *   Storage location 
  7967.  
  7968.  This method checks each cell under the current cell in the same column. 
  7969.  
  7970.  If type is 0, then: 
  7971.  
  7972.  if the cell immediately underneath is non-blank, the method stores the address 
  7973.  of the last non-blank cell it encounters before a blank cell; 
  7974.  
  7975.  if the cell immediately underneath is blank, the method stores the address of 
  7976.  the first non-blank cell it encounters. 
  7977.  
  7978.  If type is 1, the method stores the address of the first non-blank cell it 
  7979.  encounters. 
  7980.  
  7981.  In all cases, hidden rows are ignored, and the cell in the last row of the 
  7982.  layer is stored (whether or not it is blank) if the search fails. 
  7983.  
  7984.  For example, if the current layer has 4 columns and 5 rows, with the following 
  7985.  contents: 
  7986.  
  7987.         A   B   C    D 
  7988.  
  7989.             R1:   100   Piano   Australia   Red
  7990.  
  7991.       R2:   200   Guitar      Blue 
  7992.  
  7993.       R3:   300      Jamaica 
  7994.  
  7995.       R4:         Germany 
  7996.  
  7997.       R5:   400   Tuba   Korea 
  7998.  
  7999.  ...and the type parameter is set to 1 if the current cell is blank and 0 if 
  8000.  the current cell is not blank, then findNextCellInCol(type, currentCell, tmp) 
  8001.  will store the following addresses in tmp for the given currentCell addresses: 
  8002.  
  8003.         currentCell   tmp 
  8004.  
  8005.          C1   C3 
  8006.  
  8007.          C2   C3 
  8008.  
  8009.          D1   D2 
  8010.  
  8011.          D2   D5 
  8012.  
  8013.          A2   A4 
  8014.  
  8015.  This method is used when processing the End,Down Arrow key combination. 
  8016.  
  8017.  void 
  8018.  
  8019.  
  8020. ΓòÉΓòÉΓòÉ 2.12.3.7. MMesaModel::findNextCellInRow() ΓòÉΓòÉΓòÉ
  8021.  
  8022. findNextCellInRow(int, const MAddress *, MAddress *) [virtual] 
  8023.  
  8024.       int   Type of search (1 for blank, 0 for non-blank) 
  8025.  
  8026.       const MAddress *   Address of current cell 
  8027.  
  8028.       MAddress *   Storage location 
  8029.  
  8030.  This method checks each cell to the right of the current cell in the same row. 
  8031.  
  8032.  If type is 0, then: 
  8033.  
  8034.  if the cell immediately to the right is non-blank, the method stores the 
  8035.  address of the last non-blank cell it encounters before a blank cell; 
  8036.  
  8037.  if the cell immediately to the right is blank, the method stores the address 
  8038.  of the first non-blank cell it encounters. 
  8039.  
  8040.  If type is 1, the method stores the address of the first non-blank cell it 
  8041.  encounters. 
  8042.  
  8043.  In all cases, hidden columns are ignored, and the cell in the last column in 
  8044.  the layer is stored (whether or not it is blank) if the search fails. 
  8045.  
  8046.  For example, if the current layer has 4 columns and 5 rows, with the following 
  8047.  contents: 
  8048.  
  8049.         A   B   C    D 
  8050.  
  8051.             R1:   100   Piano   Australia   Red
  8052.  
  8053.       R2:   200   Guitar      Blue 
  8054.  
  8055.       R3:   300      Jamaica 
  8056.  
  8057.       R4:         Germany 
  8058.  
  8059.       R5:   400   Tuba   Korea 
  8060.  
  8061.  ...and the type parameter is set to 1 if the current cell is blank and 0 if 
  8062.  the current cell is not blank, then findNextCellInRow(type, currentCell, tmp) 
  8063.  will store the following addresses in tmp for the given currentCell addresses: 
  8064.  
  8065.         currentCell   tmp 
  8066.  
  8067.          A1   D1 
  8068.  
  8069.          A2   B2 
  8070.  
  8071.          B2   D2 
  8072.  
  8073.          A3   C3 
  8074.  
  8075.          C3   D3 
  8076.  
  8077.  This method is used when processing the End,Right Arrow key combination. 
  8078.  
  8079.  void 
  8080.  
  8081.  
  8082. ΓòÉΓòÉΓòÉ 2.12.3.8. MMesaModel::findPriorCellInCol() ΓòÉΓòÉΓòÉ
  8083.  
  8084. findPriorCellInCol(int, const MAddress *, MAddress *) [virtual] 
  8085.  
  8086.       int   Type of search (1 for blank, 0 for non-blank) 
  8087.  
  8088.       const MAddress *   Address of current cell 
  8089.  
  8090.       MAddress *   Storage location 
  8091.  
  8092.  This method checks each cell above the current cell in the same column. 
  8093.  
  8094.  If type is 0, then: 
  8095.  
  8096.  if the cell immediately above is non-blank, the method stores the address of 
  8097.  the last non-blank cell it encounters before a blank cell; 
  8098.  
  8099.  if the cell immediately above is blank, the method stores the address of the 
  8100.  first non-blank cell it encounters. 
  8101.  
  8102.  If type is 1, the method stores the address of the first non-blank cell it 
  8103.  encounters. 
  8104.  
  8105.  In all cases, hidden rows are ignored, and the cell in the first row is stored 
  8106.  (whether or not it is blank) if the search fails. 
  8107.  
  8108.  For example, if the current layer has 4 columns and 5 rows, with the following 
  8109.  contents: 
  8110.  
  8111.         A   B   C    D 
  8112.  
  8113.             R1:   100   Piano   Australia   Red
  8114.  
  8115.       R2:   200   Guitar      Blue 
  8116.  
  8117.       R3:   300      Jamaica 
  8118.  
  8119.       R4:         Germany 
  8120.  
  8121.       R5:   400   Tuba   Korea 
  8122.  
  8123.  ...and the type parameter is set to 1 if the current cell is blank and 0 if 
  8124.  the current cell is not blank, then findPriorCellInCol(type, currentCell, tmp) 
  8125.  will store the following addresses in tmp for the given currentCell addresses: 
  8126.  
  8127.         currentCell   tmp 
  8128.  
  8129.          D5   D2 
  8130.  
  8131.          C5   C3 
  8132.  
  8133.          B5   B2 
  8134.  
  8135.          A5   A3 
  8136.  
  8137.  This method is used when processing the End,Up Arrow key combination. 
  8138.  
  8139.  void 
  8140.  
  8141.  
  8142. ΓòÉΓòÉΓòÉ 2.12.3.9. MMesaModel::findPriorCellInRow() ΓòÉΓòÉΓòÉ
  8143.  
  8144. findPriorCellInRow(int, const MAddress *, MAddress *) [virtual] 
  8145.  
  8146.       int   Type of search (1 for blank, 0 for non-blank) 
  8147.  
  8148.       const MAddress *   Address of current cell 
  8149.  
  8150.       MAddress *   Storage location 
  8151.  
  8152.  This method checks each cell to the left of the current cell in the same row. 
  8153.  
  8154.  If type is 0, then: 
  8155.  
  8156.  if the cell immediately to the left is non-blank, the method stores the 
  8157.  address of the last non-blank cell it encounters before a blank cell; 
  8158.  
  8159.  if the cell immediately to the left is blank, the method stores the address of 
  8160.  the first non-blank cell it encounters. 
  8161.  
  8162.  If type is 1, the method stores the address of the first non-blank cell it 
  8163.  encounters. 
  8164.  
  8165.  In all cases, hidden columns are ignored, and the cell in the first column is 
  8166.  stored (whether or not it is blank) if the search fails. 
  8167.  
  8168.  For example, if the current layer has 4 columns and 5 rows, with the following 
  8169.  contents: 
  8170.  
  8171.         A   B   C    D 
  8172.  
  8173.             R1:   100   Piano   Australia   Red
  8174.  
  8175.       R2:   200   Guitar      Blue 
  8176.  
  8177.       R3:   300      Jamaica 
  8178.  
  8179.       R4:         Germany 
  8180.  
  8181.       R5:   400   Tuba   Korea 
  8182.  
  8183.  ...and the type parameter is set to 1 if the current cell is blank and 0 if 
  8184.  the current cell is not blank, then findPriorCellInRow(type, currentCell, tmp) 
  8185.  will store the following addresses in tmp for the given currentCell addresses: 
  8186.  
  8187.         currentCell   tmp 
  8188.  
  8189.          D4   C4 
  8190.  
  8191.          C4   A4 
  8192.  
  8193.          D1   A1 
  8194.  
  8195.          D2   B2 
  8196.  
  8197.          B2   A2 
  8198.  
  8199.  This method is used when processing the End,Left Arrow key combination. 
  8200.  
  8201.  void 
  8202.  
  8203.  
  8204. ΓòÉΓòÉΓòÉ 2.12.3.10. MMesaModel::isAddress() ΓòÉΓòÉΓòÉ
  8205.  
  8206. isAddress(const char *, const MAddress *, MAddress *, int &) [virtual] 
  8207.  
  8208.       const char *   String to parse 
  8209.  
  8210.       const MAddress *   Base address to merge with address in string 
  8211.  
  8212.       MAddress *   Storage location for address 
  8213.  
  8214.       int &   Storage location for string length 
  8215.  
  8216.  Determines whether or not the given string represents a valid cell address. If 
  8217.  so, stores the absolute address it represents (if the address is relative, it 
  8218.  is merged with the base cell to obtain an absolute address) and the string 
  8219.  length. 
  8220.  
  8221.  Returns 1 if the string represents an address, 0 otherwise. 
  8222.  
  8223.  int 
  8224.  
  8225.  
  8226. ΓòÉΓòÉΓòÉ 2.12.3.11. MMesaModel::isMultiRange() ΓòÉΓòÉΓòÉ
  8227.  
  8228. isMultiRange(const char *, const MAddress *, MRange *, int &len) [virtual] 
  8229.  
  8230.       const char *   String to parse 
  8231.  
  8232.       const MAddress *   Base address 
  8233.  
  8234.       MRange *   Storage location for address 
  8235.  
  8236.       int &   Storage location for string length 
  8237.  
  8238.  Determines whether or not the given string represents the address of a valid 
  8239.  discontinuous range (e.g.; [A]A1:B30,[B]A1:C15,[Summary]C20:C22 ). If so, 
  8240.  stores the absolute range it represents (if the address is relative, it is 
  8241.  merged with the base cell to obtain an absolute address) and the string 
  8242.  length. 
  8243.  
  8244.  Returns 1 if the string refers to a discontinuous range; 0 otherwise. 
  8245.  
  8246.  int 
  8247.  
  8248.  
  8249. ΓòÉΓòÉΓòÉ 2.12.3.12. MMesaModel::rangeToStr() ΓòÉΓòÉΓòÉ
  8250.  
  8251. rangeToStr(const MRange *, const MAddress *, char *&, int &) [virtual] 
  8252.  
  8253.       const MRange *   Range to be converted 
  8254.  
  8255.       const MAddress *   Base address 
  8256.  
  8257.       char *&   Storage location for string 
  8258.  
  8259.       int &   Storage location for string length 
  8260.  
  8261.  Stores the string equivalent of the given range, offset from the given cell if 
  8262.  relative, and the length of that string. (Compare with MMesaModel::adToStr().) 
  8263.  
  8264.  void 
  8265.  
  8266.  
  8267. ΓòÉΓòÉΓòÉ 2.12.4. Removing cells ΓòÉΓòÉΓòÉ
  8268.  
  8269. Open the Contents view and expand this section to see a list of methods. 
  8270.  
  8271.  
  8272. ΓòÉΓòÉΓòÉ 2.12.4.1. MMesaModel::clear() ΓòÉΓòÉΓòÉ
  8273.  
  8274. clear(const MSelection *, const MSelection *, int, MException *) 
  8275.  
  8276.       const MSelection *   Selection to clear 
  8277.  
  8278.       const MSelection *   Current selection (to be journaled for undo/redo 
  8279.       purposes) 
  8280.  
  8281.       int   Action to perform (see "Action ID constants") 
  8282.  
  8283.       MException *   Storage location for errors 
  8284.  
  8285.  If the given selection includes a frame, then the frame is removed from the 
  8286.  model's frame list. Otherwise, every cell in the selected range is removed 
  8287.  from the model's cell list. 
  8288.  
  8289.  void 
  8290.  
  8291.  
  8292. ΓòÉΓòÉΓòÉ 2.12.4.2. MMesaModel::clearRange() ΓòÉΓòÉΓòÉ
  8293.  
  8294. clearRange(const MRange *, const MSelection *, int, MException *) 
  8295.  
  8296.       const MRange *   Range to clear 
  8297.  
  8298.       const MSelection *   Current selection (to be journaled for undo/redo 
  8299.       purposes) 
  8300.  
  8301.       int   Action to perform (see "Action ID constants") 
  8302.  
  8303.       MException *   Storage location for errors 
  8304.  
  8305.  Removes every cell in the given range from the model's cell list. 
  8306.  
  8307.  void 
  8308.  
  8309.      MMesaModel::cut() 
  8310.  
  8311.      MMesaModel::clearSpecialRange() 
  8312.  
  8313.  
  8314. ΓòÉΓòÉΓòÉ 2.12.5. Retrieving the contents or value of cells ΓòÉΓòÉΓòÉ
  8315.  
  8316. Open the Contents view and expand this section to see a list of methods. 
  8317.  
  8318.  
  8319. ΓòÉΓòÉΓòÉ 2.12.5.1. MMesaModel::getCellString() ΓòÉΓòÉΓòÉ
  8320.  
  8321. getCellString(const MAddress *) [virtual] 
  8322.  
  8323.       const MAddress *   Address of cell to return input string for 
  8324.  
  8325.  Returns the input string of the given cell - that is, a string which a user 
  8326.  could enter into that cell in order to duplicate its contents. 
  8327.  
  8328.  char * 
  8329.  
  8330.  
  8331. ΓòÉΓòÉΓòÉ 2.12.5.2. MMesaModel::getCellValue() ΓòÉΓòÉΓòÉ
  8332.  
  8333. getCellValue(const MAddress *) [virtual] 
  8334.  
  8335.       const MAddress *   Address to get value of 
  8336.  
  8337.  Returns the value of the given cell. 
  8338.  
  8339.  char * 
  8340.  
  8341.  
  8342. ΓòÉΓòÉΓòÉ 2.12.5.3. MMesaModel::getCellValueToAddInValue() ΓòÉΓòÉΓòÉ
  8343.  
  8344. getCellValueToAddInValue(void *) [virtual] 
  8345.  
  8346.       void *   Pointer to AddIn value 
  8347.  
  8348.  Reads address information (if any) from the given AddIn parameter, then stores 
  8349.  the contents and value type (see "Cell type constants") of the cell at that 
  8350.  address (or of default cell, if no address is given) in the AddIn parameter. 
  8351.  
  8352.  void 
  8353.  
  8354.  
  8355. ΓòÉΓòÉΓòÉ 2.12.5.4. MMesaModel::isCellNonBlank() ΓòÉΓòÉΓòÉ
  8356.  
  8357. isCellNonBlank(const MAddress *) [virtual] 
  8358.  
  8359.       const MAddress *   Which cell? 
  8360.  
  8361.  Returns 0 if given cell is empty, 1 otherwise. 
  8362.  
  8363.  int 
  8364.  
  8365.  
  8366. ΓòÉΓòÉΓòÉ 2.12.6. Changing the contents or value of cells ΓòÉΓòÉΓòÉ
  8367.  
  8368. Open the Contents view and expand this section to see a list of methods. 
  8369.  
  8370.  
  8371. ΓòÉΓòÉΓòÉ 2.12.6.1. MMesaModel::clearSpecialRange() ΓòÉΓòÉΓòÉ
  8372.  
  8373. clearSpecialRange(const MRange *, int, const MSelection *, int, MException *) 
  8374.  
  8375.       const MRange *   Range to clear 
  8376.  
  8377.       int    Clearing type. 
  8378.  
  8379.       const MSelection *   Current selection (to be journaled for undo/redo 
  8380.       purposes) 
  8381.  
  8382.       int   Action to perform (see "Action ID constants") 
  8383.  
  8384.       MException *   Storage location for errors 
  8385.  
  8386.  Removes some, but not necessarily all, of the contents of the cells in the 
  8387.  given range. What subset is removed depends on the given clearing type (see 
  8388.  "Clear special constants"). 
  8389.  
  8390.  void 
  8391.  
  8392.  
  8393. ΓòÉΓòÉΓòÉ 2.12.6.2. MMesaModel::convertRange() ΓòÉΓòÉΓòÉ
  8394.  
  8395. convertRange(const MRange *, int func, const MSelection *, int, MException *) 
  8396.  
  8397.       const MRange *   Range to convert 
  8398.  
  8399.       int func   What kind of conversion? 
  8400.  
  8401.       const MSelection *   Current selection (to be journaled for undo/redo 
  8402.       purposes) 
  8403.  
  8404.       int    Action to perform (see "Action ID constants") 
  8405.  
  8406.       MException *   Storage location for errors 
  8407.  
  8408.  Converts the cells in the given range from one form to another, depending on 
  8409.  type of conversion (see "Conversion constants"). 
  8410.  
  8411.  void 
  8412.  
  8413.  
  8414. ΓòÉΓòÉΓòÉ 2.12.6.3. MMesaModel::setCellToAddInValue() ΓòÉΓòÉΓòÉ
  8415.  
  8416. setCellToAddInValue(void *, int) [virtual] 
  8417.  
  8418.       void *   Pointer to AddIn value 
  8419.  
  8420.       int action   Action to perform (see "Action ID constants") 
  8421.  
  8422.  Reads a cell address, contents, and value type (see "Cell type constants") 
  8423.  from the given AddIn parameter, then sets the cell at that address to the 
  8424.  given values. 
  8425.  
  8426.  int 
  8427.  
  8428.  
  8429. ΓòÉΓòÉΓòÉ 2.12.6.4. MMesaModel::setCellToString() ΓòÉΓòÉΓòÉ
  8430.  
  8431. setCellToString(const MAddress *, const char *, int, MException *, const 
  8432. MSelection *) 
  8433.  
  8434.       const MAddress *   Address of cell to set 
  8435.  
  8436.       const char *   RPN string to set the cell to 
  8437.  
  8438.       int   Action to perform (see "Action ID constants") 
  8439.  
  8440.       MException *   Storage location for errors 
  8441.  
  8442.       const MSelection *   Current selection (to be journaled for undo/redo 
  8443.       purposes) 
  8444.  
  8445.  Sets the given cell's contents to the given string. 
  8446.  
  8447.  void 
  8448.  
  8449.  
  8450. ΓòÉΓòÉΓòÉ 2.12.7. Retrieving the position of cells ΓòÉΓòÉΓòÉ
  8451.  
  8452. Open the Contents view and expand this section to see a list of methods. 
  8453.  
  8454.  
  8455. ΓòÉΓòÉΓòÉ 2.12.7.1. MMesaModel::getRectForAd() ΓòÉΓòÉΓòÉ
  8456.  
  8457. getRectForAd(const MAddress *, const MAddress *, MRect *) 
  8458.  
  8459.       const MAddress *   Upper-left corner of the display 
  8460.  
  8461.       const MAddress *   Address to get rectangle for 
  8462.  
  8463.       MRect *   Storage location 
  8464.  
  8465.  Stores the bounding rectangle for the given cell. 
  8466.  
  8467.  void 
  8468.  
  8469.  
  8470. ΓòÉΓòÉΓòÉ 2.12.7.2. MMesaModel::getRectForRange() ΓòÉΓòÉΓòÉ
  8471.  
  8472. getRectForRange(const MAddress *, const MAddress *, const MAddress *, MRect *) 
  8473. [virtual] 
  8474.  
  8475.       const MAddress *   Upper-left corner of the display 
  8476.  
  8477.       const MAddress *   Upper-left corner of the range 
  8478.  
  8479.       const MAddress *   Lower-right corner of the range 
  8480.  
  8481.       MRect *   Storage location 
  8482.  
  8483.  Stores the bounding rectangle for the given range. 
  8484.  
  8485.  void 
  8486.  
  8487.  getRectForRange(const MAddress *, const MRange *, MRect *) [virtual] 
  8488.  
  8489.       const MAddress *   Upper-left corner of the display 
  8490.  
  8491.       const MRange *   Range 
  8492.  
  8493.       MRect *   Storage for the bounding rectangle 
  8494.  
  8495.  Stores the bounding rectangle for the given range. 
  8496.  
  8497.  void 
  8498.  
  8499.  
  8500. ΓòÉΓòÉΓòÉ 2.12.8. Filling ranges of cells ΓòÉΓòÉΓòÉ
  8501.  
  8502. Open the Contents view and expand this section to see a list of methods. 
  8503.  
  8504.  
  8505. ΓòÉΓòÉΓòÉ 2.12.8.1. MMesaModel::autoRange() ΓòÉΓòÉΓòÉ
  8506.  
  8507. autoRange(const MRange *, int, const MSelection *, int, MException *) 
  8508.  
  8509.       const MRange *   Selected range 
  8510.  
  8511.       int   Which function? (see "SmartMath function constants") 
  8512.  
  8513.       const MSelection *   Current selection (to be journaled for undo/redo 
  8514.       purposes) 
  8515.  
  8516.       int   Action to perform (see "Action ID constants") 
  8517.  
  8518.       MException *   Storage location for errors 
  8519.  
  8520.  Based on the current selection, determines the range to use as an argument to 
  8521.  the given function, then inserts a formula using the given function and the 
  8522.  calculated argument into every selected cell. 
  8523.  
  8524.  If a single cell is selected and there is a numeric value in the cell 
  8525.  immediately above it, the range is all the cells above the current cell in the 
  8526.  same column that contain a continuous series of values. 
  8527.  
  8528.  If there is no numeric value above the selected cell, but there is a numeric 
  8529.  value to the left of the selected cell, the range is all the cells to the left 
  8530.  of the current cell in the same row that contain a continuous series of 
  8531.  values. 
  8532.  
  8533.  If all the selected cells are empty and in the same row, the range is all the 
  8534.  cells above the selected range (in the same column) that contain a continuous 
  8535.  series of values. If there are no values above a selected cell, the method 
  8536.  does nothing. 
  8537.  
  8538.  If all the selected cells are empty and in the same column, the range is all 
  8539.  the cells to the left of the selected range (in the same row) that contain a 
  8540.  continuous series of values. If there are no values to the left of a selected 
  8541.  cell, the method does nothing. 
  8542.  
  8543.  If a rectangular range is selected, the range is the last row or last column 
  8544.  if either is empty, or both if both are empty. If neither is empty, the range 
  8545.  is the last row. 
  8546.  
  8547.  void 
  8548.  
  8549.  
  8550. ΓòÉΓòÉΓòÉ 2.12.8.2. MMesaModel::copyCells() ΓòÉΓòÉΓòÉ
  8551.  
  8552. copyCells(const MRange *, const MAddress *, int, MException *, const MSelection 
  8553. *) [virtual] 
  8554.  
  8555.       const MRange *   Range of cells to copy from 
  8556.  
  8557.       const MAddress *   Offset 
  8558.  
  8559.       int   Action to perform (see "Action ID constants") 
  8560.  
  8561.       MException *   Storage location for errors 
  8562.  
  8563.       const MSelection *   Current selection (to be journaled for undo/redo 
  8564.       purposes) 
  8565.  
  8566.  Copies a range of cells from their current position to a position offset by 
  8567.  the given relative address (see also MMesaModel::copy() ). 
  8568.  
  8569.  void 
  8570.  
  8571.  
  8572. ΓòÉΓòÉΓòÉ 2.12.8.3. MMesaModel::fillDown() ΓòÉΓòÉΓòÉ
  8573.  
  8574. fillDown(const MRange *, int, const MSelection *, MException *) [virtual] 
  8575.  
  8576.       const MRange *   Range to fill 
  8577.  
  8578.       int   Action to perform (see "Action ID constants") 
  8579.  
  8580.       const MSelection *   Current selection (to be journaled for undo/redo 
  8581.       purposes) 
  8582.  
  8583.       MException *   Storage location for errors 
  8584.  
  8585.  Copies the contents of each cell in the first row of the given range into 
  8586.  every cell in the same column, in the given range. If the range is large 
  8587.  enough, triggers MGController::percentComplete()=0. 
  8588.  
  8589.  void 
  8590.  
  8591.  
  8592. ΓòÉΓòÉΓòÉ 2.12.8.4. MMesaModel::fillRight() ΓòÉΓòÉΓòÉ
  8593.  
  8594. fillRight(const MRange *, int, const MSelection *, MException *) [virtual] 
  8595.  
  8596.       const MRange *   Range to fill 
  8597.  
  8598.       int   Action to perform (see "Action ID constants") 
  8599.  
  8600.       const MSelection *   Current selection (to be journaled for undo/redo 
  8601.       purposes) 
  8602.  
  8603.       MException *   Storage location for errors 
  8604.  
  8605.  Copies the contents of each cell in the first column of the given range into 
  8606.  every cell in the same row, in the given range. If the range is large enough, 
  8607.  triggers MGController::percentComplete()=0. 
  8608.  
  8609.  void 
  8610.  
  8611.  
  8612. ΓòÉΓòÉΓòÉ 2.12.8.5. MMesaModel::fillSmartDown() ΓòÉΓòÉΓòÉ
  8613.  
  8614. fillSmartDown(const MRange *, int, const MSelection *, MException *) [virtual] 
  8615.  
  8616.       const MRange *   Range to fill 
  8617.  
  8618.       int   Action to perform (see "Action ID constants") 
  8619.  
  8620.       const MSelection *   Current selection (to be journaled for undo/redo 
  8621.       purposes) 
  8622.  
  8623.       MException *   Storage location for errors 
  8624.  
  8625.  Enters a formula into each cell in the given range, except those in the first 
  8626.  row of that range. 
  8627.  
  8628.  The function used in each formula depends on the contents of the top cell - 
  8629.  that is, the cell in the first row of the given range and in the same column 
  8630.  as the cell being edited. If the top cell contains a formula, then the SAME() 
  8631.  function is used. If the top cell contains a number or a string, then the 
  8632.  NEXT() function is used. 
  8633.  
  8634.  Similarly, the argument used in each formula depends on the contents of the 
  8635.  top cell. If a formula, then each formula includes an absolute reference to 
  8636.  the top cell. If a string or number, then each formula includes a relative 
  8637.  reference to the cell immediately above it. 
  8638.  
  8639.  For example, if cells A1 through C3 have the following contents: 
  8640.  
  8641.         A   B   C 
  8642.  
  8643.       R1:   100   Text   =INT(RAND * 10) 
  8644.  
  8645.       R2:   200   More text   =INT(RAND * 100) 
  8646.  
  8647.       R3:   300   Still more text   =INT(RAND * 1000) 
  8648.  
  8649.  ...and range is an MRange instance representing the range A1:C3, then 
  8650.  fillSmartDown(range, action, sel, exc) will generate (overwriting the previous 
  8651.  contents of A2:C3) the following: 
  8652.  
  8653.         A   B   C 
  8654.  
  8655.       R1:   100   Text   =INT(RAND * 10) 
  8656.  
  8657.       R2:   =NEXT(A1)   =NEXT(B1)   =SAME(  cket.$A]$C$1) 
  8658.  
  8659.       R3:   =NEXT(A2)   =NEXT(B2)   =SAME(  cket.$A]$C$1) 
  8660.  
  8661.  If the range is large enough, triggers MGController::percentComplete()=0. 
  8662.  
  8663.  void 
  8664.  
  8665.  
  8666. ΓòÉΓòÉΓòÉ 2.12.8.6. MMesaModel::fillSmartRight() ΓòÉΓòÉΓòÉ
  8667.  
  8668. fillSmartRight(const MRange *, int, const MSelection *, MException *) [virtual] 
  8669.  
  8670.       const MRange *   Range to fill 
  8671.  
  8672.       int   Action to perform (see "Action ID constants") 
  8673.  
  8674.       const MSelection *   Current selection (to be journaled for undo/redo 
  8675.       purposes) 
  8676.  
  8677.       MException *   Storage location for errors 
  8678.  
  8679.  Enters a formula into each cell in the given range, except those in the first 
  8680.  column of that range. 
  8681.  
  8682.  The function used in each formula depends on the contents of the left cell - 
  8683.  that is, the cell in the first column of the given range and in the same row 
  8684.  as the cell being edited. If the left cell contains a formula, then the SAME() 
  8685.  function is used. If the left cell contains a number or a string, then the 
  8686.  NEXT() function is used. 
  8687.  
  8688.  Similarly, the argument used in each formula depends on the contents of the 
  8689.  left cell. If a formula, then each formula includes an absolute reference to 
  8690.  the left cell. If a string or number, then each formula includes a relative 
  8691.  reference to the cell immediately to its left. 
  8692.  
  8693.  For example, if cells A1 through C3 have the following contents: 
  8694.  
  8695.         A   B   C 
  8696.  
  8697.       R1:   100   Text   =INT(RAND * 10) 
  8698.  
  8699.       R2:   200   More text   =INT(RAND * 100) 
  8700.  
  8701.       R3:   300   Still more text   =INT(RAND * 1000) 
  8702.  
  8703.  ...and range is an MRange instance representing the range A1:C3, then 
  8704.  fillSmartRight(range, action, sel, exc) will generate (overwriting the 
  8705.  previous contents of A2:C3) the following: 
  8706.  
  8707.         A   B   C 
  8708.  
  8709.       R1:   100   =NEXT(A1)   =NEXT(B1) 
  8710.  
  8711.       R2:   200   =NEXT(A2)   =NEXT(B2) 
  8712.  
  8713.       R3:   300   =NEXT(A3)   =NEXT(B3) 
  8714.  
  8715.  If the range is large enough, triggers MGController::percentComplete()=0. 
  8716.  
  8717.  void 
  8718.  
  8719.  
  8720. ΓòÉΓòÉΓòÉ 2.12.8.7. MMesaModel::fillSmartWithCell() ΓòÉΓòÉΓòÉ
  8721.  
  8722. fillSmartWithCell(const MAddress *, const MRange *, int, const MSelection *, 
  8723. MException *) [virtual] 
  8724.  
  8725.       const MAddress *   Address of the base cell 
  8726.  
  8727.       const MRange *   Range to fill 
  8728.  
  8729.       int   Action to perform (see "Action ID constants") 
  8730.  
  8731.       const MSelection *   Current selection (to be journaled for undo/redo 
  8732.       purposes) 
  8733.  
  8734.       MException *   Storage location for errors 
  8735.  
  8736.  Enters a formula into each cell in the given range, except the base cell. 
  8737.  
  8738.  The function used in each formula depends on the contents of the base cell. If 
  8739.  the base cell contains a formula, then the SAME() function is used. If the 
  8740.  base cell contains a number or a string, then the NEXT() function is used. The 
  8741.  argument used in each formula is a relative reference to an adjacent cell in 
  8742.  the direction of the base cell, where vertical references have priority over 
  8743.  horizontal ones. 
  8744.  
  8745.  For example, if cells A1 through C3 have the following contents: 
  8746.  
  8747.         A   B   C 
  8748.  
  8749.       R1:   100   Text   =INT(RAND * 10) 
  8750.  
  8751.       R2:   200   More text   =INT(RAND * 100) 
  8752.  
  8753.       R3:   300   Still more text   =INT(RAND * 1000) 
  8754.  
  8755.  ...and range is an MRange instance representing the range A1:C3, and cell is 
  8756.  an MAddress instance representing cell B2, then fillSmartWithCell(cell,range, 
  8757.  action, sel, exc) will generate (overwriting the previous contents of A2:C3) 
  8758.  the following: 
  8759.  
  8760.         A   B   C 
  8761.  
  8762.       R1:   =NEXT(A2)   =NEXT(B2)   =NEXT(C2  ar. 
  8763.  
  8764.       R2:   =NEXT(B2)   More text   =NEXT(B2) 
  8765.  
  8766.       R3:   =NEXT(A2)   =NEXT(B2)   =NEXT(C2  ar. 
  8767.  
  8768.  If the range is large enough, triggers MGController::percentComplete()=0. 
  8769.  
  8770.  void 
  8771.  
  8772.  
  8773. ΓòÉΓòÉΓòÉ 2.12.8.8. MMesaModel::fillWithCell() ΓòÉΓòÉΓòÉ
  8774.  
  8775. fillWithCell(const MAddress *, const MRange *, int, const MSelection *, 
  8776. MException *) [virtual] 
  8777.  
  8778.       const MAddress *   Address of base cell 
  8779.  
  8780.       const MRange *   Range to fill 
  8781.  
  8782.       int   Action to perform (see "Action ID constants") 
  8783.  
  8784.       const MSelection *   Current selection (to be journaled for undo/redo 
  8785.       purposes) 
  8786.  
  8787.       MException *   Storage location for errors 
  8788.  
  8789.  Copies the contents of the base cell into every other cell in the given range. 
  8790.  
  8791.  If the range is large enough, triggers MGController::percentComplete()=0. 
  8792.  
  8793.  void 
  8794.  
  8795.  
  8796. ΓòÉΓòÉΓòÉ 2.12.8.9. MMesaModel::importText() ΓòÉΓòÉΓòÉ
  8797.  
  8798. importText(MStream *, const MAddress *, int, const MSelection *, MException *) 
  8799. [virtual] 
  8800.  
  8801.       MStream *st   Input stream 
  8802.  
  8803.       const MAddress *   MAddress to store it in 
  8804.  
  8805.       int   Action to perform (see "Action ID constants") 
  8806.  
  8807.       const MSelection *   Current selection (to be journaled for undo/redo 
  8808.       purposes) 
  8809.  
  8810.       MException *   Storage location for errors 
  8811.  
  8812.  Reads text from st (see MStream) and places it in the given address. If the 
  8813.  character being read is a tab or a newline, then the character is ignored and 
  8814.  the destination address is offset by one column or one row, respectively. 
  8815.  
  8816.  void 
  8817.  
  8818.  
  8819. ΓòÉΓòÉΓòÉ 2.12.8.10. MMesaModel::moveCells() ΓòÉΓòÉΓòÉ
  8820.  
  8821. moveCells(const MRange *, const MAddress *, int, MException *, const MSelection 
  8822. *) [virtual] 
  8823.  
  8824.       const MRange *   Source range 
  8825.  
  8826.       const MAddress *   Offset to move them 
  8827.  
  8828.       int   Action to perform (see "Action ID constants") 
  8829.  
  8830.       MException *   Storage location for errors 
  8831.  
  8832.       const MSelection *   Current selection (to be journaled for undo/redo 
  8833.       purposes) 
  8834.  
  8835.  Changes the location of each of the given cells by the given offset, replacing 
  8836.  the existing cells at that location if there are any. If the new location is 
  8837.  beyond the existing boundaries of the layer, expands the layer. 
  8838.  
  8839.  void 
  8840.  
  8841.  
  8842. ΓòÉΓòÉΓòÉ 2.12.9. Sorting ranges of cells ΓòÉΓòÉΓòÉ
  8843.  
  8844. Open the Contents view and expand this section to see a list of methods. 
  8845.  
  8846.  
  8847. ΓòÉΓòÉΓòÉ 2.12.9.1. MMesaModel::sort() ΓòÉΓòÉΓòÉ
  8848.  
  8849. sort(const MRange *, int, int, int, int *, int *, int, MSelection *, MException 
  8850. *) [virtual] 
  8851.  
  8852.       const MRange *   Range to sort 
  8853.  
  8854.       int   Does the range have titles? 1 for yes, 0 for no 
  8855.  
  8856.       int   Sort by row or by column? 1 for column, 0 for row. 
  8857.  
  8858.       int   Number of sort keys 
  8859.  
  8860.       int *   Array of integers for each sort key, each defining the row or 
  8861.       column for that key (stored as an offset into the range) 
  8862.  
  8863.       int *   Array of one integer for each sort key, each indicating the sort 
  8864.       order for that key (1 for ascending, -1 for descending) 
  8865.  
  8866.       int   Action to perform (see "Action ID constants") 
  8867.  
  8868.       const MSelection *   Current selection (to be journaled for undo/redo 
  8869.       purposes) 
  8870.  
  8871.       MException *    Storage location for errors 
  8872.  
  8873.  Sorts the contents of the range. 
  8874.  
  8875.  Each data series in the range (see below) is sorted based on the values in its 
  8876.  key cell(s) and the sort order defined for that key (if ascending, then cell 
  8877.  contents are ordered first to last from top to bottom; if descending, they are 
  8878.  ordered first to last from bottom to top). 
  8879.  
  8880.  Up to 6 keys can be defined. The second key is used only to resolve if the 
  8881.  values of the first key cells of two data series are identical (the third is 
  8882.  used to resolve ties of the second, and so forth). If the range has titles, 
  8883.  the first data series in the range is ignored. 
  8884.  
  8885.  A data series is a row, if the range is being sorted by row, or a column, if 
  8886.  the range is being sorted by column. 
  8887.  
  8888.  For example, given the following cells in range: 
  8889.  
  8890.         Col 0   Col 1   Col 2   Col 3 
  8891.  
  8892.       Row 0   ID   Date   Day   Color 
  8893.  
  8894.       Row 1   42   26-Aug-95   Sat   Blue 
  8895.  
  8896.       Row 2   96   19-Mar-95   Sun   Red 
  8897.  
  8898.       Row 3   19   02-Aug-95   Wed   Green 
  8899.  
  8900.       Row 4   42   17-Jul-95   Mon   Orange 
  8901.  
  8902.       Row 5   35   09-Jun-95   Fri   Blue 
  8903.  
  8904.       Row 6   97   08-Oct-95   Sun   Red 
  8905.  
  8906.  ...and given an integer array keys = {3,2, 0} and an integer array order = {1, 
  8907.  -1, 1}, then sort(range, 1,0,3,keys, order, defaultAction, &sel, &tmp) will 
  8908.  change the range to the following: 
  8909.  
  8910.         Col 0   Col 1   Col 2   Col 3 
  8911.  
  8912.       Row 0   ID   Date   Day   Color 
  8913.  
  8914.       Row 1   42   26-Aug-95   Sat   Blue 
  8915.  
  8916.       Row 2   35   09-Jun-95   Fri   Blue 
  8917.  
  8918.       Row 3   96   19-Mar-95   Sun   Green 
  8919.  
  8920.       Row 4   42   17-Jul-95   Mon   Orange 
  8921.  
  8922.       Row 5   19   02-Aug-95   Wed   Red 
  8923.  
  8924.       Row 6   97   08-Oct-95   Sun   Red 
  8925.  
  8926.  Notice that row 0 is unchanged. Given order = {-1, -1, 1} instead, then 
  8927.  sort(range, 1,0,3,keys, order, defaultAction, &sel, &tmp) will change the 
  8928.  range to the following: 
  8929.  
  8930.         Col 0   Col 1   Col 2   Col 3 
  8931.  
  8932.       Row 0   ID   Date   Day   Color 
  8933.  
  8934.       Row 1    19   02-Aug-95   Wed   Red 
  8935.  
  8936.       Row 2   97   08-Oct-95   Sun   Red 
  8937.  
  8938.       Row 3   42   17-Jul-95   Mon   Orange 
  8939.  
  8940.       Row 4   96   19-Mar-95   Sun   Green 
  8941.  
  8942.       Row 5   42   26-Aug-95   Sat   Blue 
  8943.  
  8944.       Row 6   35   09-Jun-95   Fri   Blue 
  8945.  
  8946.  void 
  8947.  
  8948.  
  8949. ΓòÉΓòÉΓòÉ 2.12.10. Labelled and autogrow ranges ΓòÉΓòÉΓòÉ
  8950.  
  8951. Open the Contents view and expand this section to see a list of methods. 
  8952.  
  8953.  
  8954. ΓòÉΓòÉΓòÉ 2.12.10.1. MMesaModel::autoGrow() ΓòÉΓòÉΓòÉ
  8955.  
  8956. autoGrow(const MAddress *, const MRange *, int, const MSelection *, MException 
  8957. *) [virtual] 
  8958.  
  8959.       const MAddress *   Base cell 
  8960.  
  8961.       const MRange *   Selected range 
  8962.  
  8963.       int    Action to perform (see "Action ID constants") 
  8964.  
  8965.       const MSelection *   Current selection (to be journaled for undo/redo 
  8966.       purposes) 
  8967.  
  8968.       MException *   Storage location for errors 
  8969.  
  8970.  If the base cell is at the lower edge of the selected range (see 
  8971.  MRange::isAtLowerEdge()), and the range has been named and defined as an 
  8972.  autogrow range (see MRange::isAutoGrow()), extends the selected range by one 
  8973.  row and redefines the named range to include the new row. 
  8974.  
  8975.  void 
  8976.  
  8977.  
  8978. ΓòÉΓòÉΓòÉ 2.12.10.2. MMesaModel::deleteLabel() ΓòÉΓòÉΓòÉ
  8979.  
  8980. deleteLabel(const char *, int, const MSelection *) [virtual] 
  8981.  
  8982.       const char *   Label name 
  8983.  
  8984.       int   Action to perform (see "Action ID constants") 
  8985.  
  8986.       const MSelection *   Current selection (to be journaled for undo/redo 
  8987.       purposes) 
  8988.  
  8989.  Removes the given label from the model's labelled ranges list. 
  8990.  
  8991.  void 
  8992.  
  8993.  
  8994. ΓòÉΓòÉΓòÉ 2.12.10.3. MMesaModel::findLabel() ΓòÉΓòÉΓòÉ
  8995.  
  8996. findLabel(const char *, MRange *) [virtual] 
  8997.  
  8998.       const char *   Label to look for 
  8999.  
  9000.       MRange *   Storage location 
  9001.  
  9002.  Locates the range associated with the given label and stores it. 
  9003.  
  9004.  Returns 1 if the range is found, 0 otherwise. 
  9005.  
  9006.  int 
  9007.  
  9008.  
  9009. ΓòÉΓòÉΓòÉ 2.12.10.4. MMesaModel::getLabel() ΓòÉΓòÉΓòÉ
  9010.  
  9011. getLabel(int, MRange *) [virtual] 
  9012.  
  9013.       int   Index into label list 
  9014.  
  9015.       MRange *   Storage location 
  9016.  
  9017.  Stores the range associated with the given label, and returns the label name. 
  9018.  
  9019.  char * 
  9020.  
  9021.  
  9022. ΓòÉΓòÉΓòÉ 2.12.10.5. MMesaModel::getLabelNames() ΓòÉΓòÉΓòÉ
  9023.  
  9024. getLabelNames(int &) [virtual] 
  9025.  
  9026.       int &   Storage for number of items 
  9027.  
  9028.  Returns string array of label names in model and stores the number of items in 
  9029.  that list. 
  9030.  
  9031.  char ** 
  9032.  
  9033.  
  9034. ΓòÉΓòÉΓòÉ 2.12.10.6. MMesaModel::numberOfLabels() ΓòÉΓòÉΓòÉ
  9035.  
  9036. numberOfLabels() [virtual] 
  9037.  
  9038. Returns number of labelled ranges defined in the model. 
  9039.  
  9040. int 
  9041.  
  9042.  
  9043. ΓòÉΓòÉΓòÉ 2.12.10.7. MMesaModel::setLabel() ΓòÉΓòÉΓòÉ
  9044.  
  9045. setLabel(const char *, const MRange *, int, const MSelection *) [virtual] 
  9046.  
  9047.       const char *   Label 
  9048.  
  9049.       const MRange *   Range 
  9050.  
  9051.       int   Action to perform (see "Action ID constants") 
  9052.  
  9053.       const MSelection *   Current selection (to be journaled for undo/redo 
  9054.       purposes) 
  9055.  
  9056.  Adds the given label, associated with the given range, to the model's label 
  9057.  list. 
  9058.  
  9059.  void 
  9060.  
  9061.  
  9062. ΓòÉΓòÉΓòÉ 2.12.10.8. MMesaModel::shouldAutoGrow() ΓòÉΓòÉΓòÉ
  9063.  
  9064. shouldAutoGrow(const MAddress *, const MRange *) [virtual] 
  9065.  
  9066.       const MAddress *   Current base cell 
  9067.  
  9068.       const MRange *   Current range 
  9069.  
  9070.  Returns 1 if the given range is defined as autogrow in the model's label list, 
  9071.  and if the base cell is at the lower edge of that range; 0 otherwise. 
  9072.  
  9073.  int 
  9074.  
  9075.  
  9076. ΓòÉΓòÉΓòÉ 2.12.11. Frame list ΓòÉΓòÉΓòÉ
  9077.  
  9078. Open the Contents view and expand this section to see a list of methods. 
  9079.  
  9080.  
  9081. ΓòÉΓòÉΓòÉ 2.12.11.1. MMesaModel::getFrameNames() ΓòÉΓòÉΓòÉ
  9082.  
  9083. getFrameNames(int &) [virtual] 
  9084.  
  9085.       int &   Storage location 
  9086.  
  9087.  Returns the list of frame names, and stores the number of items in the list. 
  9088.  
  9089.  char ** 
  9090.  
  9091.  
  9092. ΓòÉΓòÉΓòÉ 2.12.12. Adding a frame ΓòÉΓòÉΓòÉ
  9093.  
  9094. Open the Contents view and expand this section to see a list of methods. 
  9095.  
  9096.  
  9097. ΓòÉΓòÉΓòÉ 2.12.12.1. MMesaModel::addFrame() ΓòÉΓòÉΓòÉ
  9098.  
  9099. addFrame(const MPoint *, const MAddress *, MFrame *, int, const MSelection *) 
  9100.  
  9101.       const MPoint *   Point to display the frame at 
  9102.  
  9103.       const MAddress *   Cell to anchor at 
  9104.  
  9105.       MFrame *   Frame to be added 
  9106.  
  9107.       int   Action to perform (see "Action ID constants") 
  9108.  
  9109.       const MSelection *   Current selection (to be journaled for undo/redo 
  9110.       purposes) 
  9111.  
  9112.  Adds the given frame to the model's frame list (see MFrameXfer). 
  9113.  
  9114.  Returns name of the frame. 
  9115.  
  9116.  char * 
  9117.  
  9118.  
  9119. ΓòÉΓòÉΓòÉ 2.12.12.2. MMesaModel::addImage() ΓòÉΓòÉΓòÉ
  9120.  
  9121. addImage(const MPoint *, const MAddress *, MImage *, int, const MSelection *) 
  9122.  
  9123.       const MPoint *   Point to display the image at 
  9124.  
  9125.       const MAddress *   Cell to anchor at 
  9126.  
  9127.       MImage *   Image to be added 
  9128.  
  9129.       int   Action to perform (see "Action ID constants") 
  9130.  
  9131.       const MSelection *   Current selection (to be journaled for undo/redo 
  9132.       purposes) 
  9133.  
  9134.  Adds the given image to the model's image list. 
  9135.  
  9136.  Returns name of the image. 
  9137.  
  9138.  char * 
  9139.  
  9140.  
  9141. ΓòÉΓòÉΓòÉ 2.12.12.3. MMesaModel::createGraph() ΓòÉΓòÉΓòÉ
  9142.  
  9143. createGraph(MRect *, const MAddress *, int, const MRange *, int, const 
  9144. MSelection *) [virtual] 
  9145.  
  9146.       MRect *   Size and position of graph 
  9147.  
  9148.       const MAddress *   Anchor cell for graph frame 
  9149.  
  9150.       int   What type of graph (see "Frame constants")? 
  9151.  
  9152.       const MRange *   Range to be graphed 
  9153.  
  9154.       int   Action to perform (see "Action ID constants") 
  9155.  
  9156.       const MSelection *   Current selection (to be journaled for undo/redo 
  9157.       purposes) 
  9158.  
  9159.  Creates a graph of the given type and the given data at the given location, 
  9160.  anchored to the given cell. 
  9161.  
  9162.  Returns the frame name of the graph. 
  9163.  
  9164.  char * 
  9165.  
  9166.  
  9167. ΓòÉΓòÉΓòÉ 2.12.12.4. MMesaModel::duplicateFrame() ΓòÉΓòÉΓòÉ
  9168.  
  9169. duplicateFrame(const char *, const MPoint *, const char *, int, const 
  9170. MSelection *) [virtual] 
  9171.  
  9172.       const char *   Name of frame to duplicate 
  9173.  
  9174.       const MPoint *   Position of upper-left corner of new frame 
  9175.  
  9176.       const char *   Unused 
  9177.  
  9178.       int   Action to perform (see "Action ID constants") 
  9179.  
  9180.       const MSelection *   Current selection (to be journaled for undo/redo 
  9181.       purposes) 
  9182.  
  9183.  Creates a copy of the named frame at the given position. 
  9184.  
  9185.  void 
  9186.  
  9187.  
  9188. ΓòÉΓòÉΓòÉ 2.12.12.5. MMesaModel::newShape() ΓòÉΓòÉΓòÉ
  9189.  
  9190. newShape(int, const MAddress *, const MRect *, int, int, int, const MSelection 
  9191. *) [virtual] 
  9192.  
  9193.       int    Type of shape (see "Shape and imported graphic type constants") 
  9194.  
  9195.       const MAddress *   Anchor cell 
  9196.  
  9197.       const MRect *   Position for shape 
  9198.  
  9199.       int   Line width 
  9200.  
  9201.       int    Line type (arrowheads) 
  9202.  
  9203.       int   Action to perform (see "Action ID constants") 
  9204.  
  9205.       const MSelection *   Current selection (to be journaled for undo/redo 
  9206.       purposes) 
  9207.  
  9208.  Creates a new frame of the given type at the given position with the given 
  9209.  parameters. 
  9210.  
  9211.  void 
  9212.  
  9213.  
  9214. ΓòÉΓòÉΓòÉ 2.12.13. Removing a frame ΓòÉΓòÉΓòÉ
  9215.  
  9216. There are no methods designed exclusively to remove frames from a model. 
  9217. However, MMesaModel::cut() and MMesaModel::clear() will both delete a frame if 
  9218. it is included within the initial selection parameter. 
  9219.  
  9220.  
  9221. ΓòÉΓòÉΓòÉ 2.12.14. Identifying the position of a frame ΓòÉΓòÉΓòÉ
  9222.  
  9223. Open the Contents view and expand this section to see a list of methods. 
  9224.  
  9225.  
  9226. ΓòÉΓòÉΓòÉ 2.12.14.1. MMesaModel::frameAtPoint() ΓòÉΓòÉΓòÉ
  9227.  
  9228. frameAtPoint(const MAddress *, const MPoint *, char **) [virtual] 
  9229.  
  9230.       const MAddress *   Upper-left corner of display 
  9231.  
  9232.       const MPoint *   Point (in sheet coordinates) 
  9233.  
  9234.       char **   Storage location 
  9235.  
  9236.  Identifies the frame at the given point if one exists (or the uppermost frame 
  9237.  if there are several frames at that point), and stores the frame name. 
  9238.  
  9239.  Returns 1 if a frame is found, 0 otherwise. 
  9240.  
  9241.  int 
  9242.  
  9243.  
  9244. ΓòÉΓòÉΓòÉ 2.12.14.2. MMesaModel::getCornerForFrame() ΓòÉΓòÉΓòÉ
  9245.  
  9246. getCornerForFrame(const char *, const MAddress *, const MPoint *) [virtual] 
  9247.  
  9248.       const char *   Frame name to look for 
  9249.  
  9250.       const MAddress *   Upper left corner of display (used for translating 
  9251.       between frame and sheet coordinates) 
  9252.  
  9253.       const MPoint *   Point 
  9254.  
  9255.  Identifies the corner of the given frame (if any) represented by the given 
  9256.  point. This is particularly useful for determining whether the a frame is 
  9257.  being resized. 
  9258.  
  9259.  Return 0 if the point is not a corner of the frame, or the corner ID if it is 
  9260.  (see "Frame corner constants"). 
  9261.  
  9262.  int 
  9263.  
  9264.  
  9265. ΓòÉΓòÉΓòÉ 2.12.14.3. MMesaModel::getRectForFrame() ΓòÉΓòÉΓòÉ
  9266.  
  9267. getRectForFrame(const MAddress *, const char *, MRect *) [virtual] 
  9268.  
  9269.       const MAddress *   Upper-left corner of display 
  9270.  
  9271.       const char *   Frame name 
  9272.  
  9273.       MRect *   Storage location 
  9274.  
  9275.  Stores the bounding rectangle for the given frame, if it exists. 
  9276.  
  9277.  Returns 1 if the frame exists, 0 otherwise. 
  9278.  
  9279.  int 
  9280.  
  9281.  
  9282. ΓòÉΓòÉΓòÉ 2.12.14.4. MMesaModel::isFrameAt() ΓòÉΓòÉΓòÉ
  9283.  
  9284. isFrameAt(int, const MRect *) [virtual] 
  9285.  
  9286.       int    Which layer? 
  9287.  
  9288.       const MRect *   Rectangle parameter 
  9289.  
  9290.  Compares the position of each frame in the model frame list to that of the 
  9291.  given rectangle. Returns 1 if there is a match, 0 otherwise. 
  9292.  
  9293.  int 
  9294.  
  9295.  
  9296. ΓòÉΓòÉΓòÉ 2.12.15. Retrieving frame settings ΓòÉΓòÉΓòÉ
  9297.  
  9298. Open the Contents view and expand this section to see a list of methods. 
  9299.  
  9300.  
  9301. ΓòÉΓòÉΓòÉ 2.12.15.1. MMesaModel::frameHasText() ΓòÉΓòÉΓòÉ
  9302.  
  9303. frameHasText(const char *frame) [virtual] 
  9304.  
  9305.       const char *frame   Frame name 
  9306.  
  9307.  Returns 1 if the named frame contains text, 0 otherwise. 
  9308.  
  9309.  int 
  9310.  
  9311.  
  9312. ΓòÉΓòÉΓòÉ 2.12.15.2. MMesaModel::getFrameText() ΓòÉΓòÉΓòÉ
  9313.  
  9314. getFrameText(const char *frame) [virtual] 
  9315.  
  9316.       const char *frame   Frame name 
  9317.  
  9318.  If the named frame has text in it, returns the text in frame. 
  9319.  
  9320.  char * 
  9321.  
  9322.  
  9323. ΓòÉΓòÉΓòÉ 2.12.15.3. MMesaModel::getFrameInfo() ΓòÉΓòÉΓòÉ
  9324.  
  9325. getFrameInfo(const char *) [virtual] 
  9326.  
  9327.       const char *   Frame name 
  9328.  
  9329.  Returns an MFrameXfer instance including the settings of the named frame. 
  9330.  
  9331.  MFrameXfer * 
  9332.  
  9333.  
  9334. ΓòÉΓòÉΓòÉ 2.12.16. Changing frame settings ΓòÉΓòÉΓòÉ
  9335.  
  9336. Open the Contents view and expand this section to see a list of methods. 
  9337.  
  9338.  
  9339. ΓòÉΓòÉΓòÉ 2.12.16.1. MMesaModel::setFrameInfo() ΓòÉΓòÉΓòÉ
  9340.  
  9341. setFrameInfo(const char *, const MFrameXfer *, int, const MSelection *) 
  9342. [virtual] 
  9343.  
  9344.       const char *   Frame name 
  9345.  
  9346.       const MFrameXfer *   New frame settings 
  9347.  
  9348.       int   Action to perform (see "Action ID constants") 
  9349.  
  9350.       const MSelection *   Current selection (to be journaled for undo/redo 
  9351.       purposes) 
  9352.  
  9353.  Applies the given frame settings to the given frame. For more information, see 
  9354.  "MFrameXfer". 
  9355.  
  9356.  void 
  9357.  
  9358.  
  9359. ΓòÉΓòÉΓòÉ 2.12.16.2. MMesaModel::setFrameOrder() ΓòÉΓòÉΓòÉ
  9360.  
  9361. setFrameOrder(const char *, int, int, const MSelection *) [virtual] 
  9362.  
  9363.       const char *   Frame name 
  9364.  
  9365.       int   Order. Top is 1, bottom is 0 
  9366.  
  9367.       int   Action to perform (see "Action ID constants") 
  9368.  
  9369.       const MSelection *   Current selection (to be journaled for undo/redo 
  9370.       purposes) 
  9371.  
  9372.  Moves the given frame to the top or the bottom of the frame stacking order. 
  9373.  
  9374.  void 
  9375.  
  9376.  
  9377. ΓòÉΓòÉΓòÉ 2.12.16.3. MMesaModel::setFrameText() ΓòÉΓòÉΓòÉ
  9378.  
  9379. setFrameText(const char *frame, char *text, int, const MSelection *sel) 
  9380. [virtual] 
  9381.  
  9382.       const char *frame   Frame name 
  9383.  
  9384.       char *text   New text 
  9385.  
  9386.       int action   Action to perform (see "Action ID constants") 
  9387.  
  9388.       const MSelection *   Current selection (to be journaled for undo/redo 
  9389.       purposes) 
  9390.  
  9391.  Adds the given text to the given frame. 
  9392.  
  9393.  void 
  9394.  
  9395.  
  9396. ΓòÉΓòÉΓòÉ 2.12.16.4. MMesaModel::setFrameToType() ΓòÉΓòÉΓòÉ
  9397.  
  9398. setFrameToType(const char *, int, int, const MSelection *) [virtual] 
  9399.  
  9400.       const char *   Frame name 
  9401.  
  9402.       int   New frame type 
  9403.  
  9404.       int   Action to perform (see "Action ID constants") 
  9405.  
  9406.       const MSelection *   Current selection (to be journaled for undo/redo 
  9407.       purposes) 
  9408.  
  9409.  Sets the frame type of the given frame (see "Frame constants"). 
  9410.  
  9411.  void 
  9412.  
  9413.  
  9414. ΓòÉΓòÉΓòÉ 2.12.17. Format list ΓòÉΓòÉΓòÉ
  9415.  
  9416. Open the Contents view and expand this section to see a list of methods. 
  9417.  
  9418.  
  9419. ΓòÉΓòÉΓòÉ 2.12.17.1. MMesaModel::getCurSymbols() ΓòÉΓòÉΓòÉ
  9420.  
  9421. getCurSymbols() [virtual] 
  9422.  
  9423. Returns string array of all the currency symbols in use within the given model. 
  9424. (Compare with MGController::getCurrencyChars().). For more information, see 
  9425. "Currency and numeric symbols". 
  9426.  
  9427. char ** 
  9428.  
  9429.  
  9430. ΓòÉΓòÉΓòÉ 2.12.17.2. MMesaModel::getFontNum() ΓòÉΓòÉΓòÉ
  9431.  
  9432. getFontNum(const MFont *) [virtual] 
  9433.  
  9434.       const MFont *   Font 
  9435.  
  9436.  Return index into the model's font list for the given font. 
  9437.  
  9438.  int 
  9439.  
  9440.  
  9441. ΓòÉΓòÉΓòÉ 2.12.17.3. MMesaModel::setCurSymbols() ΓòÉΓòÉΓòÉ
  9442.  
  9443. setCurSymbols(char **, int, const MSelection *) [virtual] 
  9444.  
  9445.       char **   New currency-symbol array 
  9446.  
  9447.       int   Action to perform (see "Action ID constants") 
  9448.  
  9449.       MException *   Storage location for errors 
  9450.  
  9451.       const MSelection *   Current selection (to be journaled for undo/redo 
  9452.       purposes) 
  9453.  
  9454.  Sets the currency-symbol array for the current model. For more information, 
  9455.  see "Currency and numeric symbols". 
  9456.  
  9457.  void 
  9458.  
  9459.  
  9460. ΓòÉΓòÉΓòÉ 2.12.18. Retrieving and changing the format of a cell ΓòÉΓòÉΓòÉ
  9461.  
  9462. Open the Contents view and expand this section to see a list of methods. 
  9463.  
  9464.  
  9465. ΓòÉΓòÉΓòÉ 2.12.18.1. MMesaModel::doGridBorder() ΓòÉΓòÉΓòÉ
  9466.  
  9467. doGridBorder(const MSelection *, int, int, const MSelection *, MException *) 
  9468. [virtual] 
  9469.  
  9470.       const MSelection *   Selection to draw border around 
  9471.  
  9472.       int   Packed int structure telling what kind of border/grid to draw 
  9473.  
  9474.       int   Action to perform (see "Action ID constants") 
  9475.  
  9476.       const MSelection *   Current selection (to be journaled for undo/redo 
  9477.       purposes) 
  9478.  
  9479.       MException *   Storage location for errors 
  9480.  
  9481.  Changes the border settings in the format of some or all of the selected cells 
  9482.  based on the packed integer parameter, as follows: 
  9483.  
  9484.      Bit   Meaning   Values 
  9485.  
  9486.       0:    Outline    1 for yes, 0 for no 
  9487.  
  9488.       1:    Grid   1 for yes, 0 for no 
  9489.  
  9490.       2-3:   Left border    Size in pixels 
  9491.  
  9492.       4:    Left border   1 for draw, 0 for don't draw 
  9493.  
  9494.       5-6:    Right border   Size in pixels 
  9495.  
  9496.       7:    Right border   1 for draw, 0 for don't draw 
  9497.  
  9498.       8-9:    Top border   Size in pixels 
  9499.  
  9500.       10:    Top border   1 for draw, 0 for don't draw 
  9501.  
  9502.       11-12:    Bottom border   Size in pixels 
  9503.  
  9504.       13:    Bottom border   1 for draw, 0 for don't draw 
  9505.  
  9506.  void 
  9507.  
  9508.  
  9509. ΓòÉΓòÉΓòÉ 2.12.18.2. MMesaModel::getFormatAndFontForCell() ΓòÉΓòÉΓòÉ
  9510.  
  9511. getFormatAndFontForCell(const MAddress *, MFormat *, MFont *) [virtual] 
  9512.  
  9513.       const MAddress *   Address of cell 
  9514.  
  9515.       MFormat *   Storage location for format 
  9516.  
  9517.       MFont *   Storage location for font 
  9518.  
  9519.  Stores the format and font for the given cell. Always returns 0 (return value 
  9520.  is reserved for future use). 
  9521.  
  9522.  int 
  9523.  
  9524.  
  9525. ΓòÉΓòÉΓòÉ 2.12.18.3. MMesaModel::setFont() ΓòÉΓòÉΓòÉ
  9526.  
  9527. setFont(const char *, int, const MRange *, int, const MSelection *, MException 
  9528. *) [virtual] 
  9529.  
  9530.       const char *   Font name 
  9531.  
  9532.       int   Font size (in points) 
  9533.  
  9534.       const MRange *   Range 
  9535.  
  9536.       int   Action to perform (see "Action ID constants") 
  9537.  
  9538.       const MSelection *   Current selection (to be journaled for undo/redo 
  9539.       purposes) 
  9540.  
  9541.       MException *   Storage location for errors 
  9542.  
  9543.  Sets every cell in the given range to the given font and size. For more 
  9544.  information, see "MFormat". 
  9545.  
  9546.  void 
  9547.  
  9548.  
  9549. ΓòÉΓòÉΓòÉ 2.12.18.4. MMesaModel::setFontAttribute() ΓòÉΓòÉΓòÉ
  9550.  
  9551. setFontAttribute(int, const MRange *, int, const MSelection *, MException *) 
  9552. [virtual] 
  9553.  
  9554.       int   Attribute 
  9555.  
  9556.       const MRange *   Range 
  9557.  
  9558.       int   Action to perform (see "Action ID constants") 
  9559.  
  9560.       const MSelection *   Current selection (to be journaled for undo/redo 
  9561.       purposes) 
  9562.  
  9563.       MException *   Storage location for errors 
  9564.  
  9565.  Applies the given attribute (see "Font attribute constants") to the font of 
  9566.  every cell in the given range. For more information, see "MFont". 
  9567.  
  9568.  void 
  9569.  
  9570.  
  9571. ΓòÉΓòÉΓòÉ 2.12.18.5. MMesaModel::setFontForLayer() ΓòÉΓòÉΓòÉ
  9572.  
  9573. setFontForLayer(int layer, const MFont *, int, const MSelection *, MException 
  9574. *) [virtual] 
  9575.  
  9576.       int layer   Which layer? 
  9577.  
  9578.       const MFont *   New font 
  9579.  
  9580.       int   Action to perform (see "Action ID constants") 
  9581.  
  9582.       const MSelection *   Current selection (to be journaled for undo/redo 
  9583.       purposes) 
  9584.  
  9585.       MException *   Storage location for errors 
  9586.  
  9587.  Sets the given font as the default font for all cells in the given layer. 
  9588.  
  9589.  void 
  9590.  
  9591.  
  9592. ΓòÉΓòÉΓòÉ 2.12.18.6. MMesaModel::setRangeToFont() ΓòÉΓòÉΓòÉ
  9593.  
  9594. setRangeToFont(const MRange *, const MFont *, int, const MSelection *, 
  9595. MException *) [virtual] 
  9596.  
  9597.       const MRange *   Range 
  9598.  
  9599.       const MFont *   New font 
  9600.  
  9601.       int   Action to perform (see "Action ID constants") 
  9602.  
  9603.       const MSelection *   Current selection (to be journaled for undo/redo 
  9604.       purposes) 
  9605.  
  9606.       MException *   Storage location for errors 
  9607.  
  9608.  Sets the font of all cells within the given range to the given font (see 
  9609.  MFont). 
  9610.  
  9611.  void 
  9612.  
  9613.  
  9614. ΓòÉΓòÉΓòÉ 2.12.18.7. MMesaModel::setRangeToFormat() ΓòÉΓòÉΓòÉ
  9615.  
  9616. setRangeToFormat(const MRange *, const MFormat *, int, const MSelection *, 
  9617. MException *) [virtual] 
  9618.  
  9619.       const MRange *   Range 
  9620.  
  9621.       const MFormat *   New format 
  9622.  
  9623.       int   Action to perform (see "Action ID constants") 
  9624.  
  9625.       const MSelection *   Current selection (to be journaled for undo/redo 
  9626.       purposes) 
  9627.  
  9628.       MException *   Storage location for errors 
  9629.  
  9630.  Sets the format of all cells within the given range to the given format (see 
  9631.  MFormat). 
  9632.  
  9633.  void 
  9634.  
  9635.      MMesaModel::clearSpecialRange() 
  9636.  
  9637.  
  9638. ΓòÉΓòÉΓòÉ 2.12.19. Changing the format of a frame ΓòÉΓòÉΓòÉ
  9639.  
  9640. Open the Contents view and expand this section to see a list of methods. 
  9641.  
  9642.  
  9643. ΓòÉΓòÉΓòÉ 2.12.19.1. MMesaModel::bkgColorDroppedOnFrameAt() ΓòÉΓòÉΓòÉ
  9644.  
  9645. bkgColorDroppedOnFrameAt(MColor, const char *, const MAddress *, const MPoint 
  9646. *, const MSelection *, int) [virtual] 
  9647.  
  9648.       MColor   What color was dropped? 
  9649.  
  9650.       const char *   Frame name 
  9651.  
  9652.       const MAddress *   Upper-left cell displayed in sheet view (used to 
  9653.       convert window coordinates into frame coordinates) 
  9654.  
  9655.       const MPoint *   Where was it dropped (in window coordinates)? 
  9656.  
  9657.       const MSelection *   Current selection (to be journaled for undo/redo 
  9658.       purposes) 
  9659.  
  9660.       int   Action to perform (see "Action ID constants") 
  9661.  
  9662.  If the named frame exists in the model and can change color, sets the 
  9663.  background color of the frame. 
  9664.  
  9665.  Otherwise, does nothing. 
  9666.  
  9667.  void 
  9668.  
  9669.  
  9670. ΓòÉΓòÉΓòÉ 2.12.19.2. MMesaModel::colorDroppedOnFrameAt() ΓòÉΓòÉΓòÉ
  9671.  
  9672. colorDroppedOnFrameAt(MColor, const char *, const MAddress *, const MPoint *, 
  9673. const MSelection *, int) [virtual] 
  9674.  
  9675.       MColor   What color was dropped? 
  9676.  
  9677.       const char *   Frame name 
  9678.  
  9679.       const MAddress *   Upper-left cell displayed in sheet view (used to 
  9680.       convert window coordinates into frame coordinates) 
  9681.  
  9682.       const MPoint *   Where was it dropped (in window coordinates)? 
  9683.  
  9684.       const MSelection *   Current selection (to be journaled for undo/redo 
  9685.       purposes) 
  9686.  
  9687.       int   Action to perform (see "Action ID constants") 
  9688.  
  9689.  If the named frame exists in the model and can change color, sets the 
  9690.  foreground color of the frame. 
  9691.  
  9692.  Otherwise, does nothing. 
  9693.  
  9694.  void 
  9695.  
  9696.  
  9697. ΓòÉΓòÉΓòÉ 2.12.19.3. MMesaModel::fontDroppedOnFrameAt() ΓòÉΓòÉΓòÉ
  9698.  
  9699. fontDroppedOnFrameAt(const MFont *, const char *, const MAddress *, const 
  9700. MPoint *, const MSelection *, int) [virtual] 
  9701.  
  9702.       const MFont *   Font that was dropped 
  9703.  
  9704.       const char *   Name of the frame the font was dropped on 
  9705.  
  9706.       const MAddress *   Current cell 
  9707.  
  9708.       const MPoint *   Location of the drop (in sheet coordinates) 
  9709.  
  9710.       const MSelection *   Current selection (to be journaled for undo/redo 
  9711.       purposes) 
  9712.  
  9713.       int   Action to perform (see "Action ID constants") 
  9714.  
  9715.  If the given frame exists and can change font, makes the font change. 
  9716.  
  9717.  void 
  9718.  
  9719.  
  9720. ΓòÉΓòÉΓòÉ 2.12.20. Layer list ΓòÉΓòÉΓòÉ
  9721.  
  9722. Open the Contents view and expand this section to see a list of methods. 
  9723.  
  9724.  
  9725. ΓòÉΓòÉΓòÉ 2.12.20.1. MMesaModel::deleteLayer() ΓòÉΓòÉΓòÉ
  9726.  
  9727. deleteLayer(int, int, MException *, const MSelection *) [virtual] 
  9728.  
  9729.       int   Layer to delete 
  9730.  
  9731.       int   Action to perform (see "Action ID constants") 
  9732.  
  9733.       MException *   Storage location for errors 
  9734.  
  9735.       const MSelection *   Current selection (to be journaled for undo/redo 
  9736.       purposes) 
  9737.  
  9738.  Deletes the given layer from the model. 
  9739.  
  9740.  void 
  9741.  
  9742.  
  9743. ΓòÉΓòÉΓòÉ 2.12.20.2. MMesaModel::getLayerNames() ΓòÉΓòÉΓòÉ
  9744.  
  9745. getLayerNames(int &) [virtual] 
  9746.  
  9747.       int &   Storage for number of items 
  9748.  
  9749.  Return string array of user-defined layer names in the model. Default names 
  9750.  (e.g.; A, B, etc) are not included. 
  9751.  
  9752.  char ** 
  9753.  
  9754.  
  9755. ΓòÉΓòÉΓòÉ 2.12.20.3. MMesaModel::getNumLayers() ΓòÉΓòÉΓòÉ
  9756.  
  9757. getNumLayers() 
  9758.  
  9759. Returns the number of layers in the model. 
  9760.  
  9761. int 
  9762.  
  9763.  
  9764. ΓòÉΓòÉΓòÉ 2.12.20.4. MMesaModel::newLayer() ΓòÉΓòÉΓòÉ
  9765.  
  9766. newLayer(int, MException *, const MSelection *) [virtual] 
  9767.  
  9768.       int   Action to perform (see "Action ID constants") 
  9769.  
  9770.       MException *   Storage location for errors 
  9771.  
  9772.       const MSelection *   Current selection (to be journaled for undo/redo 
  9773.       purposes) 
  9774.  
  9775.  Adds a new layer to the bottom of the current worksheet. 
  9776.  
  9777.  void 
  9778.  
  9779.  
  9780. ΓòÉΓòÉΓòÉ 2.12.21. Retrieving layer settings ΓòÉΓòÉΓòÉ
  9781.  
  9782. Open the Contents view and expand this section to see a list of methods. 
  9783.  
  9784.  
  9785. ΓòÉΓòÉΓòÉ 2.12.21.1. MMesaModel::getExtents() ΓòÉΓòÉΓòÉ
  9786.  
  9787. getExtents(int, int &, int &) 
  9788.  
  9789.       int    What layer are we interested in? 
  9790.  
  9791.       int &   Storage for number of rows 
  9792.  
  9793.       int &   Storage for number of columns 
  9794.  
  9795.  Stores the number of rows and columns in the given layer. 
  9796.  
  9797.  void 
  9798.  
  9799.  
  9800. ΓòÉΓòÉΓòÉ 2.12.21.2. MMesaModel::getLayerGrid() ΓòÉΓòÉΓòÉ
  9801.  
  9802. getLayerGrid(int) [virtual] 
  9803.  
  9804.       int   Which layer? 
  9805.  
  9806.  Returns 1 if the specified layer is showing grid-lines, 0 otherwise. 
  9807.  
  9808.  int 
  9809.  
  9810.  
  9811. ΓòÉΓòÉΓòÉ 2.12.21.3. MMesaModel::getLayerName() ΓòÉΓòÉΓòÉ
  9812.  
  9813. getLayerName(int n) [virtual] 
  9814.  
  9815.       int n   Which layer? 
  9816.  
  9817.  Returns the name of the given layer. By default, the first layer is named A, 
  9818.  the second B, and so forth; layers can be renamed by the user. 
  9819.  
  9820.  char * 
  9821.  
  9822.  
  9823. ΓòÉΓòÉΓòÉ 2.12.21.4. MMesaModel::getLayerProtection() ΓòÉΓòÉΓòÉ
  9824.  
  9825. getLayerProtection(int) [virtual] 
  9826.  
  9827.       int   Which layer? 
  9828.  
  9829.  Return 1 if the layer is protected, 0 otherwise. 
  9830.  
  9831.  int 
  9832.  
  9833.  
  9834. ΓòÉΓòÉΓòÉ 2.12.22. Changing layer settings ΓòÉΓòÉΓòÉ
  9835.  
  9836. Open the Contents view and expand this section to see a list of methods. 
  9837.  
  9838.  
  9839. ΓòÉΓòÉΓòÉ 2.12.22.1. MMesaModel::setExtents() ΓòÉΓòÉΓòÉ
  9840.  
  9841. setExtents(int, int, int, int, const MSelection *, MException *) [virtual] 
  9842.  
  9843.       int   Which layer? 
  9844.  
  9845.       int   New number of rows 
  9846.  
  9847.       int   New number of columns 
  9848.  
  9849.       int   Action to perform (see "Action ID constants") 
  9850.  
  9851.       const MSelection *   Current selection (to be journaled for undo/redo 
  9852.       purposes) 
  9853.  
  9854.       MException *   Storage location for errors 
  9855.  
  9856.  Sets the number of rows and columns in the given layer. 
  9857.  
  9858.  void 
  9859.  
  9860.  
  9861. ΓòÉΓòÉΓòÉ 2.12.22.2. MMesaModel::setLayerColor() ΓòÉΓòÉΓòÉ
  9862.  
  9863. setLayerColor(int, MColor, int, int, const MSelection *, MException *) 
  9864. [virtual] 
  9865.  
  9866.       int   Which layer? 
  9867.  
  9868.       MColor   What color? 
  9869.  
  9870.       int   What layer component? 
  9871.  
  9872.       int   Action to perform (see "Action ID constants") 
  9873.  
  9874.       const MSelection *   Current selection (to be journaled for undo/redo 
  9875.       purposes) 
  9876.  
  9877.       MException *   Storage location for errors 
  9878.  
  9879.  Sets the given component of the given layer (see "Layer component constants") 
  9880.  to the given color. 
  9881.  
  9882.  void 
  9883.  
  9884.  
  9885. ΓòÉΓòÉΓòÉ 2.12.22.3. MMesaModel::setLayerGrid() ΓòÉΓòÉΓòÉ
  9886.  
  9887. setLayerGrid(int, int, int, const MSelection *) [virtual] 
  9888.  
  9889.       int   Which layer? 
  9890.  
  9891.       int   Show grid? (1 for yes, 0 for no) 
  9892.  
  9893.       int   Action to perform (see "Action ID constants") 
  9894.  
  9895.       const MSelection *   Current selection (to be journaled for undo/redo 
  9896.       purposes) 
  9897.  
  9898.  Sets the given layer's grid-display status. 
  9899.  
  9900.  void 
  9901.  
  9902.  
  9903. ΓòÉΓòÉΓòÉ 2.12.22.4. MMesaModel::setLayerName() ΓòÉΓòÉΓòÉ
  9904.  
  9905. setLayerName(int, const char *, int, const MSelection *) [virtual] 
  9906.  
  9907.       int   Which layer? 
  9908.  
  9909.       const char *   New name 
  9910.  
  9911.       int   Action to perform (see "Action ID constants") 
  9912.  
  9913.       const MSelection *   Current selection (to be journaled for undo/redo 
  9914.       purposes) 
  9915.  
  9916.  Changes the name of the given layer. 
  9917.  
  9918.  void 
  9919.  
  9920.  
  9921. ΓòÉΓòÉΓòÉ 2.12.22.5. MMesaModel::setLayerProtection() ΓòÉΓòÉΓòÉ
  9922.  
  9923. setLayerProtection(int, int, int, const MSelection *) [virtual] 
  9924.  
  9925.       int   Which layer? 
  9926.  
  9927.       int   Protected? (1 for yes, 0 for no) 
  9928.  
  9929.       int   Action to perform (see "Action ID constants") 
  9930.  
  9931.       const MSelection *   Current selection (to be journaled for undo/redo 
  9932.       purposes) 
  9933.  
  9934.  Sets the protection status of the given layer. 
  9935.  
  9936.  void 
  9937.  
  9938.  
  9939. ΓòÉΓòÉΓòÉ 2.12.23. Retrieving row and column sizes ΓòÉΓòÉΓòÉ
  9940.  
  9941. Open the Contents view and expand this section to see a list of methods. 
  9942.  
  9943.  
  9944. ΓòÉΓòÉΓòÉ 2.12.23.1. MMesaModel::getColumnSize() ΓòÉΓòÉΓòÉ
  9945.  
  9946. getColumnSize(int layer, int column) [virtual] 
  9947.  
  9948.       int layer   Which layer? 
  9949.  
  9950.       int column   Which column? 
  9951.  
  9952.  Returns the width (in pixels) of the given column. 
  9953.  
  9954.  int 
  9955.  
  9956.  
  9957. ΓòÉΓòÉΓòÉ 2.12.23.2. MMesaModel::getDefaultCellSize() ΓòÉΓòÉΓòÉ
  9958.  
  9959. getDefaultCellSize(int, int &, int &) [virtual] 
  9960.  
  9961.       int   Layer 
  9962.  
  9963.       int &   Storage for default width 
  9964.  
  9965.       int &   Storage for default height 
  9966.  
  9967.  Stores the default cell height and width for the given layer. 
  9968.  
  9969.  void 
  9970.  
  9971.  
  9972. ΓòÉΓòÉΓòÉ 2.12.23.3. MMesaModel::getRowSize() ΓòÉΓòÉΓòÉ
  9973.  
  9974. getRowSize(int layer, int row) [virtual] 
  9975.  
  9976.       int layer   Which layer? 
  9977.  
  9978.       int row   Which row? 
  9979.  
  9980.  Returns the size of the given row (in pixels). 
  9981.  
  9982.  int 
  9983.  
  9984.  
  9985. ΓòÉΓòÉΓòÉ 2.12.23.4. MMesaModel::getRulerHi() ΓòÉΓòÉΓòÉ
  9986.  
  9987. getRulerHi() [virtual] 
  9988.  
  9989. Returns the height of row headings, in pixels. 
  9990.  
  9991. int 
  9992.  
  9993.  
  9994. ΓòÉΓòÉΓòÉ 2.12.23.5. MMesaModel::getRulerWid() ΓòÉΓòÉΓòÉ
  9995.  
  9996. getRulerWid() [virtual] 
  9997.  
  9998. Returns the width of column headings, in pixels. 
  9999.  
  10000. int 
  10001.  
  10002.  
  10003. ΓòÉΓòÉΓòÉ 2.12.23.6. MMesaModel::isColHidden() ΓòÉΓòÉΓòÉ
  10004.  
  10005. isColHidden(int, int) [virtual] 
  10006.  
  10007.       int    Which layer? 
  10008.  
  10009.       int    Which column? 
  10010.  
  10011.  Returns 1 if the given column is hidden in the given layer, 0 otherwise. 
  10012.  
  10013.  int 
  10014.  
  10015.  
  10016. ΓòÉΓòÉΓòÉ 2.12.23.7. MMesaModel::isRowHidden() ΓòÉΓòÉΓòÉ
  10017.  
  10018. isRowHidden(int, int) [virtual] 
  10019.  
  10020.       int    Which layer? 
  10021.  
  10022.       int    Which row? 
  10023.  
  10024.  Returns 1 if the given row is hidden in the given layer, 0 otherwise. 
  10025.  
  10026.  int 
  10027.  
  10028.  
  10029. ΓòÉΓòÉΓòÉ 2.12.24. Changing row and column sizes ΓòÉΓòÉΓòÉ
  10030.  
  10031. Open the Contents view and expand this section to see a list of methods. 
  10032.  
  10033.  
  10034. ΓòÉΓòÉΓòÉ 2.12.24.1. MMesaModel::setColumnSize() ΓòÉΓòÉΓòÉ
  10035.  
  10036. setColumnSize(const MRange *, int, const MSelection *, int, MException *) 
  10037. [virtual] 
  10038.  
  10039.       const MRange *   Range to resize 
  10040.  
  10041.       int   New size (in pixels) 
  10042.  
  10043.       const MSelection *   Current selection (to be journaled for undo/redo 
  10044.       purposes) 
  10045.  
  10046.       int   Action to perform (see "Action ID constants") 
  10047.  
  10048.       MException *   Storage location for errors 
  10049.  
  10050.  Sets the column width for all columns containing cells in the given range to 
  10051.  the new size. 
  10052.  
  10053.  void 
  10054.  
  10055.  
  10056. ΓòÉΓòÉΓòÉ 2.12.24.2. MMesaModel::setDefaultCellSize() ΓòÉΓòÉΓòÉ
  10057.  
  10058. setDefaultCellSize(int, int, int, int, const MSelection *) [virtual] 
  10059.  
  10060.       int   Which layer? 
  10061.  
  10062.       int   New default width 
  10063.  
  10064.       int   New default height 
  10065.  
  10066.       int   Action to perform (see "Action ID constants") 
  10067.  
  10068.       const MSelection *   Current selection (to be journaled for undo/redo 
  10069.       purposes) 
  10070.  
  10071.  Sets the default cell size for the given layer. 
  10072.  
  10073.  void 
  10074.  
  10075.  
  10076. ΓòÉΓòÉΓòÉ 2.12.24.3. MMesaModel::setRowSize() ΓòÉΓòÉΓòÉ
  10077.  
  10078. setRowSize(const MRange *, int, const MSelection *, int, MException *) 
  10079. [virtual] 
  10080.  
  10081.       const MRange *   Range to resize 
  10082.  
  10083.       int   New size (in pixels) 
  10084.  
  10085.       const MSelection *   Current selection (to be journaled for undo/redo 
  10086.       purposes) 
  10087.  
  10088.       int   Action to perform (see "Action ID constants") 
  10089.  
  10090.       MException *   Storage location for errors 
  10091.  
  10092.  Sets the row height for all rows containing cells in the given range to the 
  10093.  new size. 
  10094.  
  10095.  void 
  10096.  
  10097.  
  10098. ΓòÉΓòÉΓòÉ 2.12.24.4. MMesaModel::smartSizeColumns() ΓòÉΓòÉΓòÉ
  10099.  
  10100. smartSizeColumns( const MRange *, int, const MSelection *, MException * ) 
  10101. [virtual] 
  10102.  
  10103.       const MRange *   Range 
  10104.  
  10105.       int   Action to perform (see "Action ID constants") 
  10106.  
  10107.       const MSelection *   Current selection (to be journaled for undo/redo 
  10108.       purposes) 
  10109.  
  10110.       MException *    Storage location for errors 
  10111.  
  10112.  Calculates a new column width for each column containing cells in the given 
  10113.  range, and resizes the columns accordingly. The new column size is equal to 
  10114.  the maximum of the widths of the contents of the selected cells in that 
  10115.  column. 
  10116.  
  10117.  void 
  10118.  
  10119.  
  10120. ΓòÉΓòÉΓòÉ 2.12.24.5. MMesaModel::smartSizeRows() ΓòÉΓòÉΓòÉ
  10121.  
  10122. smartSizeRows( const MRange *, int, const MSelection *, MException * ) 
  10123. [virtual] 
  10124.  
  10125.       const MRange *   Range 
  10126.  
  10127.       int   Action to perform (see "Action ID constants") 
  10128.  
  10129.       const MSelection *   Current selection (to be journaled for undo/redo 
  10130.       purposes) 
  10131.  
  10132.       MException *    Storage location for errors 
  10133.  
  10134.  Calculates a new row height for each row containing cells in the given range, 
  10135.  and resizes the rows accordingly. The new row size is equal to the maximum of 
  10136.  the heights of the contents of the selected cells in that row. 
  10137.  
  10138.  void 
  10139.  
  10140.  
  10141. ΓòÉΓòÉΓòÉ 2.12.25. Script list ΓòÉΓòÉΓòÉ
  10142.  
  10143. Open the Contents view and expand this section to see a list of methods. 
  10144.  
  10145.  
  10146. ΓòÉΓòÉΓòÉ 2.12.25.1. MMesaModel::deleteScript() ΓòÉΓòÉΓòÉ
  10147.  
  10148. deleteScript(const char *, int, const MSelection *) [virtual] 
  10149.  
  10150.       const char *   Script name 
  10151.  
  10152.       int   Action to perform (see "Action ID constants") 
  10153.  
  10154.       const MSelection *   Current selection (to be journaled for undo/redo 
  10155.       purposes) 
  10156.  
  10157.  Deletes the named script from the current sheet. 
  10158.  
  10159.  void 
  10160.  
  10161.  
  10162. ΓòÉΓòÉΓòÉ 2.12.25.2. MMesaModel::executeCloseScripts() ΓòÉΓòÉΓòÉ
  10163.  
  10164. executeCloseScripts() [virtual] 
  10165.  
  10166. Identifies the scripts in the model's script list that are marked to execute 
  10167. when the model is closed, and adds them to the controller's script queue (see 
  10168. MGController::addScriptToQueue()). 
  10169.  
  10170. void 
  10171.  
  10172.  
  10173. ΓòÉΓòÉΓòÉ 2.12.25.3. MMesaModel::executeOpenScripts() ΓòÉΓòÉΓòÉ
  10174.  
  10175. executeOpenScripts() [virtual] 
  10176.  
  10177. Identifies the scripts in the model's script list that are marked to execute 
  10178. when the model is opened, and adds them to the controller's script queue (see 
  10179. MGController::addScriptToQueue()). 
  10180.  
  10181. void 
  10182.  
  10183.  
  10184. ΓòÉΓòÉΓòÉ 2.12.25.4. MMesaModel::getNextScriptName() ΓòÉΓòÉΓòÉ
  10185.  
  10186. getNextScriptName() [virtual] 
  10187.  
  10188. Returns the first string of the form Script### (e.g.; Script001, Script002, 
  10189. etc) that is not already included in the model's script name list. 
  10190.  
  10191. char * 
  10192.  
  10193.  
  10194. ΓòÉΓòÉΓòÉ 2.12.25.5. MMesaModel::getNumScripts() ΓòÉΓòÉΓòÉ
  10195.  
  10196. getNumScripts() [virtual] 
  10197.  
  10198. Returns the number of scripts in the model. 
  10199.  
  10200. int 
  10201.  
  10202.  
  10203. ΓòÉΓòÉΓòÉ 2.12.25.6. MMesaModel::getScriptNames() ΓòÉΓòÉΓòÉ
  10204.  
  10205. getScriptNames(int &) [virtual] 
  10206.  
  10207.       int &   Storage for number of elements in array 
  10208.  
  10209.  Returns string array of script names. 
  10210.  
  10211.  char ** 
  10212.  
  10213.  
  10214. ΓòÉΓòÉΓòÉ 2.12.25.7. MMesaModel::hasCloseScripts() ΓòÉΓòÉΓòÉ
  10215.  
  10216. hasCloseScripts() 
  10217.  
  10218. Returns 1 if any scripts in the model are set to execute when the model is 
  10219. closed; 0 otherwise. 
  10220.  
  10221. int 
  10222.  
  10223.  
  10224. ΓòÉΓòÉΓòÉ 2.12.26. Retrieving script settings ΓòÉΓòÉΓòÉ
  10225.  
  10226. Open the Contents view and expand this section to see a list of methods. 
  10227.  
  10228.  
  10229. ΓòÉΓòÉΓòÉ 2.12.26.1. MMesaModel::getScript() ΓòÉΓòÉΓòÉ
  10230.  
  10231. getScript(const char *) [virtual] 
  10232.  
  10233.       const char *   Script name 
  10234.  
  10235.  Returns the executable REXX program for the named script. 
  10236.  
  10237.  char * 
  10238.  
  10239.  getScript(int) [virtual] 
  10240.  
  10241.       int   Index into script list 
  10242.  
  10243.  Returns the executable REXX program for the named script. 
  10244.  
  10245.  char * 
  10246.  
  10247.  
  10248. ΓòÉΓòÉΓòÉ 2.12.26.2. MMesaModel::getScriptInfo() ΓòÉΓòÉΓòÉ
  10249.  
  10250. getScriptInfo(const char *) [virtual] 
  10251.  
  10252.       const char *   Script name 
  10253.  
  10254.  Returns a packed integer for the named script, indicating whether the script 
  10255.  is set to execute automatically when the model opens or closes. 
  10256.  
  10257.  int 
  10258.  
  10259.  
  10260. ΓòÉΓòÉΓòÉ 2.12.26.3. MMesaModel::getScriptName() ΓòÉΓòÉΓòÉ
  10261.  
  10262. getScriptName(int) [virtual] 
  10263.  
  10264.       int   Index into script list 
  10265.  
  10266.  Returns name of the given script. 
  10267.  
  10268.  char * 
  10269.  
  10270.  
  10271. ΓòÉΓòÉΓòÉ 2.12.27. Changing script settings ΓòÉΓòÉΓòÉ
  10272.  
  10273. Open the Contents view and expand this section to see a list of methods. 
  10274.  
  10275.  
  10276. ΓòÉΓòÉΓòÉ 2.12.27.1. MMesaModel::setScript() ΓòÉΓòÉΓòÉ
  10277.  
  10278. setScript(const char *, const char *, int, int, const MSelection *) [virtual] 
  10279.  
  10280.       const char *   Name of script 
  10281.  
  10282.       const char *   Executable script text 
  10283.  
  10284.       int   Packed integer containing script-execution settings 
  10285.  
  10286.       int   Action to perform (see "Action ID constants") 
  10287.  
  10288.       const MSelection *   Current selection (to be journaled for undo/redo 
  10289.       purposes) 
  10290.  
  10291.  Adds an entry with the given values to the model's script list. 
  10292.  
  10293.  void 
  10294.  
  10295.  
  10296. ΓòÉΓòÉΓòÉ 2.12.27.2. MMesaModel::setScriptInfo() ΓòÉΓòÉΓòÉ
  10297.  
  10298. setScriptInfo(const char *, int, int, const MSelection *) [virtual] 
  10299.  
  10300.       const char *   Script name 
  10301.  
  10302.       int   New script info settings 
  10303.  
  10304.       int   Action to perform (see "Action ID constants") 
  10305.  
  10306.       const MSelection *   Current selection (to be journaled for undo/redo 
  10307.       purposes) 
  10308.  
  10309.  Sets the script info value for the named script. Script info is a packed 
  10310.  integer which currently contains script-execution settings (execute on close, 
  10311.  execute on open). 
  10312.  
  10313.  void 
  10314.  
  10315.  
  10316. ΓòÉΓòÉΓòÉ 2.12.27.3. MMesaModel::setScriptName() ΓòÉΓòÉΓòÉ
  10317.  
  10318. setScriptName(int, const char *, int, const MSelection *) [virtual] 
  10319.  
  10320.       int   Index into script list 
  10321.  
  10322.       const char *   New name for the script 
  10323.  
  10324.       int   Action to perform (see "Action ID constants") 
  10325.  
  10326.       const MSelection *   Current selection (to be journaled for undo/redo 
  10327.       purposes) 
  10328.  
  10329.  Sets the name of the given script. 
  10330.  
  10331.  void 
  10332.  
  10333.  
  10334. ΓòÉΓòÉΓòÉ 2.12.28. Displaying the model ΓòÉΓòÉΓòÉ
  10335.  
  10336. Open the Contents view and expand this section to see a list of methods. 
  10337.  
  10338.  
  10339. ΓòÉΓòÉΓòÉ 2.12.28.1. MMesaModel::drawInto() ΓòÉΓòÉΓòÉ
  10340.  
  10341. drawInto(MDraw *, const MRect *, const MRect *, const MAddress *, const 
  10342. MSelection *, int,const MSelection *, float, float, int, const char **,const 
  10343. MAddress *, const char *, int,int) [virtual] 
  10344.  
  10345.       MDraw *   Handle to the drawing space to draw into 
  10346.  
  10347.       const MRect *   The rectangle defining the entire page to be written on 
  10348.  
  10349.       const MRect *   The rectangle defining the area to draw/update 
  10350.  
  10351.       const MAddress *   Address of cell in upper-left corner of region to be 
  10352.       displayed 
  10353.  
  10354.       const MSelection *   Current selection (to be journaled for undo/redo 
  10355.       purposes) 
  10356.  
  10357.       int   Flags to control the drawing (see "Frame drawing constants") 
  10358.  
  10359.       MSelection *   Cell or range being selected as a reference via keyboard 
  10360.       commands, if any; defaults to 0 
  10361.  
  10362.       float    Height of the column headers 
  10363.  
  10364.       float    Width of the row headers 
  10365.  
  10366.       int    Number of column titles in the model, if any; defaults to -1 
  10367.  
  10368.       const char**    Text of column titles in the model, if any; defaults to 
  10369.       NULL 
  10370.  
  10371.       const MAddress *   Address of the cell being edited using in-cell 
  10372.       editing, if any; defaults to NULL 
  10373.  
  10374.       const char *   Unused; defaults to NULL 
  10375.  
  10376.       int    Unused; defaults to -1 
  10377.  
  10378.       int    Unused; defaults to -1 
  10379.  
  10380.  Draws the appropriate part of spreadsheet, including all displayed frames, 
  10381.  cells, etc., based on the given flags (see "Frame drawing constants"). 
  10382.  
  10383.  void 
  10384.  
  10385.  
  10386. ΓòÉΓòÉΓòÉ 2.12.28.2. MMesaModel::redisplay() ΓòÉΓòÉΓòÉ
  10387.  
  10388. redisplay() [virtual] 
  10389.  
  10390. Redisplays the model. 
  10391.  
  10392. void 
  10393.  
  10394.  
  10395. ΓòÉΓòÉΓòÉ 2.12.29. Window list ΓòÉΓòÉΓòÉ
  10396.  
  10397. Open the Contents view and expand this section to see a list of methods. 
  10398.  
  10399.  
  10400. ΓòÉΓòÉΓòÉ 2.12.29.1. MMesaModel::getPosition() ΓòÉΓòÉΓòÉ
  10401.  
  10402. getPosition() [virtual] 
  10403.  
  10404. Returns an MPosition instance representing the current positions of all the 
  10405. windows associated with the given model (see Other Mesa-specific classes). 
  10406.  
  10407. MPosition * 
  10408.  
  10409.  
  10410. ΓòÉΓòÉΓòÉ 2.12.29.2. MMesaModel::getScale() ΓòÉΓòÉΓòÉ
  10411.  
  10412. getScale(float *scArray) [virtual] 
  10413.  
  10414.       float *scArray   Array of storage locations 
  10415.  
  10416.  Stores the magnification setting for each window in the model's window list 
  10417.  (up to 32 windows). 
  10418.  
  10419.  void 
  10420.  
  10421.  
  10422. ΓòÉΓòÉΓòÉ 2.12.29.3. MMesaModel::setPosition() ΓòÉΓòÉΓòÉ
  10423.  
  10424. setPosition(const MPosition *) [virtual] 
  10425.  
  10426.       const MPosition *   New window-position information 
  10427.  
  10428.  Sets the positions of the windows in the model's window list (see Other 
  10429.  Mesa-specific classes). 
  10430.  
  10431.  void 
  10432.  
  10433.  
  10434. ΓòÉΓòÉΓòÉ 2.12.29.4. MMesaModel::setScale() ΓòÉΓòÉΓòÉ
  10435.  
  10436. setScale(float *scArray) [virtual] 
  10437.  
  10438.       float *scArray   Array of storage locations 
  10439.  
  10440.  Sets the magnification setting for each window in the model's window list (up 
  10441.  to 32 windows). 
  10442.  
  10443.  void 
  10444.  
  10445.  
  10446. ΓòÉΓòÉΓòÉ 2.12.30. Recalculation ΓòÉΓòÉΓòÉ
  10447.  
  10448. Open the Contents view and expand this section to see a list of methods. 
  10449.  
  10450.  
  10451. ΓòÉΓòÉΓòÉ 2.12.30.1. MMesaModel::getAutoRecalc() ΓòÉΓòÉΓòÉ
  10452.  
  10453. getAutoRecalc() [virtual] 
  10454.  
  10455. Returns 1 if automatic recalculation is set; 0 otherwise. 
  10456.  
  10457. int 
  10458.  
  10459.  
  10460. ΓòÉΓòÉΓòÉ 2.12.30.2. MMesaModel::getHasChanged() ΓòÉΓòÉΓòÉ
  10461.  
  10462. getHasChanged() [virtual] 
  10463.  
  10464. Returns 1 if the model has changed since the last recalculation, 0 if not. 
  10465.  
  10466. int 
  10467.  
  10468.  
  10469. ΓòÉΓòÉΓòÉ 2.12.30.3. MMesaModel::getRecalcIterations() ΓòÉΓòÉΓòÉ
  10470.  
  10471. getRecalcIterations() [virtual] 
  10472.  
  10473. Returns the number of times the model should be recalculated per recalculation 
  10474. event. 
  10475.  
  10476. This is only meaningful if the recalculation type is set to rowRecalcOrder, 
  10477. columnRecalcOrder, or allowCircRecalcOrder (see "Recalculation order 
  10478. constants"). 
  10479.  
  10480. int 
  10481.  
  10482.  
  10483. ΓòÉΓòÉΓòÉ 2.12.30.4. MMesaModel::getRecalcType() ΓòÉΓòÉΓòÉ
  10484.  
  10485. getRecalcType() [virtual] 
  10486.  
  10487. Returns current recalculation type (see "Recalculation order constants"). 
  10488.  
  10489. int 
  10490.  
  10491.  
  10492. ΓòÉΓòÉΓòÉ 2.12.30.5. MMesaModel::recalc() ΓòÉΓòÉΓòÉ
  10493.  
  10494. recalc(const MAddress *, const MRange *, int) [virtual] 
  10495.  
  10496.       const MAddress *   Base address 
  10497.  
  10498.       const MRange *   Range to recalculate 
  10499.  
  10500.       int   Action to perform (see "Action ID constants") 
  10501.  
  10502.  Recalculates the given range, offset from the given cell if relative. 
  10503.  
  10504.  void 
  10505.  
  10506.  recalc(const MAddress *, int) [virtual] 
  10507.  
  10508.       const MAddress *   Cell to recalculate 
  10509.  
  10510.       int   Action to perform (see "Action ID constants") 
  10511.  
  10512.  Recalculates the given cell. 
  10513.  
  10514.  void 
  10515.  
  10516.  
  10517. ΓòÉΓòÉΓòÉ 2.12.30.6. MMesaModel::setAutoRecalc() ΓòÉΓòÉΓòÉ
  10518.  
  10519. setAutoRecalc(int, int, const MSelection *) [virtual] 
  10520.  
  10521.       int   New automatic recalculation setting (1 for on, 0 for off) 
  10522.  
  10523.       int   Action to perform (see "Action ID constants") 
  10524.  
  10525.       const MSelection *   Current selection (to be journaled for undo/redo 
  10526.       purposes) 
  10527.  
  10528.  Sets automatic recalculation for the current model on or off. 
  10529.  
  10530.  void 
  10531.  
  10532.  
  10533. ΓòÉΓòÉΓòÉ 2.12.30.7. MMesaModel::setHasChanged() ΓòÉΓòÉΓòÉ
  10534.  
  10535. setHasChanged(int) [virtual] 
  10536.  
  10537.       int   New changed status (1 for has changed, 0 for not) 
  10538.  
  10539.  Sets the model's changed status, which is used to determine if the model needs 
  10540.  to be recalculated. 
  10541.  
  10542.  void 
  10543.  
  10544.  
  10545. ΓòÉΓòÉΓòÉ 2.12.30.8. MMesaModel::setRecalcIterations() ΓòÉΓòÉΓòÉ
  10546.  
  10547. setRecalcIterations(int, int, const MSelection *) [virtual] 
  10548.  
  10549.       int   New number of iterations 
  10550.  
  10551.       int   Action to perform (see "Action ID constants") 
  10552.  
  10553.       const MSelection *   Current selection (to be journaled for undo/redo 
  10554.       purposes) 
  10555.  
  10556.  Sets the number of recalculation iterations for the current model. 
  10557.  
  10558.  void 
  10559.  
  10560.  
  10561. ΓòÉΓòÉΓòÉ 2.12.30.9. MMesaModel::setRecalcType() ΓòÉΓòÉΓòÉ
  10562.  
  10563. setRecalcType(int, int, const MSelection *) [virtual] 
  10564.  
  10565.       int   New recalculation order 
  10566.  
  10567.       int   Action to perform (see "Action ID constants") 
  10568.  
  10569.       const MSelection *   Current selection (to be journaled for undo/redo 
  10570.       purposes) 
  10571.  
  10572.  Sets the recalculation order of the current model (see "Recalculation order 
  10573.  constants"). 
  10574.  
  10575.  void 
  10576.  
  10577.  
  10578. ΓòÉΓòÉΓòÉ 2.12.31. Real-time feeds ΓòÉΓòÉΓòÉ
  10579.  
  10580. Open the Contents view and expand this section to see a list of methods. 
  10581.  
  10582.  
  10583. ΓòÉΓòÉΓòÉ 2.12.31.1. MMesaModel::getHasFeed() ΓòÉΓòÉΓòÉ
  10584.  
  10585. getHasFeed() [virtual] 
  10586.  
  10587. Returns 1 if the model contains a real-time data feed, 0 otherwise. 
  10588.  
  10589. int 
  10590.  
  10591.  
  10592. ΓòÉΓòÉΓòÉ 2.12.32. BLOBs ΓòÉΓòÉΓòÉ
  10593.  
  10594. Open the Contents view and expand this section to see a list of methods. 
  10595.  
  10596.  
  10597. ΓòÉΓòÉΓòÉ 2.12.32.1. MMesaModel::getBlobValue() ΓòÉΓòÉΓòÉ
  10598.  
  10599. getBlobValue(const char *name, int &len, void *&blob) [virtual] 
  10600.  
  10601.       const char *name   Name of BLOB 
  10602.  
  10603.       int &len   Storage location for BLOB size 
  10604.  
  10605.       void *&blob   Storage location for BLOB value 
  10606.  
  10607.  Searches the model's BLOB list for the given name; if found, stores the BLOB's 
  10608.  size and a pointer to the BLOB value. Returns 1 if BLOB is found; 0 otherwise. 
  10609.  
  10610.  int 
  10611.  
  10612.  
  10613. ΓòÉΓòÉΓòÉ 2.12.32.2. MMesaModel::setBlobValue() ΓòÉΓòÉΓòÉ
  10614.  
  10615. setBlobValue(const char *name, int len, const void *blob) [virtual] 
  10616.  
  10617.       const char *name   Name of BLOB 
  10618.  
  10619.       int len   BLOB size 
  10620.  
  10621.       void *blob   BLOB 
  10622.  
  10623.  Adds an entry to the model's BLOB list, allowing miscellaneous additional 
  10624.  information about a model to be added (e.g.; by Mesa AddIns) at run-time. 
  10625.  
  10626.  void 
  10627.  
  10628.  
  10629. ΓòÉΓòÉΓòÉ 2.12.33. Interest list ΓòÉΓòÉΓòÉ
  10630.  
  10631. Open the Contents view and expand this section to see a list of methods. 
  10632.  
  10633.  
  10634. ΓòÉΓòÉΓòÉ 2.12.33.1. MMesaModel::getInterestCount() ΓòÉΓòÉΓòÉ
  10635.  
  10636. getInterestCount() [virtual] 
  10637.  
  10638. Returns the number of other objects (models, windows, etc.) which have 
  10639. registered an interest in this model (see MInterest). 
  10640.  
  10641. int 
  10642.  
  10643.  
  10644. ΓòÉΓòÉΓòÉ 2.12.33.2. MMesaModel::registerInterest() ΓòÉΓòÉΓòÉ
  10645.  
  10646. registerInterest(MInterest *) [virtual] 
  10647.  
  10648.       MInterest *   Representation of some object's interest in the model 
  10649.  
  10650.  Adds the given interest marker to the model's interest list (see MInterest). 
  10651.  
  10652.  void 
  10653.  
  10654.  
  10655. ΓòÉΓòÉΓòÉ 2.12.33.3. MMesaModel::unregisterInterest() ΓòÉΓòÉΓòÉ
  10656.  
  10657. unregisterInterest(MInterest *) [virtual] 
  10658.  
  10659.       MInterest *   Interest marker for no-longer-interested object 
  10660.  
  10661.  Removes all interest markers from the same object as the given interest marker 
  10662.  from the model's interest list (see MInterest). If, as a consequence, the 
  10663.  model's interest list is left empty, the model is closed. 
  10664.  
  10665.  void 
  10666.  
  10667.  
  10668. ΓòÉΓòÉΓòÉ 2.12.34. DDE links ΓòÉΓòÉΓòÉ
  10669.  
  10670. Open the Contents view and expand this section to see a list of methods. 
  10671.  
  10672.  
  10673. ΓòÉΓòÉΓòÉ 2.12.34.1. MMesaModel::addDDEItem() ΓòÉΓòÉΓòÉ
  10674.  
  10675. addDDEItem(const char *, const char *, const char *, const char *, const char 
  10676. *, int, const MSelection *, MException *) [virtual] 
  10677.  
  10678.       const char *   Item name 
  10679.  
  10680.       const char *   Program 
  10681.  
  10682.       const char *   File name 
  10683.  
  10684.       const char *   Item tag within file 
  10685.  
  10686.       const char *   Target 
  10687.  
  10688.       int    Action to perform (see "Action ID constants") 
  10689.  
  10690.       const MSelection *   Current selection (to be journaled for undo/redo 
  10691.       purposes) 
  10692.  
  10693.       MException *   Storage location for errors 
  10694.  
  10695.  Adds an entry to the model's DDE link table with the given parameters. 
  10696.  
  10697.  void 
  10698.  
  10699.  
  10700. ΓòÉΓòÉΓòÉ 2.12.34.2. MMesaModel::deleteDDEItem() ΓòÉΓòÉΓòÉ
  10701.  
  10702. deleteDDEItem(int, int, const MSelection *, MException *) [virtual] 
  10703.  
  10704.       int   Item number 
  10705.  
  10706.       int action   Action to perform (see "Action ID constants") 
  10707.  
  10708.       const MSelection *   Current selection (to be journaled for undo/redo 
  10709.       purposes) 
  10710.  
  10711.       MException *   Storage location for errors 
  10712.  
  10713.  Removes the given item from the model's DDE list. 
  10714.  
  10715.  void 
  10716.  
  10717.  
  10718. ΓòÉΓòÉΓòÉ 2.12.34.3. MMesaModel::getDDEItem() ΓòÉΓòÉΓòÉ
  10719.  
  10720. getDDEItem(int i) [virtual] 
  10721.  
  10722.       int i   Index into DDE list 
  10723.  
  10724.  Returns the given entry in the model's DDE item list. 
  10725.  
  10726.  MDDEClientItem * 
  10727.  
  10728.  
  10729. ΓòÉΓòÉΓòÉ 2.12.34.4. MMesaModel::getNewDDEClientItem() ΓòÉΓòÉΓòÉ
  10730.  
  10731. getNewDDEClientItem() [virtual] 
  10732.  
  10733. Creates a new MDDEClientItem instance associated with the given model and 
  10734. returns a pointer to it (see Other Mesa-specific classes). 
  10735.  
  10736. MDDEClientItem * 
  10737.  
  10738.  
  10739. ΓòÉΓòÉΓòÉ 2.12.34.5. MMesaModel::getNumDDEItems() ΓòÉΓòÉΓòÉ
  10740.  
  10741. getNumDDEItems() [virtual] 
  10742.  
  10743. Returns the number of items in the model's DDE link table. 
  10744.  
  10745. int 
  10746.  
  10747.  
  10748. ΓòÉΓòÉΓòÉ 2.12.35. Generic stream I/O ΓòÉΓòÉΓòÉ
  10749.  
  10750. Open the Contents view and expand this section to see a list of methods. 
  10751.  
  10752.  
  10753. ΓòÉΓòÉΓòÉ 2.12.35.1. MMesaModel::loadFromStream() ΓòÉΓòÉΓòÉ
  10754.  
  10755. loadFromStream(MStream *ms, int, MException *me) [virtual] 
  10756.  
  10757.       MStream *ms   Input stream 
  10758.  
  10759.       int action   Action to perform (see "Action ID constants") 
  10760.  
  10761.       MException *   Storage location for errors 
  10762.  
  10763.  Reads the model's contents from the given stream. 
  10764.  
  10765.   void 
  10766.  
  10767.  
  10768. ΓòÉΓòÉΓòÉ 2.12.35.2. MMesaModel::saveToStream() ΓòÉΓòÉΓòÉ
  10769.  
  10770. saveToStream(MStream *ms, MException *me) [virtual] 
  10771.  
  10772.       MStream *ms   Output stream 
  10773.  
  10774.       MException *   Storage location for errors 
  10775.  
  10776.  Writes the model out to the given stream. 
  10777.  
  10778.   void 
  10779.  
  10780.  
  10781. ΓòÉΓòÉΓòÉ 2.12.36. File I/O ΓòÉΓòÉΓòÉ
  10782.  
  10783. Open the Contents view and expand this section to see a list of methods. 
  10784.  
  10785.  
  10786. ΓòÉΓòÉΓòÉ 2.12.36.1. MMesaModel::getFileType() ΓòÉΓòÉΓòÉ
  10787.  
  10788. getFileType() [virtual] 
  10789.  
  10790. Returns the file type identifier for the current model (see also 
  10791. MFileStream::setAttributes() ). 
  10792.  
  10793. int 
  10794.  
  10795.  
  10796. ΓòÉΓòÉΓòÉ 2.12.36.2. MMesaModel::getHasPath() ΓòÉΓòÉΓòÉ
  10797.  
  10798. getHasPath() [virtual] 
  10799.  
  10800. Returns 1 if the model includes a full pathname, 0 otherwise. This method is 
  10801. used at save time to determine whether the user should be prompted for a file 
  10802. name. 
  10803.  
  10804. int 
  10805.  
  10806.  
  10807. ΓòÉΓòÉΓòÉ 2.12.36.3. MMesaModel::getPassword() ΓòÉΓòÉΓòÉ
  10808.  
  10809. getPassword() [virtual] 
  10810.  
  10811. Returns an MPassword instance representing the current file password, if one 
  10812. exists (see Other Mesa-specific classes). 
  10813.  
  10814. MPassword * 
  10815.  
  10816.  
  10817. ΓòÉΓòÉΓòÉ 2.12.36.4. MMesaModel::getPathName() ΓòÉΓòÉΓòÉ
  10818.  
  10819. getPathName() [virtual] 
  10820.  
  10821. Return full pathname for the current sheet (e.g. C:\MESA\EXAMPLES\AUTOLOAD.M2). 
  10822.  
  10823. char * 
  10824.  
  10825.  
  10826. ΓòÉΓòÉΓòÉ 2.12.36.5. MMesaModel::loadFromPath() ΓòÉΓòÉΓòÉ
  10827.  
  10828. loadFromPath(int, MException *) [virtual] 
  10829.  
  10830.       int   Action to perform (see "Action ID constants") 
  10831.  
  10832.       MException *   Storage location for error 
  10833.  
  10834.  Reads the model's contents from the pathname stored with the model. 
  10835.  
  10836.  void 
  10837.  
  10838.  
  10839. ΓòÉΓòÉΓòÉ 2.12.36.6. MMesaModel::saveToPath() ΓòÉΓòÉΓòÉ
  10840.  
  10841. saveToPath(MException *) [virtual] 
  10842.  
  10843.       MException *   Storage location for errors 
  10844.  
  10845.  Saves the model to the stored pathname, if there is one, or to the file name 
  10846.  in the current directory, otherwise. Checks the file name extension and saves 
  10847.  in the appropriate format (e.g.; if the extension is WK1, exports the model in 
  10848.  WK1 format). 
  10849.  
  10850.  void 
  10851.  
  10852.  
  10853. ΓòÉΓòÉΓòÉ 2.12.36.7. MMesaModel::setFileType() ΓòÉΓòÉΓòÉ
  10854.  
  10855. setFileType(int) [virtual] 
  10856.  
  10857.       int   New file type 
  10858.  
  10859.  Sets the file type identifier for the current model (see also 
  10860.  MFileStream::setAttributes() ). 
  10861.  
  10862.  void 
  10863.  
  10864.  
  10865. ΓòÉΓòÉΓòÉ 2.12.36.8. MMesaModel::setHasPath() ΓòÉΓòÉΓòÉ
  10866.  
  10867. setHasPath(int) [virtual] 
  10868.  
  10869.       int   New path status (1 for has path defined, 0 for not) 
  10870.  
  10871.  Sets the model's path status, which is used to determine if the user should be 
  10872.  prompted for a path name at save time. 
  10873.  
  10874.  void 
  10875.  
  10876.  
  10877. ΓòÉΓòÉΓòÉ 2.12.36.9. MMesaModel::setPathName() ΓòÉΓòÉΓòÉ
  10878.  
  10879. setPathName(const char *, int) [virtual] 
  10880.  
  10881.       const char *   New path name 
  10882.  
  10883.       int   Action to perform (see "Action ID constants") 
  10884.  
  10885.  Sets the pathname of the model. 
  10886.  
  10887.  void 
  10888.  
  10889.  
  10890. ΓòÉΓòÉΓòÉ 2.12.37. Clipboard I/O ΓòÉΓòÉΓòÉ
  10891.  
  10892. Open the Contents view and expand this section to see a list of methods. 
  10893.  
  10894.  
  10895. ΓòÉΓòÉΓòÉ 2.12.37.1. MMesaModel::copy() ΓòÉΓòÉΓòÉ
  10896.  
  10897. copy(const MSelection *, int, MClipStream *) [virtual] 
  10898.  
  10899.       const MSelection *   Selection to copy 
  10900.  
  10901.       int   Copy type (unused) 
  10902.  
  10903.       MClipStream *   Output stream to clipboard 
  10904.  
  10905.  Copies selection to the output stream (see MClipStream) (see also 
  10906.  MMesaModel::copyCells() ). 
  10907.  
  10908.  void 
  10909.  
  10910.  
  10911. ΓòÉΓòÉΓòÉ 2.12.37.2. MMesaModel::cut() ΓòÉΓòÉΓòÉ
  10912.  
  10913. cut(const MSelection *, int, MClipStream *, const MSelection *, int, MException 
  10914. *) [virtual] 
  10915.  
  10916.       const MSelection *   Selection to cut to the clipboard 
  10917.  
  10918.       int    Copy type (unused) 
  10919.  
  10920.       MClipStream *   Output stream to clipboard 
  10921.  
  10922.       const MSelection *   Current selection (to be journaled for undo/redo 
  10923.       purposes) 
  10924.  
  10925.       int   Action to perform (see "Action ID constants") 
  10926.  
  10927.       MException *   Storage location for errors 
  10928.  
  10929.  Copies the given selection to the clipboard, then clears the selection from 
  10930.  the model. 
  10931.  
  10932.  void 
  10933.  
  10934.  
  10935. ΓòÉΓòÉΓòÉ 2.12.37.3. MMesaModel::paste() ΓòÉΓòÉΓòÉ
  10936.  
  10937. paste(const MSelection *, int, MClipStream *, const MSelection *, int, 
  10938. MException *) [virtual] 
  10939.  
  10940.       const MSelection *   Selection to paste into 
  10941.  
  10942.       int   Type of paste (see "Paste special constants"). 
  10943.  
  10944.       MClipStream *   Input stream 
  10945.  
  10946.       const MSelection *   Current selection (to be journaled for undo/redo 
  10947.       purposes) 
  10948.  
  10949.       int   Action to perform (see "Action ID constants") 
  10950.  
  10951.       MException *   Storage location for errors 
  10952.  
  10953.  Reads values from the clipboard into the given selection. 
  10954.  
  10955.  void 
  10956.  
  10957.  
  10958. ΓòÉΓòÉΓòÉ 2.12.38. Printing ΓòÉΓòÉΓòÉ
  10959.  
  10960. Open the Contents view and expand this section to see a list of methods. 
  10961.  
  10962.  
  10963. ΓòÉΓòÉΓòÉ 2.12.38.1. MMesaModel::createPrintInfo() ΓòÉΓòÉΓòÉ
  10964.  
  10965. createPrintInfo(const MRect *ire, const MPrintHead *ph) [virtual] 
  10966.  
  10967.       const MRect *ire   Page rectangle 
  10968.  
  10969.       const MPrintHead *ph   Print job header information 
  10970.  
  10971.  Retrieves the information needed to do a print job based on the model: 
  10972.  
  10973.  the given page rectangle; 
  10974.  
  10975.  the headers from the given print header (see MPrintHead); 
  10976.  
  10977.  the range from the given print header if one is defined, or the extent of the 
  10978.  first layer otherwise (see MMesaModel::getExtents()); 
  10979.  
  10980.  the current time; 
  10981.  
  10982.  the scaling-and-rotation transformation matrix, based on the print orientation 
  10983.  and scaling info from the print header, the size of the page rectangle, and 
  10984.  the size of the range being printed; 
  10985.  
  10986.  the number of pages in the print job, based on size of area being drawn, size 
  10987.  of page area, page breaks, etc.; 
  10988.  
  10989.  the order in which to print those pages (over-then-down vs. down-then-over); 
  10990.  
  10991.  ...and returns an MPrintInfo instance including that information (see Other 
  10992.  Mesa-specific classes). 
  10993.  
  10994.  MPrintInfo * 
  10995.  
  10996.  
  10997. ΓòÉΓòÉΓòÉ 2.12.38.2. MMesaModel::doPage() ΓòÉΓòÉΓòÉ
  10998.  
  10999. doPage(MDraw *, const MRect *, const MAddress *, const MAddress *, const 
  11000. MPrintHead *, int thisPage, int totPage, double time) [virtual] 
  11001.  
  11002.       MDraw *   Handle to the drawing space to print onto 
  11003.  
  11004.       const MRect *   Page rectangle 
  11005.  
  11006.       const MAddress *   Upper-left cell of range to be printed on this page 
  11007.  
  11008.       const MAddress *   Lower-right cell of range to be printed on this page 
  11009.  
  11010.       const MPrintHead *   Header information for the print job 
  11011.  
  11012.       int thisPage   Which page of the print job is this? 
  11013.  
  11014.       int totPage   How many pages are there in the print job? 
  11015.  
  11016.       double time   What is the print time? 
  11017.  
  11018.  Prints the given range onto the given drawing space, with all the associated 
  11019.  print-job info. 
  11020.  
  11021.  void 
  11022.  
  11023.  
  11024. ΓòÉΓòÉΓòÉ 2.12.38.3. MMesaModel::getDefaultPrintHead() ΓòÉΓòÉΓòÉ
  11025.  
  11026. getDefaultPrintHead(MPrintHead *) [virtual] 
  11027.  
  11028.       MPrintHead *   Storage location 
  11029.  
  11030.  Stores a pointer to the default print-job header for the current model. 
  11031.  
  11032.  void 
  11033.  
  11034.  
  11035. ΓòÉΓòÉΓòÉ 2.12.38.4. MMesaModel::print() ΓòÉΓòÉΓòÉ
  11036.  
  11037. print(MDraw *, const MRect *, const MPrintHead *, int, int, MException *) 
  11038. [virtual] 
  11039.  
  11040.       MDraw *   Handle to drawing space for printing 
  11041.  
  11042.       const MRect *   Page rectangle 
  11043.  
  11044.       const MPrintHead *   Print-job header 
  11045.  
  11046.       int   Start page 
  11047.  
  11048.       int   End page 
  11049.  
  11050.       MException *   Storage location for errors 
  11051.  
  11052.  Prints the current model to the given drawing space, using the given print-job 
  11053.  headers, in a separate thread. 
  11054.  
  11055.  void 
  11056.  
  11057.  
  11058. ΓòÉΓòÉΓòÉ 2.12.38.5. MMesaModel::print_nonThreaded() ΓòÉΓòÉΓòÉ
  11059.  
  11060. print_nonThreaded(MDraw *, const MRect *, const MPrintHead *, int start, int 
  11061. end, MException *) [virtual] 
  11062.  
  11063.       MDraw *   Handle to drawing space for printing 
  11064.  
  11065.       const MRect *   Page rectangle 
  11066.  
  11067.       const MPrintHead *   Print-job header 
  11068.  
  11069.       int   Start page 
  11070.  
  11071.       int   End page 
  11072.  
  11073.       MException *   Storage location for errors 
  11074.  
  11075.  Prints the current model to the given drawing space, using the given print-job 
  11076.  headers, in the current thread. 
  11077.  
  11078.  void 
  11079.  
  11080.  
  11081. ΓòÉΓòÉΓòÉ 2.12.38.6. MMesaModel::setDefaultPrintHead() ΓòÉΓòÉΓòÉ
  11082.  
  11083. setDefaultPrintHead(const MPrintHead *, int, const MSelection *) [virtual] 
  11084.  
  11085.       const MPrintHead *   New print-job header 
  11086.  
  11087.       int   Action to perform (see "Action ID constants") 
  11088.  
  11089.       const MSelection *   Current selection (to be journaled for undo/redo 
  11090.       purposes) 
  11091.  
  11092.  Sets the default print-job header for the model. 
  11093.  
  11094.  void 
  11095.  
  11096.  
  11097. ΓòÉΓòÉΓòÉ 2.12.39. Undo and redo lists ΓòÉΓòÉΓòÉ
  11098.  
  11099. Open the Contents view and expand this section to see a list of methods. 
  11100.  
  11101.  
  11102. ΓòÉΓòÉΓòÉ 2.12.39.1. MMesaModel::getRedoCnt() ΓòÉΓòÉΓòÉ
  11103.  
  11104. getRedoCnt() [virtual] 
  11105.  
  11106. Returns number of operations that are currently journaled and can be redone. 
  11107.  
  11108. int 
  11109.  
  11110.  
  11111. ΓòÉΓòÉΓòÉ 2.12.39.2. MMesaModel::getUndoCnt() ΓòÉΓòÉΓòÉ
  11112.  
  11113. getUndoCnt() [virtual] 
  11114.  
  11115. Returns number of operations currently maintained in the model's undo list. 
  11116.  
  11117. int 
  11118.  
  11119.  
  11120. ΓòÉΓòÉΓòÉ 2.12.39.3. MMesaModel::getUndoMax() ΓòÉΓòÉΓòÉ
  11121.  
  11122. getUndoMax() [virtual] 
  11123.  
  11124. Re   turns maximum number of operations that can be undone. 
  11125.  
  11126. int 
  11127.  
  11128.  
  11129. ΓòÉΓòÉΓòÉ 2.12.39.4. MMesaModel::redoLastCommand() ΓòÉΓòÉΓòÉ
  11130.  
  11131. redoLastCommand(const MSelection *, int, MSelection *) [virtual] 
  11132.  
  11133.       const MSelection *   Current selection (to be journaled for undo/redo 
  11134.       purposes) 
  11135.  
  11136.       int   Action to perform (see "Action ID constants") 
  11137.  
  11138.       MSelection *   Storage location for new selection (read from the redo 
  11139.       list) 
  11140.  
  11141.  Finds the last item in the redo list, restores the model to the state before 
  11142.  that command was undone (including retrieving the previous selection), and 
  11143.  removes that command from the redo list. 
  11144.  
  11145.  Returns 1 if an item in the redo list is actually redone, 0 otherwise. 
  11146.  
  11147.  int 
  11148.  
  11149.  
  11150. ΓòÉΓòÉΓòÉ 2.12.39.5. MMesaModel::setUndoMax() ΓòÉΓòÉΓòÉ
  11151.  
  11152. setUndoMax(int) [virtual] 
  11153.  
  11154.       int   New maximum undo setting 
  11155.  
  11156.  Sets the maximum size of the model's undo and redo lists. 
  11157.  
  11158.  void 
  11159.  
  11160.  
  11161. ΓòÉΓòÉΓòÉ 2.12.39.6. MMesaModel::undoLastCommand() ΓòÉΓòÉΓòÉ
  11162.  
  11163. undoLastCommand(const MSelection *, int, MSelection *) [virtual] 
  11164.  
  11165.       const MSelection *   Current selection 
  11166.  
  11167.       int   Action to perform (see "Action ID constants") 
  11168.  
  11169.       MSelection *   Storage location for new selection (read from the undo 
  11170.       list) 
  11171.  
  11172.  Undoes the last command performed in the model and adds it to the redo list. 
  11173.  Stores the selection associated with that command. 
  11174.  
  11175.  Returns 1 if the command is actually undone, 0 otherwise. 
  11176.  
  11177.  int 
  11178.  
  11179.  
  11180. ΓòÉΓòÉΓòÉ 2.13. MMesaView ΓòÉΓòÉΓòÉ
  11181.  
  11182. mesaview.h is the source file for this class. 
  11183.  
  11184. This class inherits from MView 
  11185.  
  11186. Handles the "spreadsheet" part of a single file window, including scrollbars 
  11187. and the sheet display. 
  11188.  
  11189. An MMesaView instance does not handle the actual drawing of a layer of data 
  11190. (see MSheetView). It does, however, keep track of what part of the layer is 
  11191. being drawn and of the relative sizes and positions of the layer and the 
  11192. scrollbars. For example, MMesaView::arrangeViews() arranges the scroll bars and 
  11193. the sheet view correctly on the screen, and is generally called whenever the 
  11194. file window is resized. 
  11195.  
  11196. Each MMesaView instance keeps track of the views that compose it (the 
  11197. MSheetView and the two scrollbars) and the model it is displaying. It also 
  11198. keeps track of the current context menu and the "superview" window, just like 
  11199. any other MView subclass (see MView). 
  11200.  
  11201.  
  11202. ΓòÉΓòÉΓòÉ 2.13.1. Creating and destroying an MMesaView instance ΓòÉΓòÉΓòÉ
  11203.  
  11204. Open the Contents view and expand this section to see a list of methods. 
  11205.  
  11206.  
  11207. ΓòÉΓòÉΓòÉ 2.13.1.1. MMesaView::MMesaView() ΓòÉΓòÉΓòÉ
  11208.  
  11209. MMesaView(HWND, MMesaModel *) 
  11210.  
  11211.       HWND   Handle to the parent window 
  11212.  
  11213.       MMesaModel *   Associated model 
  11214.  
  11215.   Creates a new MMesaView instance with the values passed in. 
  11216.  
  11217.   void 
  11218.  
  11219.  MMesaView(MWindow *, MMesaModel *) 
  11220.  
  11221.       MWindow *   Handle to the parent window 
  11222.  
  11223.       MMesaModel *   Associated model 
  11224.  
  11225.  Creates a new MMesaView instance with the values passed in. 
  11226.  
  11227.  void 
  11228.  
  11229.  
  11230. ΓòÉΓòÉΓòÉ 2.13.1.2. MMesaView::~MMesaView() ΓòÉΓòÉΓòÉ
  11231.  
  11232. ~MMesaView() [virtual] 
  11233.  
  11234. Destroys the instance and frees all allocated resources. 
  11235.  
  11236.  void 
  11237.  
  11238.  
  11239. ΓòÉΓòÉΓòÉ 2.13.1.3. MMesaView::aboutToDestroy() ΓòÉΓòÉΓòÉ
  11240.  
  11241. aboutToDestroy() [virtual] 
  11242.  
  11243. Unregisters the Mesa view's interest in its model (see 
  11244. MMesaModel::unregisterInterest()), passes through to the sheet view and 
  11245. scrollbars, and deletes itself. 
  11246.  
  11247. void 
  11248.  
  11249.  
  11250. ΓòÉΓòÉΓòÉ 2.13.1.4. MMesaView::cleanUp() ΓòÉΓòÉΓòÉ
  11251.  
  11252. cleanUp() [virtual] 
  11253.  
  11254. Unregisters the Mesa view's interest in its model (see 
  11255. MMesaModel::unregisterInterest()), and passes through to the sheet view and 
  11256. scrollbars. 
  11257.  
  11258. void 
  11259.  
  11260.  
  11261. ΓòÉΓòÉΓòÉ 2.13.2. Handling the views within a Mesa view ΓòÉΓòÉΓòÉ
  11262.  
  11263. Open the Contents view and expand this section to see a list of methods. 
  11264.  
  11265.  
  11266. ΓòÉΓòÉΓòÉ 2.13.2.1. MMesaView::aboutToChangeToLayer() ΓòÉΓòÉΓòÉ
  11267.  
  11268. aboutToChangeToLayer(int) [virtual] 
  11269.  
  11270.       int   New layer 
  11271.  
  11272.  Alerts other items, such as the scroll bars, that a new layer is going to be 
  11273.  displayed. This allows those items to resize or reinitialize themselves as 
  11274.  needed. 
  11275.  
  11276.  void 
  11277.  
  11278.  
  11279. ΓòÉΓòÉΓòÉ 2.13.2.2. MMesaView::arrangeViews() ΓòÉΓòÉΓòÉ
  11280.  
  11281. arrangeViews() [virtual] 
  11282.  
  11283. Arranges the sheet view and the scroll bars correctly, based on their current 
  11284. sizes and the size of the display window. 
  11285.  
  11286. void 
  11287.  
  11288.  
  11289. ΓòÉΓòÉΓòÉ 2.13.2.3. MMesaView::changedSize() ΓòÉΓòÉΓòÉ
  11290.  
  11291. changedSize(HWND, MChange *) [virtual] 
  11292.  
  11293.       HWND   Unused 
  11294.  
  11295.       MChange *   Unused 
  11296.  
  11297.  Passes through to MSheetView::changedSize() and to MMesaView::arrangeViews(), 
  11298.  and updates the sheet view. 
  11299.  
  11300.  Always returns 0. 
  11301.  
  11302.  MRESULT 
  11303.  
  11304.  
  11305. ΓòÉΓòÉΓòÉ 2.13.2.4. MMesaView::getSheetView() ΓòÉΓòÉΓòÉ
  11306.  
  11307. getSheetView() [virtual] 
  11308.  
  11309. Returns pointer to the sheet view associated with the Mesa view. 
  11310.  
  11311.  MSheetView * 
  11312.  
  11313.  
  11314. ΓòÉΓòÉΓòÉ 2.13.2.5. MMesaView::setUp() ΓòÉΓòÉΓòÉ
  11315.  
  11316. setUp(const MRect *, int = 0) [virtual] 
  11317.  
  11318.       const MRect *   Size and position of the new window 
  11319.  
  11320.       int   Style flags. Defaults to 0. 
  11321.  
  11322.  Creates an OS/2 window with the given coordinates. Creates sheet view and 
  11323.  scrollbars and arranges them properly within that window, and registers an 
  11324.  interest in the associated model (see MInterest). 
  11325.  
  11326.  void 
  11327.  
  11328.  
  11329. ΓòÉΓòÉΓòÉ 2.13.2.6. MMesaView::updateScrollers() ΓòÉΓòÉΓòÉ
  11330.  
  11331. updateScrollers() [virtual] 
  11332.  
  11333. Updates the scroll bars for the Mesa view based on the sheet view size and 
  11334. position. 
  11335.  
  11336. void 
  11337.  
  11338.  
  11339. ΓòÉΓòÉΓòÉ 2.13.3. Handling the associated model ΓòÉΓòÉΓòÉ
  11340.  
  11341. Open the Contents view and expand this section to see a list of methods. 
  11342.  
  11343.  
  11344. ΓòÉΓòÉΓòÉ 2.13.3.1. MMesaView::doesFrameExist() ΓòÉΓòÉΓòÉ
  11345.  
  11346. doesFrameExist(const char *) [virtual] 
  11347.  
  11348.       const char*   Frame name 
  11349.  
  11350.  Returns 1 if the named frame exists in the frame list for the model associated 
  11351.  with the Mesa view; 0 otherwise. 
  11352.  
  11353.  int 
  11354.  
  11355.  
  11356. ΓòÉΓòÉΓòÉ 2.13.3.2. MMesaView::getDirectory() ΓòÉΓòÉΓòÉ
  11357.  
  11358. getDirectory() [virtual] 
  11359.  
  11360. Returns path name (not file name) of the model associated with the Mesa view. 
  11361. (Compare with MMesaModel::getPathName().) 
  11362.  
  11363. char * 
  11364.  
  11365.  
  11366. ΓòÉΓòÉΓòÉ 2.13.3.3. MMesaView::getFrameName() ΓòÉΓòÉΓòÉ
  11367.  
  11368. getFrameName(int num) [virtual] 
  11369.  
  11370.       int num   Index into model's frame list 
  11371.  
  11372.  Returns the name of the given item in the frame list of the model associated 
  11373.  with the Mesa view. 
  11374.  
  11375.  char * 
  11376.  
  11377.  
  11378. ΓòÉΓòÉΓòÉ 2.13.3.4. MMesaView::getModel() ΓòÉΓòÉΓòÉ
  11379.  
  11380. getModel() [virtual] 
  11381.  
  11382. Returns a pointer to the model associated with the Mesa view. 
  11383.  
  11384. MMesaModel * 
  11385.  
  11386.  
  11387. ΓòÉΓòÉΓòÉ 2.13.3.5. MMesaView::newShape() ΓòÉΓòÉΓòÉ
  11388.  
  11389. newShape(int, const char *, int, int, int, int, int, int) [virtual] 
  11390.  
  11391.       int   Frame type (see "Shape and imported graphic type constants") 
  11392.  
  11393.       const char *   Anchor cell address (in string form) 
  11394.  
  11395.       int    X- offset from the upper-left of anchor cell for frame position 
  11396.  
  11397.       int    Y- offset from the upper-left of anchor cell for frame position 
  11398.  
  11399.       int   New frame width 
  11400.  
  11401.       int   New frame height 
  11402.  
  11403.       int   Line width for shape 
  11404.  
  11405.       int   Line type (arrowheads, etc.) for line shapes 
  11406.  
  11407.  Passes through to MSheetView::newShape(), which creates a new shape of the 
  11408.  given type at the given position with the given parameters. 
  11409.  
  11410.  void 
  11411.  
  11412.  
  11413. ΓòÉΓòÉΓòÉ 2.13.4. Handling the application's edit view ΓòÉΓòÉΓòÉ
  11414.  
  11415. Open the Contents view and expand this section to see a list of methods. 
  11416.  
  11417.  
  11418. ΓòÉΓòÉΓòÉ 2.13.4.1. MMesaView::copyFromEditView() ΓòÉΓòÉΓòÉ
  11419.  
  11420. copyFromEditView(MClipStream *) [virtual] 
  11421.  
  11422.       MClipStream *   Output stream 
  11423.  
  11424.  Passes through to MEditView::copyToClipboard(), copying the current selection 
  11425.  within the edit view (if one exists) to the clipboard. 
  11426.  
  11427.  void 
  11428.  
  11429.  
  11430. ΓòÉΓòÉΓòÉ 2.13.4.2. MMesaView::cutFromEditView() ΓòÉΓòÉΓòÉ
  11431.  
  11432. cutFromEditView(MClipStream *) [virtual] 
  11433.  
  11434.       MClipStream *   Output stream 
  11435.  
  11436.  Passes through to MEditView::copyToClipboard(), copying the current selection 
  11437.  within the edit view to the clipboard, and to MEditView::removeSelection(), 
  11438.  removing that selection from the edit view, if one exists. 
  11439.  
  11440.  void 
  11441.  
  11442.  
  11443. ΓòÉΓòÉΓòÉ 2.13.4.3. MMesaView::getEditView() ΓòÉΓòÉΓòÉ
  11444.  
  11445. getEditView() [virtual] 
  11446.  
  11447. Passes through to MGController::getEditView()=0. 
  11448.  
  11449. Returns pointer to the edit view associated with the application, if one 
  11450. exists. 
  11451.  
  11452. MEditView * 
  11453.  
  11454.  
  11455. ΓòÉΓòÉΓòÉ 2.13.4.4. MMesaView::isEditing() ΓòÉΓòÉΓòÉ
  11456.  
  11457. isEditing() [virtual] 
  11458.  
  11459. Passes through to MGController::isEditing()=0. 
  11460.  
  11461. Returns 1 if currently editing, 0 otherwise. 
  11462.  
  11463. int 
  11464.  
  11465.  
  11466. ΓòÉΓòÉΓòÉ 2.13.4.5. MMesaView::isEditingFormula() ΓòÉΓòÉΓòÉ
  11467.  
  11468. isEditingFormula() [virtual] 
  11469.  
  11470. Passes through to MGController::isEditingFormula()=0. 
  11471.  
  11472. Returns 1 if currently editing a formula, 0 otherwise. 
  11473.  
  11474. int 
  11475.  
  11476.  
  11477. ΓòÉΓòÉΓòÉ 2.13.4.6. MMesaView::pasteIntoEditView() ΓòÉΓòÉΓòÉ
  11478.  
  11479. pasteIntoEditView(MClipStream *) [virtual] 
  11480.  
  11481.       MClipStream *   Input stream 
  11482.  
  11483.  Passes through to MEditView::copyToClipboard(), which replaces the current 
  11484.  selection in the edit view (if one exists) with the contents of the clipboard. 
  11485.  
  11486.  void 
  11487.  
  11488.  
  11489. ΓòÉΓòÉΓòÉ 2.13.4.7. MMesaView::removeEdit() ΓòÉΓòÉΓòÉ
  11490.  
  11491. removeEdit() [virtual] 
  11492.  
  11493. Pass-through to MGController::removeEdit()=0, which deletes the edit viewif one 
  11494. exists. 
  11495.  
  11496. void 
  11497.  
  11498.  
  11499. ΓòÉΓòÉΓòÉ 2.13.4.8. MMesaView::resizeFormulaView() ΓòÉΓòÉΓòÉ
  11500.  
  11501. resizeFormulaView() [virtual] 
  11502.  
  11503. Passes through to MGController::resizeFormulaView()=0, which resizes the 
  11504. formula view if one exists. 
  11505.  
  11506. void 
  11507.  
  11508.  
  11509. ΓòÉΓòÉΓòÉ 2.13.4.9. MMesaView::updateFormulaView() ΓòÉΓòÉΓòÉ
  11510.  
  11511. updateFormulaView() [virtual] 
  11512.  
  11513. Passes through to MGController::updateFormulaView()=0, which updates the 
  11514. formula view if one exists. 
  11515.  
  11516. void 
  11517.  
  11518.  
  11519. ΓòÉΓòÉΓòÉ 2.13.5. Handling commands and user input ΓòÉΓòÉΓòÉ
  11520.  
  11521. Open the Contents view and expand this section to see a list of methods. 
  11522.  
  11523.  
  11524. ΓòÉΓòÉΓòÉ 2.13.5.1. MMesaView::canEditContents() ΓòÉΓòÉΓòÉ
  11525.  
  11526. canEditContents() [virtual] 
  11527.  
  11528. Passes through to MSheetView::canEditContents(). 
  11529.  
  11530. Returns 1 if the contents of the sheet can be edited, 0 otherwise. 
  11531.  
  11532. int 
  11533.  
  11534.  
  11535. ΓòÉΓòÉΓòÉ 2.13.5.2. MMesaView::canExecute() ΓòÉΓòÉΓòÉ
  11536.  
  11537. canExecute(int, int &) [virtual] 
  11538.  
  11539.       int   Command ID 
  11540.  
  11541.       int &   Unused 
  11542.  
  11543.  Determines whether the given command can be executed within the Mesa view at 
  11544.  this moment. For example, if there is nothing on the clipboard, then "Paste" 
  11545.  won't work. 
  11546.  
  11547.  Returns 1 if the command can be executed, 0 otherwise. 
  11548.  
  11549.  int 
  11550.  
  11551.  
  11552. ΓòÉΓòÉΓòÉ 2.13.5.3. MMesaView::handleKey() ΓòÉΓòÉΓòÉ
  11553.  
  11554. handleKey(int, int) [virtual] 
  11555.  
  11556.       int   Character entered 
  11557.  
  11558.       int   Key flags set (Ctrl, Alt, etc.) 
  11559.  
  11560.  Passes through to MGController::handleKey()=0. 
  11561.  
  11562.  Returns 0 if the key was handled, 1 otherwise. 
  11563.  
  11564.  int 
  11565.  
  11566.  
  11567. ΓòÉΓòÉΓòÉ 2.13.5.4. MMesaView::winCommand() ΓòÉΓòÉΓòÉ
  11568.  
  11569. winCommand(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  11570.  
  11571.       HWND   Window handle
  11572.  
  11573.       ULONG   Message 
  11574.  
  11575.       MPARAM   Parameter 1 
  11576.  
  11577.       MPARAM   Parameter 2 
  11578.  
  11579.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  11580.       passed to default window handler.) 
  11581.  
  11582.  Process the command. See mesaview.cpp for the complete list. 
  11583.  
  11584.  MRESULT 
  11585.  
  11586.  
  11587. ΓòÉΓòÉΓòÉ 2.13.5.5. MMesaView::winChar() ΓòÉΓòÉΓòÉ
  11588.  
  11589. winChar(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  11590.  
  11591.       HWND   Window handle
  11592.  
  11593.       ULONG   Command 
  11594.  
  11595.       MPARAM   Parameter 1 
  11596.  
  11597.       MPARAM   Parameter 2 
  11598.  
  11599.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  11600.       passed to default window handler.) 
  11601.  
  11602.  If there is a sheet view associated with the Mesa view, passes through to the 
  11603.  sheet view's winChar method, which handles keyboard processing for the sheet. 
  11604.  
  11605.  Returns 1 if the keystroke was handled, 0 otherwise. 
  11606.  
  11607.  MRESULT 
  11608.  
  11609.  
  11610. ΓòÉΓòÉΓòÉ 2.13.6. Scrolling the sheet ΓòÉΓòÉΓòÉ
  11611.  
  11612. Open the Contents view and expand this section to see a list of methods. 
  11613.  
  11614.  
  11615. ΓòÉΓòÉΓòÉ 2.13.6.1. MMesaView::scrollFrom() ΓòÉΓòÉΓòÉ
  11616.  
  11617. scrollFrom(int, int) [virtual] 
  11618.  
  11619.       int   Row 
  11620.  
  11621.       int   Column 
  11622.  
  11623.  Passes through to MSheetView::scrollFrom(), which scrolls the sheet so that 
  11624.  the cell at the given row and column appears at the upper left of the cell, 
  11625.  then redisplays as needed. 
  11626.  
  11627.  void 
  11628.  
  11629.  
  11630. ΓòÉΓòÉΓòÉ 2.13.6.2. MMesaView::scrollToVisible() ΓòÉΓòÉΓòÉ
  11631.  
  11632. scrollToVisible(const MAddress *, int=0) [virtual] 
  11633.  
  11634.       const MAddress *   Address to display 
  11635.  
  11636.       int   Actually scroll? 1 to scroll, 0 to not scroll. Default is 0. 
  11637.  
  11638.  Scroll to make a given address visible. 
  11639.  
  11640.  Passes through to MSheetView::scrollToVisible(), determining the necessary 
  11641.  offset to make the given cell appear in the sheet view (and scrolling if 
  11642.  appropriate). 
  11643.  
  11644.  Returns 1 if there is an offset necessary to display the given cell, 0 
  11645.  otherwise. (In other words, returns 0 if the given cell is already being 
  11646.  displayed.) 
  11647.  
  11648.  int 
  11649.  
  11650.  
  11651. ΓòÉΓòÉΓòÉ 2.13.6.3. MMesaView::winHScroll() ΓòÉΓòÉΓòÉ
  11652.  
  11653. winHScroll(HWND, ULONG, MPARAM, MPARAM, int &handled) [virtual] 
  11654.  
  11655.             HWND   Unused
  11656.  
  11657.       ULONG   Unused 
  11658.  
  11659.       MPARAM   Unused 
  11660.  
  11661.       MPARAM   Scroll type (see "Scrolling constants") 
  11662.  
  11663.       int &handled   Was it processed? 1 for yes, 0 for no. (If no, then it 
  11664.       will be passed to default window handler.) 
  11665.  
  11666.  Scrolls the appropriate number of pixels horizontally, calculates the new 
  11667.  upper-left cell being displayed in the sheet view, and sets handled to 1. 
  11668.  
  11669.  Always returns 1. 
  11670.  
  11671.  MRESULT 
  11672.  
  11673.  
  11674. ΓòÉΓòÉΓòÉ 2.13.6.4. MMesaView::winSize() ΓòÉΓòÉΓòÉ
  11675.  
  11676. winSize(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  11677.  
  11678.             HWND   Unused
  11679.  
  11680.       ULONG   Unused 
  11681.  
  11682.       MPARAM   Unused 
  11683.  
  11684.       MPARAM   Unused 
  11685.  
  11686.       int &   Unused 
  11687.  
  11688.  Passes through to MMesaView::arrangeViews(). 
  11689.  
  11690.  Always returns 0. 
  11691.  
  11692.  MRESULT 
  11693.  
  11694.  
  11695. ΓòÉΓòÉΓòÉ 2.13.6.5. MMesaView::winUpdateSheet() ΓòÉΓòÉΓòÉ
  11696.  
  11697. winUpdateSheet(MChange *) [virtual] 
  11698.  
  11699.       MChange *   MChange list of cells that have been affected. 
  11700.  
  11701.  If the currently displayed page is a layer, updates the region of the layer 
  11702.  that is currently displayed in the sheet view, including frames and other 
  11703.  displayed objects as appropriate. 
  11704.  
  11705.  Always returns 0. 
  11706.  
  11707.  MRESULT 
  11708.  
  11709.  
  11710. ΓòÉΓòÉΓòÉ 2.13.6.6. MMesaView::winVScroll() ΓòÉΓòÉΓòÉ
  11711.  
  11712. winVScroll(HWND, ULONG, MPARAM, MPARAM, int &handled) [virtual] 
  11713.  
  11714.             HWND   Unused
  11715.  
  11716.       ULONG   Unused 
  11717.  
  11718.       MPARAM   Unused 
  11719.  
  11720.       MPARAM   Scroll type (see "Scrolling constants") 
  11721.  
  11722.       int &handled   Was it processed? 1 for yes, 0 for no. (If no, then it 
  11723.       will be passed to default window handler.) 
  11724.  
  11725.  Scrolls the appropriate number of pixels vertically, calculates the new 
  11726.  upper-left cell being displayed in the sheet view, and sets handled to 1. 
  11727.  
  11728.  Always returns 1. 
  11729.  
  11730.  MRESULT 
  11731.  
  11732.  
  11733. ΓòÉΓòÉΓòÉ 2.13.7. Handling sheet magnification ΓòÉΓòÉΓòÉ
  11734.  
  11735. Open the Contents view and expand this section to see a list of methods. 
  11736.  
  11737.  
  11738. ΓòÉΓòÉΓòÉ 2.13.7.1. MMesaView::getViewScale() ΓòÉΓòÉΓòÉ
  11739.  
  11740. getViewScale() [virtual] 
  11741.  
  11742. Passes through to MSheetView::getViewScale(). 
  11743.  
  11744. Returns the magnification of the sheet view (1.00 = 100%). 
  11745.  
  11746. float 
  11747.  
  11748.  
  11749. ΓòÉΓòÉΓòÉ 2.13.7.2. MMesaView::setViewScale() ΓòÉΓòÉΓòÉ
  11750.  
  11751. setViewScale(float s) [virtual] 
  11752.  
  11753.       float s   New scale for sheet 
  11754.  
  11755.  Passes through to MSheetView::setViewScale(), which sets the magnification of 
  11756.  the sheet view (1.00 = 100%). 
  11757.  
  11758.  void 
  11759.  
  11760.  
  11761. ΓòÉΓòÉΓòÉ 2.13.8. Retrieving the current selection ΓòÉΓòÉΓòÉ
  11762.  
  11763. Open the Contents view and expand this section to see a list of methods. 
  11764.  
  11765.  
  11766. ΓòÉΓòÉΓòÉ 2.13.8.1. MMesaView::getCurAdPtr() ΓòÉΓòÉΓòÉ
  11767.  
  11768. getCurAdPtr() [virtual] 
  11769.  
  11770. Passes through to MSheetView::getCurAdPtr(). 
  11771.  
  11772. Returns pointer to the current selection. 
  11773.  
  11774. const MAddress * 
  11775.  
  11776.  
  11777. ΓòÉΓòÉΓòÉ 2.13.8.2. MMesaView::getCurLayer() ΓòÉΓòÉΓòÉ
  11778.  
  11779. getCurLayer() [virtual] 
  11780.  
  11781. Passes through to MSheetView::getCurLayer(). 
  11782.  
  11783. Returns current layer number. 
  11784.  
  11785. int 
  11786.  
  11787.  
  11788. ΓòÉΓòÉΓòÉ 2.13.8.3. MMesaView::getCurSelection() ΓòÉΓòÉΓòÉ
  11789.  
  11790. getCurSelection() [virtual] 
  11791.  
  11792. Passes through to MSheetView::getCurSelection(). 
  11793.  
  11794. Returns pointer to the current selection. 
  11795.  
  11796. const MSelection * 
  11797.  
  11798.  
  11799. ΓòÉΓòÉΓòÉ 2.13.8.4. MMesaView::getLayerName() ΓòÉΓòÉΓòÉ
  11800.  
  11801. getLayerName() [virtual] 
  11802.  
  11803. Passes through to MSheetView::getLayerName(). 
  11804.  
  11805. Returns name of current layer. 
  11806.  
  11807. const char * 
  11808.  
  11809.  
  11810. ΓòÉΓòÉΓòÉ 2.13.8.5. MMesaView::getLayerNumber() ΓòÉΓòÉΓòÉ
  11811.  
  11812. getLayerNumber() [virtual] 
  11813.  
  11814. Passes through to MSheetView::getLayerNumber(). 
  11815.  
  11816. Returns number of current layer. 
  11817.  
  11818. int 
  11819.  
  11820.  
  11821. ΓòÉΓòÉΓòÉ 2.13.8.6. MMesaView::getSelectionContents() ΓòÉΓòÉΓòÉ
  11822.  
  11823. getSelectionContents() [virtual] 
  11824.  
  11825. Passes through to MSheetView::getSelectionContents(). 
  11826.  
  11827. Returns string form of the current selection (see also 
  11828. MSelection::getSelectionContents() ). 
  11829.  
  11830. char * 
  11831.  
  11832.  
  11833. ΓòÉΓòÉΓòÉ 2.13.8.7. MMesaView::getSelectionName() ΓòÉΓòÉΓòÉ
  11834.  
  11835. getSelectionName() [virtual] 
  11836.  
  11837. Passes through to MSheetView::getSelectionName(). 
  11838.  
  11839. Returns name of the current selection (see also MSelection::getSelectionName() 
  11840. ). 
  11841.  
  11842. char * 
  11843.  
  11844.  
  11845. ΓòÉΓòÉΓòÉ 2.13.8.8. MMesaView::getSelectionRange() ΓòÉΓòÉΓòÉ
  11846.  
  11847. getSelectionRange() [virtual] 
  11848.  
  11849. Passes through to MSheetView::getSelectionRange(). 
  11850.  
  11851. Returns string form of the current range (see also 
  11852. MSelection::getSelectionRange()] ). 
  11853.  
  11854. char * 
  11855.  
  11856.  
  11857. ΓòÉΓòÉΓòÉ 2.13.8.9. MMesaView::isScriptSelected() ΓòÉΓòÉΓòÉ
  11858.  
  11859. isScriptSelected() [virtual] 
  11860.  
  11861. Passes through to MSheetView::isScriptSelected(). 
  11862.  
  11863. Returns 1 if a script is selected, 0 otherwise. 
  11864.  
  11865. int 
  11866.  
  11867.  
  11868. ΓòÉΓòÉΓòÉ 2.13.8.10. MMesaView::isSheetSelected() ΓòÉΓòÉΓòÉ
  11869.  
  11870. isSheetSelected() [virtual] 
  11871.  
  11872. Passes through to MSheetView::isSheetSelected(). 
  11873.  
  11874. Returns 1 if a layer is selected, 0 otherwise. 
  11875.  
  11876. int 
  11877.  
  11878.  
  11879. ΓòÉΓòÉΓòÉ 2.13.9. Setting the current selection ΓòÉΓòÉΓòÉ
  11880.  
  11881. Open the Contents view and expand this section to see a list of methods. 
  11882.  
  11883.  
  11884. ΓòÉΓòÉΓòÉ 2.13.9.1. MMesaView::resetView() ΓòÉΓòÉΓòÉ
  11885.  
  11886. resetView(MChange *) [virtual] 
  11887.  
  11888.       MChange *   Unused 
  11889.  
  11890.  Sets the selection to default values (first layer, first row, first column) 
  11891.  and updates everything accordingly. 
  11892.  
  11893.  Always returns 0. 
  11894.  
  11895.  MRESULT 
  11896.  
  11897.  
  11898. ΓòÉΓòÉΓòÉ 2.13.9.2. MMesaView::select() ΓòÉΓòÉΓòÉ
  11899.  
  11900. select(const MSelection *) [virtual] 
  11901.  
  11902.       const MSelection *   New selection 
  11903.  
  11904.  Passes through to MSheetView::select(), which sets the current selection to 
  11905.  the given value. 
  11906.  
  11907.  void 
  11908.  
  11909.  
  11910. ΓòÉΓòÉΓòÉ 2.13.9.3. MMesaView::setAddressAndRange() ΓòÉΓòÉΓòÉ
  11911.  
  11912. setAddressAndRange(const MAddress *, const MRange *) [virtual] 
  11913.  
  11914.       const MAddress *   New address 
  11915.  
  11916.       const MRange *   New range 
  11917.  
  11918.  Passes through to MSheetView::setAddressAndRange(), which sets the currently 
  11919.  selected address and range to the given values. 
  11920.  
  11921.  void 
  11922.  
  11923.  
  11924. ΓòÉΓòÉΓòÉ 2.13.9.4. MMesaView::setCurAd() ΓòÉΓòÉΓòÉ
  11925.  
  11926. setCurAd(const MAddress *) [virtual] 
  11927.  
  11928.       const MAddress *   New address 
  11929.  
  11930.  Passes through to MSheetView::setCurAd(), which sets the current address to 
  11931.  the given value. 
  11932.  
  11933.  void 
  11934.  
  11935.  
  11936. ΓòÉΓòÉΓòÉ 2.13.9.5. MMesaView::setCurRange() ΓòÉΓòÉΓòÉ
  11937.  
  11938. setCurRange(const MRange *) [virtual] 
  11939.  
  11940.       const MRange *   New range 
  11941.  
  11942.  Passes through to MSheetView::setCurRange(), which sets the current range to 
  11943.  the given value 
  11944.  
  11945.  void 
  11946.  
  11947.  
  11948. ΓòÉΓòÉΓòÉ 2.13.9.6. MMesaView::setLayer() ΓòÉΓòÉΓòÉ
  11949.  
  11950. setLayer(int) [virtual] 
  11951.  
  11952.       int   New layer 
  11953.  
  11954.  Passes through to MSheetView::setLayer(), which changes the layer being 
  11955.  displayed and warns all the relevant windows. 
  11956.  
  11957.  void 
  11958.  
  11959.  
  11960. ΓòÉΓòÉΓòÉ 2.13.9.7. MMesaView::setSelection() ΓòÉΓòÉΓòÉ
  11961.  
  11962. setSelection(const MSelection *) [virtual] 
  11963.  
  11964.       const MSelection *   New selection 
  11965.  
  11966.  Passes through to MSheetView::setSelection(), which sets the current selection 
  11967.  to the given value. 
  11968.  
  11969.  void 
  11970.  
  11971.  
  11972. ΓòÉΓòÉΓòÉ 2.14. MObject ΓòÉΓòÉΓòÉ
  11973.  
  11974. object.h is the source file for this class. 
  11975.  
  11976. Base class for all objects with virtual tables in Mesa DOK. MObject allows 
  11977. other classes and instances to query information about themselves. 
  11978.  
  11979.  
  11980. ΓòÉΓòÉΓòÉ 2.14.1. Creating and destroying an MObject instance ΓòÉΓòÉΓòÉ
  11981.  
  11982. Open the Contents view and expand this section to see a list of methods. 
  11983.  
  11984.  
  11985. ΓòÉΓòÉΓòÉ 2.14.1.1. MObject::MObject() ΓòÉΓòÉΓòÉ
  11986.  
  11987. MObject() 
  11988.  
  11989. Creates a new MObject instance. 
  11990.  
  11991. void 
  11992.  
  11993. MObject(const char *, int) 
  11994.  
  11995.       const char *   Filename the objects are allocated from; used for debug 
  11996.       purposes. 
  11997.  
  11998.       int   Line number the objects are allocated from; used for debug 
  11999.       purposes. 
  12000.  
  12001.  Creates a new MObject instance and stores the given values in it. 
  12002.  
  12003.  void 
  12004.  
  12005.  
  12006. ΓòÉΓòÉΓòÉ 2.14.1.2. MObject::~MObject() ΓòÉΓòÉΓòÉ
  12007.  
  12008. ~MObject() [virtual] 
  12009.  
  12010. Destroys this instance and frees all resources. 
  12011.  
  12012. void 
  12013.  
  12014.  
  12015. ΓòÉΓòÉΓòÉ 2.15. MPoint ΓòÉΓòÉΓòÉ
  12016.  
  12017. rect.h is the source file for this class. 
  12018.  
  12019. Represents a single point within the application window - for example, the 
  12020. point where a mouse-down event occurs. MPoint is an abstraction of the OS/2 
  12021. POINTL class, existing primarily to allow alterations to point-handling 
  12022. routines to be made in a single place in the code. 
  12023.  
  12024. Each MPoint instance keeps track of the X and Y coordinates of the point it 
  12025. represents. The MPoint itself does not contain any information whatsoever about 
  12026. its reference frame; instead, various classes within Mesa DOK establish their 
  12027. own conventions for the origin point and the positive X and Y directions: 
  12028.  
  12029.      View classes such as MSheetView keep their origin point at the upper-left 
  12030.       corner of the window. 
  12031.  
  12032.      The Mesa model maintains an origin point at the upper-left corner of cell 
  12033.       A1 of the given layer, or the upper-left corner of the given script page. 
  12034.  
  12035.      Frames maintain an origin point at the lower-left corner of the frame. 
  12036.  
  12037.  These coordinates are maintained in points, allowing items to be displayed 
  12038.  within a view consistently with the way they are produced within a printer. 
  12039.  Additionally, your application window, and whatever other OS/2 windows it 
  12040.  contains, maintain their origin points in OS/2 GPI coordinates at the 
  12041.  lower-left corner of the window, in pixels. Furthermore, functions may 
  12042.  transform coordinate frames in a variety of other ways for convenience's sake, 
  12043.  as long as they remain consistent with the existing conventions. 
  12044.  
  12045.  The routines that detect and handle mouse events, drawing, and so forth 
  12046.  automatically convert coordinates from OS/2 window to Mesa view to Mesa model 
  12047.  to frame as needed, so you don't generally have to worry about the coordinate 
  12048.  frame of a point unless you want to bypass these routines within your own 
  12049.  functions. 
  12050.  
  12051.  
  12052. ΓòÉΓòÉΓòÉ 2.15.1. Initializing and destroying an MPoint instance ΓòÉΓòÉΓòÉ
  12053.  
  12054. Open the Contents view and expand this section to see a list of methods. 
  12055.  
  12056.  
  12057. ΓòÉΓòÉΓòÉ 2.15.1.1. MPoint::free() ΓòÉΓòÉΓòÉ
  12058.  
  12059. free() 
  12060.  
  12061. Releases all resources allocated to the MPoint (note: currently, no resources 
  12062. are ever allocated to an MPoint, and free() does nothing at all). 
  12063.  
  12064. void 
  12065.  
  12066.  
  12067. ΓòÉΓòÉΓòÉ 2.15.1.2. MPoint::copyFromPOINTL() ΓòÉΓòÉΓòÉ
  12068.  
  12069. copyFromPOINTL(const void *) 
  12070.  
  12071.       const void *   Input POINTL 
  12072.  
  12073.  Initializes the MPoint with coordinates read from the given POINTL. 
  12074.  
  12075.  void 
  12076.  
  12077.  
  12078. ΓòÉΓòÉΓòÉ 2.15.1.3. MPoint::init() ΓòÉΓòÉΓòÉ
  12079.  
  12080. init() 
  12081.  
  12082. Initializes the MPoint with default coordinates of 0,0. 
  12083.  
  12084. void 
  12085.  
  12086. init(const MPoint *) 
  12087.  
  12088.       const MPoint *   MPoint instance to initialize from 
  12089.  
  12090.  Initializes the MPoint with coordinates read from the given parameter. 
  12091.  
  12092.  void 
  12093.  
  12094.  init(float, float) 
  12095.  
  12096.       float   X coordinate 
  12097.  
  12098.       float   Y coordinate 
  12099.  
  12100.  Initializes the MPoint with the given coordinates. 
  12101.  
  12102.  void 
  12103.  
  12104.  init(MStream *st) 
  12105.  
  12106.       MStream *st   Input stream 
  12107.  
  12108.  Initializes the MPoint with coordinates read from st (see MStream). 
  12109.  
  12110.  void 
  12111.  
  12112.  
  12113. ΓòÉΓòÉΓòÉ 2.15.2. Retrieving point position ΓòÉΓòÉΓòÉ
  12114.  
  12115. Open the Contents view and expand this section to see a list of methods. 
  12116.  
  12117.  
  12118. ΓòÉΓòÉΓòÉ 2.15.2.1. MPoint::getX() ΓòÉΓòÉΓòÉ
  12119.  
  12120. getX() 
  12121.  
  12122. Returns X coordinate. 
  12123.  
  12124. float 
  12125.  
  12126.  
  12127. ΓòÉΓòÉΓòÉ 2.15.2.2. MPoint::getY() ΓòÉΓòÉΓòÉ
  12128.  
  12129. getY() 
  12130.  
  12131. Returns Y coordinate. 
  12132.  
  12133. float 
  12134.  
  12135.  
  12136. ΓòÉΓòÉΓòÉ 2.15.3. Changing point position ΓòÉΓòÉΓòÉ
  12137.  
  12138. Open the Contents view and expand this section to see a list of methods. 
  12139.  
  12140.  
  12141. ΓòÉΓòÉΓòÉ 2.15.3.1. MPoint::offsetX() ΓòÉΓòÉΓòÉ
  12142.  
  12143. offsetX(float) 
  12144.  
  12145.       float   X offset 
  12146.  
  12147.  Increments the X coordinate by the given amount. 
  12148.  
  12149.  void 
  12150.  
  12151.  
  12152. ΓòÉΓòÉΓòÉ 2.15.3.2. MPoint::offsetY() ΓòÉΓòÉΓòÉ
  12153.  
  12154. offsetY(float) 
  12155.  
  12156.       float   Y offset 
  12157.  
  12158.  Increments the Y coordinate by the given amount. 
  12159.  
  12160.  void 
  12161.  
  12162.  
  12163. ΓòÉΓòÉΓòÉ 2.15.3.3. MPoint::rotate() ΓòÉΓòÉΓòÉ
  12164.  
  12165. rotate(float) 
  12166.  
  12167.       float   Degrees to rotate 
  12168.  
  12169.  Sets the X and Y coordinates to those of a point rotated the given number of 
  12170.  degrees around the point 0,0. 
  12171.  
  12172.  void 
  12173.  
  12174.  
  12175. ΓòÉΓòÉΓòÉ 2.15.3.4. MPoint::scaleDown() ΓòÉΓòÉΓòÉ
  12176.  
  12177. scaleDown(float) 
  12178.  
  12179.       float   Scale factor 
  12180.  
  12181.  Divides the X and Y coordinates by the given scale-down factor. 
  12182.  
  12183.  void 
  12184.  
  12185.  
  12186. ΓòÉΓòÉΓòÉ 2.15.3.5. MPoint::scaleUp() ΓòÉΓòÉΓòÉ
  12187.  
  12188. scaleUp(float) 
  12189.  
  12190.       float   Scale factor 
  12191.  
  12192.  Multiplies the X and Y coordinates by the given scale-up factor. 
  12193.  
  12194.  void 
  12195.  
  12196.  
  12197. ΓòÉΓòÉΓòÉ 2.15.3.6. MPoint::set() ΓòÉΓòÉΓòÉ
  12198.  
  12199. set(float, float) 
  12200.  
  12201.       float   X coordinate 
  12202.  
  12203.       float   Y coordinate 
  12204.  
  12205.  Sets the X and Y coordinates to the given values. 
  12206.  
  12207.  void 
  12208.  
  12209.  
  12210. ΓòÉΓòÉΓòÉ 2.15.3.7. MPoint::setX() ΓòÉΓòÉΓòÉ
  12211.  
  12212. setX(float) 
  12213.  
  12214.       float   New X coordinate 
  12215.  
  12216.  Sets the X coordinate to the given value. 
  12217.  
  12218.  void 
  12219.  
  12220.  
  12221. ΓòÉΓòÉΓòÉ 2.15.3.8. MPoint::setY() ΓòÉΓòÉΓòÉ
  12222.  
  12223. setY(float) 
  12224.  
  12225.       float   New Y coordinate 
  12226.  
  12227.  Sets the Y coordinate to the given value. 
  12228.  
  12229.  void 
  12230.  
  12231.  
  12232. ΓòÉΓòÉΓòÉ 2.15.3.9. MPoint::translate() ΓòÉΓòÉΓòÉ
  12233.  
  12234. translate(float, float) 
  12235.  
  12236.       float   X offset 
  12237.  
  12238.       float   Y offset 
  12239.  
  12240.  Increments the X and Y coordinates by the given values. 
  12241.  
  12242.  void 
  12243.  
  12244.  
  12245. ΓòÉΓòÉΓòÉ 2.15.4. Outputting a point ΓòÉΓòÉΓòÉ
  12246.  
  12247. Open the Contents view and expand this section to see a list of methods. 
  12248.  
  12249.  
  12250. ΓòÉΓòÉΓòÉ 2.15.4.1. MPoint::copyToPOINTL() ΓòÉΓòÉΓòÉ
  12251.  
  12252. copyToPOINTL(void *) const 
  12253.  
  12254.       void *   Output POINTL 
  12255.  
  12256.  Copies X and Y coordinates from the current MPoint to the given POINTL. 
  12257.  
  12258.  void 
  12259.  
  12260.  
  12261. ΓòÉΓòÉΓòÉ 2.15.4.2. MPoint::write() ΓòÉΓòÉΓòÉ
  12262.  
  12263. write(MStream *st) 
  12264.  
  12265.       MStream *st   Output stream 
  12266.  
  12267.  Writes the X and Y coordinates out to st (see MStream). 
  12268.  
  12269.  void 
  12270.  
  12271.  
  12272. ΓòÉΓòÉΓòÉ 2.15.5. MPoint operators ΓòÉΓòÉΓòÉ
  12273.  
  12274. Open the Contents view and expand this section to see a list of methods. 
  12275.  
  12276.  
  12277. ΓòÉΓòÉΓòÉ 2.15.5.1. MPoint::operator==() ΓòÉΓòÉΓòÉ
  12278.  
  12279. operator==(const MPoint &) const 
  12280.  
  12281.       const MPoint &   Instance to compare to 
  12282.  
  12283.  Compares the current X and Y coordinates with those from the given MPoint. 
  12284.  
  12285.  Returns 1 if both are equal, 0 otherwise. 
  12286.  
  12287.  int 
  12288.  
  12289.  
  12290. ΓòÉΓòÉΓòÉ 2.16. MPrintHead ΓòÉΓòÉΓòÉ
  12291.  
  12292. printhead.h is the source file for this class. 
  12293.  
  12294. This class inherits from MObject 
  12295.  
  12296. Each MPrintHead instance keeps track of the following print-job related 
  12297. information: 
  12298.  
  12299.      its name; 
  12300.  
  12301.      the range to printed (default is all the non-empty cells in the current 
  12302.       layer); 
  12303.  
  12304.      the scale to print in (default is 100%); 
  12305.  
  12306.      margin size (default is 72 points, or 1 inch); 
  12307.  
  12308.      the order in which to print pages if range doesn't fit on one 
  12309.       page(default is over, then down); 
  12310.  
  12311.      page orientation (default is portrait); 
  12312.  
  12313.      up to eight header strings and their associated fonts; 
  12314.  
  12315.      whether grid lines should be printed; 
  12316.  
  12317.      whether row/column headings should be printed. 
  12318.  
  12319.  
  12320. ΓòÉΓòÉΓòÉ 2.16.1. Creating, destroying, and initializing an MPrintHead instance ΓòÉΓòÉΓòÉ
  12321.  
  12322. Open the Contents view and expand this section to see a list of methods. 
  12323.  
  12324.  
  12325. ΓòÉΓòÉΓòÉ 2.16.1.1. MPrintHead::MPrintHead() ΓòÉΓòÉΓòÉ
  12326.  
  12327. MPrintHead() 
  12328.  
  12329. Creates an MPrintHead instance with default values. 
  12330.  
  12331. void 
  12332.  
  12333. MPrintHead(MStream *st) 
  12334.  
  12335.       MStream *st   Input stream 
  12336.  
  12337.  Creates a new MPrintHead instance and loads the values from st (see MStream). 
  12338.  
  12339.  void 
  12340.  
  12341.  MPrintHead(const MPrintHead *) 
  12342.  
  12343.       const MPrintHead *   MPrintHead to initialize from 
  12344.  
  12345.  Creates a new MPrintHead instance and sets the values to those in the given 
  12346.  MPrintHead. 
  12347.  
  12348.  void 
  12349.  
  12350.  
  12351. ΓòÉΓòÉΓòÉ 2.16.1.2. MPrintHead::~MPrintHead() ΓòÉΓòÉΓòÉ
  12352.  
  12353. ~MPrintHead() [virtual] 
  12354.  
  12355. Frees any resources allocated by the MPrintHead instance. 
  12356.  
  12357. void 
  12358.  
  12359.  
  12360. ΓòÉΓòÉΓòÉ 2.16.2. Retrieving information from an MPrintHead instance ΓòÉΓòÉΓòÉ
  12361.  
  12362. Open the Contents view and expand this section to see a list of methods. 
  12363.  
  12364.  
  12365. ΓòÉΓòÉΓòÉ 2.16.2.1. MPrintHead::getFont() ΓòÉΓòÉΓòÉ
  12366.  
  12367. getFont(int) const [virtual] 
  12368.  
  12369.       int    Which header string? 
  12370.  
  12371.  Returns the font for the given header string (see "Header position 
  12372.  constants"). 
  12373.  
  12374.  const MFont * 
  12375.  
  12376.  
  12377. ΓòÉΓòÉΓòÉ 2.16.2.2. MPrintHead::getGrid() ΓòÉΓòÉΓòÉ
  12378.  
  12379. getGrid() const [virtual] 
  12380.  
  12381. Returns 1 if grid lines should be printed; 0 otherwise. 
  12382.  
  12383. int 
  12384.  
  12385.  
  12386. ΓòÉΓòÉΓòÉ 2.16.2.3. MPrintHead::getLayer() ΓòÉΓòÉΓòÉ
  12387.  
  12388. getLayer() const [virtual] 
  12389.  
  12390. Returns number of layer to be printed. 
  12391.  
  12392. int 
  12393.  
  12394.  
  12395. ΓòÉΓòÉΓòÉ 2.16.2.4. MPrintHead::getMargin() ΓòÉΓòÉΓòÉ
  12396.  
  12397. getMargin(int) const [virtual] 
  12398.  
  12399.       int   Which margin? 
  12400.  
  12401.  Returns size (in points) of the given margin (see "Margin position 
  12402.  constants"). 
  12403.  
  12404.  int 
  12405.  
  12406.  
  12407. ΓòÉΓòÉΓòÉ 2.16.2.5. MPrintHead::getOrient() ΓòÉΓòÉΓòÉ
  12408.  
  12409. getOrient() const [virtual] 
  12410.  
  12411. Returns page orientation (see "Page orientation constants"). 
  12412.  
  12413. int 
  12414.  
  12415.  
  12416. ΓòÉΓòÉΓòÉ 2.16.2.6. MPrintHead::getOrder() ΓòÉΓòÉΓòÉ
  12417.  
  12418. getOrder() const [virtual] 
  12419.  
  12420. Returns print order (see "Print order constants"). 
  12421.  
  12422. int 
  12423.  
  12424.  
  12425. ΓòÉΓòÉΓòÉ 2.16.2.7. MPrintHead::getRange() ΓòÉΓòÉΓòÉ
  12426.  
  12427. getRange() const [virtual] 
  12428.  
  12429. Returns address of range to be printed. 
  12430.  
  12431. const MRange * 
  12432.  
  12433.  
  12434. ΓòÉΓòÉΓòÉ 2.16.2.8. MPrintHead::getRCHead() ΓòÉΓòÉΓòÉ
  12435.  
  12436. getRCHead() const [virtual] 
  12437.  
  12438. Returns 1 if row and column headers should be printed; 0 otherwise. 
  12439.  
  12440. int 
  12441.  
  12442.  
  12443. ΓòÉΓòÉΓòÉ 2.16.2.9. MPrintHead::getScale() ΓòÉΓòÉΓòÉ
  12444.  
  12445. getScale() const [virtual] 
  12446.  
  12447. Returns current scaling percentage (default is 1). 
  12448.  
  12449. float 
  12450.  
  12451.  
  12452. ΓòÉΓòÉΓòÉ 2.16.2.10. MPrintHead::getString() ΓòÉΓòÉΓòÉ
  12453.  
  12454. getString(int) const [virtual] 
  12455.  
  12456.       int    Which header string? 
  12457.  
  12458.  Returns the text of the given header string (see "Header position constants"). 
  12459.  
  12460.  const char * 
  12461.  
  12462.  
  12463. ΓòÉΓòÉΓòÉ 2.16.3. Setting values in an MPrintHead instance ΓòÉΓòÉΓòÉ
  12464.  
  12465. Open the Contents view and expand this section to see a list of methods. 
  12466.  
  12467.  
  12468. ΓòÉΓòÉΓòÉ 2.16.3.1. MPrintHead::operator=() ΓòÉΓòÉΓòÉ
  12469.  
  12470. operator=(const MPrintHead &ph) [virtual] 
  12471.  
  12472.       const MPrintHead & ph    Another MPrintHead 
  12473.  
  12474.  Copies the values from ph to the current instance. Returns reference to 
  12475.  current instance. 
  12476.  
  12477.  MPrintHead & 
  12478.  
  12479.  
  12480. ΓòÉΓòÉΓòÉ 2.16.3.2. MPrintHead::setGrid() ΓòÉΓòÉΓòÉ
  12481.  
  12482. setGrid(int) [virtual] 
  12483.  
  12484.       int   TRUE for print grid, FALSE for don't print grid 
  12485.  
  12486.  Sets the print-grid setting for the print job. 
  12487.  
  12488.  void 
  12489.  
  12490.  
  12491. ΓòÉΓòÉΓòÉ 2.16.3.3. MPrintHead::setLayer() ΓòÉΓòÉΓòÉ
  12492.  
  12493. setLayer(int lay) [virtual] 
  12494.  
  12495.       int lay   Layer to be printed 
  12496.  
  12497.  Sets the layer for the print job to the given layer. 
  12498.  
  12499.  void 
  12500.  
  12501.  
  12502. ΓòÉΓòÉΓòÉ 2.16.3.4. MPrintHead::setMargin() ΓòÉΓòÉΓòÉ
  12503.  
  12504. setMargin(int n, int val) [virtual] 
  12505.  
  12506.       int n   Which margin? 
  12507.  
  12508.       int val   New size, in points 
  12509.  
  12510.  Sets the given margin (see "Margin position constants") to the given size. 
  12511.  
  12512.  void 
  12513.  
  12514.  
  12515. ΓòÉΓòÉΓòÉ 2.16.3.5. MPrintHead::setOrder() ΓòÉΓòÉΓòÉ
  12516.  
  12517. setOrder(int) [virtual] 
  12518.  
  12519.       int   New order 
  12520.  
  12521.  Sets the print order to the given value (see "Print order constants"). 
  12522.  
  12523.  void 
  12524.  
  12525.  
  12526. ΓòÉΓòÉΓòÉ 2.16.3.6. MPrintHead::setOrient() ΓòÉΓòÉΓòÉ
  12527.  
  12528. setOrient(int) [virtual] 
  12529.  
  12530.       int   New orientation 
  12531.  
  12532.  Sets the orientation to the given value (see "Page orientation constants"). 
  12533.  
  12534.  void 
  12535.  
  12536.  
  12537. ΓòÉΓòÉΓòÉ 2.16.3.7. MPrintHead::setRange() ΓòÉΓòÉΓòÉ
  12538.  
  12539. setRange(const MRange *r) [virtual] 
  12540.  
  12541.       const MRange *r   New range . 
  12542.  
  12543.  Sets the range to be printed to the given range. 
  12544.  
  12545.  void 
  12546.  
  12547.  
  12548. ΓòÉΓòÉΓòÉ 2.16.3.8. MPrintHead::setRCHead() ΓòÉΓòÉΓòÉ
  12549.  
  12550. setRCHead(int) [virtual] 
  12551.  
  12552.       int   TRUE to print row and column headers; FALSE otherwise. 
  12553.  
  12554.  Sets the print-headers setting for the print job. 
  12555.  
  12556.  void 
  12557.  
  12558.  
  12559. ΓòÉΓòÉΓòÉ 2.16.3.9. MPrintHead::setScale() ΓòÉΓòÉΓòÉ
  12560.  
  12561. setScale(float) [virtual] 
  12562.  
  12563.       float   New scale value 
  12564.  
  12565.  Sets the print scale to the given value (1=100%). 
  12566.  
  12567.  void 
  12568.  
  12569.  
  12570. ΓòÉΓòÉΓòÉ 2.16.3.10. MPrintHead::setString() ΓòÉΓòÉΓòÉ
  12571.  
  12572. setString(int, const char *text) [virtual] 
  12573.  
  12574.       int   Which header? 
  12575.  
  12576.       const char *text   New text 
  12577.  
  12578.  Sets the given header (see "Header position constants") to the given text. 
  12579.  
  12580.  void 
  12581.  
  12582.  
  12583. ΓòÉΓòÉΓòÉ 2.16.4. Outputting an MPrintHead instance to a stream ΓòÉΓòÉΓòÉ
  12584.  
  12585. Open the Contents view and expand this section to see a list of methods. 
  12586.  
  12587.  
  12588. ΓòÉΓòÉΓòÉ 2.16.4.1. MPrintHead::write() ΓòÉΓòÉΓòÉ
  12589.  
  12590. write(MStream *st) const [virtual] 
  12591.  
  12592.       MStream *st   Output stream 
  12593.  
  12594.  Outputs all stored values to st (see MStream). 
  12595.  
  12596.  void 
  12597.  
  12598.  
  12599. ΓòÉΓòÉΓòÉ 2.17. MRange ΓòÉΓòÉΓòÉ
  12600.  
  12601. range.h is the source file for this class. 
  12602.  
  12603. Represents a range of cells within a model. 
  12604.  
  12605. An MRange instance can represent either a simple rectangular range or a 
  12606. discontinuous range, consisting of several, potentially overlapping, 
  12607. rectangular ranges. 
  12608.  
  12609. Note that an MRange instance refers to and does not contain the data in the 
  12610. range it represents. Instances can therefore be created and destroyed without 
  12611. having any direct effect on the cells being represented. 
  12612.  
  12613. Each MRange instance keeps track of a range list, each entry in which contains 
  12614. either a single address (if the given range is only one cell) or a pair of 
  12615. addresses (defining the upper-left and lower-right corners of that range). 
  12616.  
  12617.  
  12618. ΓòÉΓòÉΓòÉ 2.17.1. Destroying an MRange instance ΓòÉΓòÉΓòÉ
  12619.  
  12620. Open the Contents view and expand this section to see a list of methods. 
  12621.  
  12622.  
  12623. ΓòÉΓòÉΓòÉ 2.17.1.1. MRange::free() ΓòÉΓòÉΓòÉ
  12624.  
  12625. free() 
  12626.  
  12627. Releases any storage the MRange has allocated and deletes the range list. 
  12628.  
  12629. void 
  12630.  
  12631.  
  12632. ΓòÉΓòÉΓòÉ 2.17.2. Setting or replacing the range list ΓòÉΓòÉΓòÉ
  12633.  
  12634. Open the Contents view and expand this section to see a list of methods. 
  12635.  
  12636.  
  12637. ΓòÉΓòÉΓòÉ 2.17.2.1. MRange::copySelectedRanges() ΓòÉΓòÉΓòÉ
  12638.  
  12639. copySelectedRanges(const MRange *, int, int) 
  12640.  
  12641.       const MRange *   MRange to copy from 
  12642.  
  12643.       int   First item in range list to copy 
  12644.  
  12645.       int   Last item in range list to copy 
  12646.  
  12647.  Replaces the current range list with the given subset of the given MRange's 
  12648.  range list. 
  12649.  
  12650.  For example, if range1 contains 4 items and range2 contains 10 items, then 
  12651.  range1 -> copySelectedRanges(range2, 3, 5) will leave range1 containing 3 
  12652.  items, equal to the third, fourth, and fifth items from range2. 
  12653.  
  12654.  void 
  12655.  
  12656.  
  12657. ΓòÉΓòÉΓòÉ 2.17.2.2. MRange::operator=() ΓòÉΓòÉΓòÉ
  12658.  
  12659. operator=(const MRange &) 
  12660.  
  12661.       const MRange &   Range to copy values from 
  12662.  
  12663.  Copies all values from the given rangeto the current range. 
  12664.  
  12665.  Returns reference to current range. 
  12666.  
  12667.  MRange & 
  12668.  
  12669.  
  12670. ΓòÉΓòÉΓòÉ 2.17.2.3. MRange::init() ΓòÉΓòÉΓòÉ
  12671.  
  12672. init() 
  12673.  
  12674. Initializes the MRange with an empty range list. 
  12675.  
  12676. void 
  12677.  
  12678. init(MStream *st) 
  12679.  
  12680.       MStream *st   Input stream 
  12681.  
  12682.  Initializes the instance with a range list read from st (see MStream). 
  12683.  
  12684.  void 
  12685.  
  12686.  init(const MAddress *) 
  12687.  
  12688.       const MAddress *   Address 
  12689.  
  12690.  Initializes the MRange with a single range containing only the given cell. 
  12691.  
  12692.  void 
  12693.  
  12694.  init(const MAddress *, const MAddress *) 
  12695.  
  12696.       const MAddress *   Upper-left corner of range 
  12697.  
  12698.       const MAddress *   Lower-right corner of range 
  12699.  
  12700.  Initializes the MRange with a single range specified by the given addresses. 
  12701.  
  12702.  void 
  12703.  
  12704.  init(const MRange *) 
  12705.  
  12706.       const MRange *   Range 
  12707.  
  12708.  Initializes the MRange with the range list from the given MRange. 
  12709.  
  12710.  void 
  12711.  
  12712.  
  12713. ΓòÉΓòÉΓòÉ 2.17.2.4. MRange::set() ΓòÉΓòÉΓòÉ
  12714.  
  12715. set(const MAddress *) 
  12716.  
  12717.       const MAddress *   Address 
  12718.  
  12719.  Sets range list to a single range containing only the given cell. 
  12720.  
  12721.  void 
  12722.  
  12723.  set(const MAddress *, const MAddress *) 
  12724.  
  12725.       const MAddress *   Upper-left corner of range 
  12726.  
  12727.       const MAddress *   Lower-right corner of range 
  12728.  
  12729.  Sets range list to a single range specified by the given addresses. 
  12730.  
  12731.  void 
  12732.  
  12733.  set(const MRange *) 
  12734.  
  12735.       const MRange *   Range 
  12736.  
  12737.  Replaces current range list with that of the given range. 
  12738.  
  12739.  void 
  12740.  
  12741.  
  12742. ΓòÉΓòÉΓòÉ 2.17.2.5. MRange::setAndSort() ΓòÉΓòÉΓòÉ
  12743.  
  12744. setAndSort(const MAddress *, const MAddress *) 
  12745.  
  12746.       const MAddress *   One corner of range 
  12747.  
  12748.       const MAddress *   Other corner of range 
  12749.  
  12750.  Sets range list to a single range represented by the given addresses, which 
  12751.  are sorted into upper-left, lower-right order before being added. 
  12752.  
  12753.  void 
  12754.  
  12755.  
  12756. ΓòÉΓòÉΓòÉ 2.17.2.6. MRange::zap() ΓòÉΓòÉΓòÉ
  12757.  
  12758. zap() 
  12759.  
  12760. Re-initializes the MRange instance to default values. 
  12761.  
  12762. void 
  12763.  
  12764.  
  12765. ΓòÉΓòÉΓòÉ 2.17.3. Adding items to the range list ΓòÉΓòÉΓòÉ
  12766.  
  12767. Open the Contents view and expand this section to see a list of methods. 
  12768.  
  12769.  
  12770. ΓòÉΓòÉΓòÉ 2.17.3.1. MRange::addAndSortRange() ΓòÉΓòÉΓòÉ
  12771.  
  12772. addAndSortRange(const MAddress *, const MAddress *) 
  12773.  
  12774.       const MAddress *   One corner of new range 
  12775.  
  12776.       const MAddress *   Other corner of new range 
  12777.  
  12778.  Adds the given addresses to the range list, sorting into upper-left, 
  12779.  lower-right order if needed. 
  12780.  
  12781.  void 
  12782.  
  12783.  
  12784. ΓòÉΓòÉΓòÉ 2.17.3.2. MRange::addRange() ΓòÉΓòÉΓòÉ
  12785.  
  12786. addRange(const MAddress *) 
  12787.  
  12788.       const MAddress *   New address 
  12789.  
  12790.  Adds the address to the range list as a single-cell range. 
  12791.  
  12792.  void 
  12793.  
  12794.  addRange(const MAddress *, const MAddress *) 
  12795.  
  12796.       const MAddress *   Upper-left corner of new range 
  12797.  
  12798.       const MAddress *   Lower-right corner of new range 
  12799.  
  12800.  Adds the given addresses to the range list. 
  12801.  
  12802.  void 
  12803.  
  12804.  
  12805. ΓòÉΓòÉΓòÉ 2.17.4. Querying the range list ΓòÉΓòÉΓòÉ
  12806.  
  12807. Open the Contents view and expand this section to see a list of methods. 
  12808.  
  12809.  
  12810. ΓòÉΓòÉΓòÉ 2.17.4.1. MRange::getCount() ΓòÉΓòÉΓòÉ
  12811.  
  12812. getCount() const 
  12813.  
  12814. Returns size of range list. 
  12815.  
  12816. int 
  12817.  
  12818.  
  12819. ΓòÉΓòÉΓòÉ 2.17.4.2. MRange::getAbs() ΓòÉΓòÉΓòÉ
  12820.  
  12821. getAbs() 
  12822.  
  12823. Returns 1 if the first item in the range list contains an absolute row, column, 
  12824. or layer reference; 0 otherwise. 
  12825.  
  12826. int 
  12827.  
  12828.  
  12829. ΓòÉΓòÉΓòÉ 2.17.4.3. MRange::getItem() ΓòÉΓòÉΓòÉ
  12830.  
  12831. getItem(int, MAddress &, MAddress &) const 
  12832.  
  12833.       int   Which item? 
  12834.  
  12835.       MAddress &   Storage for upper left corner 
  12836.  
  12837.       MAddress &   Storage for lower right corner 
  12838.  
  12839.  Stores the addresses of the corners of the given item in the range list. 
  12840.  
  12841.  void 
  12842.  
  12843.  
  12844. ΓòÉΓòÉΓòÉ 2.17.4.4. MRange::getTotalCells() ΓòÉΓòÉΓòÉ
  12845.  
  12846. getTotalCells() const 
  12847.  
  12848. Returns the total number of cells referred to by all the ranges in the range 
  12849. list. Cells referred to by more than one range are counted multiple times. 
  12850.  
  12851. int 
  12852.  
  12853.  
  12854. ΓòÉΓòÉΓòÉ 2.17.4.5. MRange::isAtLowerEdge() ΓòÉΓòÉΓòÉ
  12855.  
  12856. isAtLowerEdge(const MAddress *) const 
  12857.  
  12858.       const MAddress *   Address to look for 
  12859.  
  12860.  Determines whether the given address is within the bottom row of any range in 
  12861.  the range list. 
  12862.  
  12863.  If so, returns 1; otherwise returns 0. 
  12864.  
  12865.  int 
  12866.  
  12867.  
  12868. ΓòÉΓòÉΓòÉ 2.17.4.6. MRange::inRange() ΓòÉΓòÉΓòÉ
  12869.  
  12870. inRange(const MAddress *) const 
  12871.  
  12872.       const MAddress *   Address to look for 
  12873.  
  12874.  Determines whether the given address is within any range in the range list. 
  12875.  
  12876.  If so, returns 1; otherwise returns 0. 
  12877.  
  12878.  int 
  12879.  
  12880.  inRange(const MRange *) const 
  12881.  
  12882.       const MRange *   Range to look for 
  12883.  
  12884.  Determines whether all the cells in the given range are within any range in 
  12885.  the range list. 
  12886.  
  12887.  If so, returns 1; otherwise returns 0. 
  12888.  
  12889.  int 
  12890.  
  12891.  
  12892. ΓòÉΓòÉΓòÉ 2.17.4.7. MRange::inWhichRange() ΓòÉΓòÉΓòÉ
  12893.  
  12894. inWhichRange(const MAddress *, MAddress &, MAddress &) const 
  12895.  
  12896.       const MAddress *   Address to look for 
  12897.  
  12898.       MAddress &   Storage for upper left corner 
  12899.  
  12900.       MAddress &   Storage for lower right corner 
  12901.  
  12902.  Determines whether the given address is within any range in the range list, 
  12903.  and stores the upper-left and lower-right addresses of that range. 
  12904.  
  12905.  Returns the position of that range in the range list, or -1 if no such range 
  12906.  is found. 
  12907.  
  12908.  int 
  12909.  
  12910.  
  12911. ΓòÉΓòÉΓòÉ 2.17.4.8. MRange::isAutoGrow() ΓòÉΓòÉΓòÉ
  12912.  
  12913. isAutoGrow() const 
  12914.  
  12915. Returns 1 if the range is defined as an auto-grow range; 0 otherwise. 
  12916.  
  12917. int 
  12918.  
  12919.  
  12920. ΓòÉΓòÉΓòÉ 2.17.4.9. MRange::isColInRange() ΓòÉΓòÉΓòÉ
  12921.  
  12922. isColInRange(int, int) const 
  12923.  
  12924.       int   Which column? 
  12925.  
  12926.       int   Which layer? 
  12927.  
  12928.  Determines whether the given column overlaps the current range (see also 
  12929.  MRange::overlapRange() ). 
  12930.  
  12931.  Returns 1 if it overlaps, 0 otherwise. 
  12932.  
  12933.  int 
  12934.  
  12935.  
  12936. ΓòÉΓòÉΓòÉ 2.17.4.10. MRange::isRowInRange() ΓòÉΓòÉΓòÉ
  12937.  
  12938. isRowInRange(int, int) const 
  12939.  
  12940.       int   Which row? 
  12941.  
  12942.       int   Which layer? 
  12943.  
  12944.  Determines whether the given row overlaps the current range (see also 
  12945.  MRange::overlapRange() ). 
  12946.  
  12947.  Returns 1 if it overlaps, 0 otherwise. 
  12948.  
  12949.  int 
  12950.  
  12951.  
  12952. ΓòÉΓòÉΓòÉ 2.17.4.11. MRange::overlapRange() ΓòÉΓòÉΓòÉ
  12953.  
  12954. overlapRange(const MRange *) const 
  12955.  
  12956.       const MRange *   MRange to compare to 
  12957.  
  12958.  Two MRanges overlap if any of the cells in any of the ranges included in one 
  12959.  MRange is also in one of the ranges included in the other MRange. For example, 
  12960.  if mr1 includes the range A5:F6 as the third element in its range list, and 
  12961.  mr2 includes the range C1:D10 as the fifth element in its range list, then mr1 
  12962.  -> overlapRange(mr2) will return 1 (since the cells C5, C6, D5 and D6 are 
  12963.  common to both). 
  12964.  
  12965.  Returns 1 if the two ranges overlap, 0 otherwise. 
  12966.  
  12967.  int 
  12968.  
  12969.  
  12970. ΓòÉΓòÉΓòÉ 2.17.5. Handling the range list ΓòÉΓòÉΓòÉ
  12971.  
  12972. Open the Contents view and expand this section to see a list of methods. 
  12973.  
  12974.  
  12975. ΓòÉΓòÉΓòÉ 2.17.5.1. MRange::setAutoGrow() ΓòÉΓòÉΓòÉ
  12976.  
  12977. setAutoGrow(int) 
  12978.  
  12979.       int    New autogrow setting 
  12980.  
  12981.  Sets the autogrow flag for the range. 
  12982.  
  12983.  void 
  12984.  
  12985.  
  12986. ΓòÉΓòÉΓòÉ 2.17.5.2. MRange::setCount() ΓòÉΓòÉΓòÉ
  12987.  
  12988. setCount(int) 
  12989.  
  12990.       int    New range list size 
  12991.  
  12992.  Sets the size of the range list. Use with some care, as the current range list 
  12993.  may be larger than the new size, in which case the extra ranges will be 
  12994.  effectively lost. 
  12995.  
  12996.  void 
  12997.  
  12998.  
  12999. ΓòÉΓòÉΓòÉ 2.17.5.3. MRange::sortRange() ΓòÉΓòÉΓòÉ
  13000.  
  13001. sortRange() 
  13002.  
  13003. Sorts each item in the range list into upper-left, lower-right order. 
  13004.  
  13005. void 
  13006.  
  13007.  
  13008. ΓòÉΓòÉΓòÉ 2.17.6. Changing addresses of items in the range list ΓòÉΓòÉΓòÉ
  13009.  
  13010. Open the Contents view and expand this section to see a list of methods. 
  13011.  
  13012.  
  13013. ΓòÉΓòÉΓòÉ 2.17.6.1. MRange::doMerge() ΓòÉΓòÉΓòÉ
  13014.  
  13015. doMerge(const MAddress *) 
  13016.  
  13017.       const MAddress *   Base address 
  13018.  
  13019.  Passes through to MAddress::doMerge() for every MAddress in the range list, 
  13020.  thereby offseting the entire range being represented. 
  13021.  
  13022.  For example, if range1 represents the range A1:D5,B2,E5:G11 and base 
  13023.  represents the cell A5, then range1 -> doMerge(base) will set range1 to 
  13024.  represent the range A5:D9,B6,E9:G15. 
  13025.  
  13026.  void 
  13027.  
  13028.  
  13029. ΓòÉΓòÉΓòÉ 2.17.6.2. MRange::growFrom() ΓòÉΓòÉΓòÉ
  13030.  
  13031. growFrom(const MAddress *) 
  13032.  
  13033.       const MAddress *   Address to look for 
  13034.  
  13035.  Determines whether the given address is within the bottom row of any range in 
  13036.  the range list. 
  13037.  
  13038.  If not, or if it's a null address, returns -1. Otherwise, adds one row to the 
  13039.  first range for which that is true and returns the position of that range in 
  13040.  the range list. 
  13041.  
  13042.  int 
  13043.  
  13044.  
  13045. ΓòÉΓòÉΓòÉ 2.17.6.3. MRange::makeAbs() ΓòÉΓòÉΓòÉ
  13046.  
  13047. makeAbs() 
  13048.  
  13049. Passes through to MAddress::makeAbs() for every address in the range list, 
  13050. thereby changing them all to completely absolute range references. 
  13051.  
  13052. void 
  13053.  
  13054.  
  13055. ΓòÉΓòÉΓòÉ 2.17.6.4. MRange::offset() ΓòÉΓòÉΓòÉ
  13056.  
  13057. offset(int, int, int) 
  13058.  
  13059.       int   Row offset 
  13060.  
  13061.       int   Column offset 
  13062.  
  13063.       int   Layer offset 
  13064.  
  13065.  Passes through to MAddress::offset() for every address in the range list, 
  13066.  thereby offsetting the entire range by the given coordinates. 
  13067.  
  13068.  void 
  13069.  
  13070.  
  13071. ΓòÉΓòÉΓòÉ 2.17.6.5. MRange::offsetBy() ΓòÉΓòÉΓòÉ
  13072.  
  13073. offsetBy(const MAddress *) 
  13074.  
  13075.       const MAddress *   Address containing coordinates to offset by 
  13076.  
  13077.  Passes through to MAddress::offset() for every address in the range list, 
  13078.  where the three integer parameters are retrieved from the given address, 
  13079.  thereby offsetting the entire range by the given coordinates. 
  13080.  
  13081.  void 
  13082.  
  13083.  
  13084. ΓòÉΓòÉΓòÉ 2.17.6.6. MRange::setAbs() ΓòÉΓòÉΓòÉ
  13085.  
  13086. setAbs(int) 
  13087.  
  13088.       int   Packed structure containing absolute-flag settings for addresses 
  13089.  
  13090.  Unpacks the given structure and passes the appropriate parameters through to 
  13091.  MAddress::setAbsLayer(), MAddress::setAbsRow(), and MAddress::setAbsCol() for 
  13092.  each address stored in the range list. 
  13093.  
  13094.  void 
  13095.  
  13096.  
  13097. ΓòÉΓòÉΓòÉ 2.17.6.7. MRange::setItem() ΓòÉΓòÉΓòÉ
  13098.  
  13099. setItem(int, const MAddress *, const MAddress *) 
  13100.  
  13101.       int   Which item in the range list? 
  13102.  
  13103.       const MAddress *   Upper-left corner of range 
  13104.  
  13105.       const MAddress *   Lower-right corner of range 
  13106.  
  13107.  Replaces the given item in the range list with a single range specified by the 
  13108.  given addresses. 
  13109.  
  13110.  void 
  13111.  
  13112.  
  13113. ΓòÉΓòÉΓòÉ 2.17.7. Writing out an MRange instance ΓòÉΓòÉΓòÉ
  13114.  
  13115. Open the Contents view and expand this section to see a list of methods. 
  13116.  
  13117.  
  13118. ΓòÉΓòÉΓòÉ 2.17.7.1. MRange::write() ΓòÉΓòÉΓòÉ
  13119.  
  13120. write(MStream *st) const 
  13121.  
  13122.       MStream *st   Output stream 
  13123.  
  13124.  Outputs the instance to st (see MStream). 
  13125.  
  13126.  void 
  13127.  
  13128.  
  13129. ΓòÉΓòÉΓòÉ 2.17.8. MRange operator ΓòÉΓòÉΓòÉ
  13130.  
  13131. Open the Contents view and expand this section to see a list of methods. 
  13132.  
  13133.  
  13134. ΓòÉΓòÉΓòÉ 2.17.8.1. MRange::operator==() ΓòÉΓòÉΓòÉ
  13135.  
  13136. operator==(const MRange &) const 
  13137.  
  13138.       const MRange &   Range to compare 
  13139.  
  13140.  Two MRanges are equal if their range lists are the same size and contain the 
  13141.  same items in the same order. 
  13142.  
  13143.  Returns 1 if MRanges are equal, 0 otherwise. 
  13144.  
  13145.  int 
  13146.  
  13147.  
  13148. ΓòÉΓòÉΓòÉ 2.18. MRect ΓòÉΓòÉΓòÉ
  13149.  
  13150. rect.h is the source file for this class. 
  13151.  
  13152. Represents a rectangular region within the application window - for example, 
  13153. the size of a selected rectangular range. 
  13154.  
  13155. MRect is an abstraction of the OS/2 RECTL structure and is generally used 
  13156. within Mesa DOK where a RECTL would usually occur. It exists primarily to allow 
  13157. alterations to rectangle-handling routines to be made in a single place in the 
  13158. code. 
  13159.  
  13160. Each MRect instance keeps track of its starting point, its width, and its 
  13161. height. For more information, see "MPoint". 
  13162.  
  13163.  
  13164. ΓòÉΓòÉΓòÉ 2.18.1. Destroying an MRect instance ΓòÉΓòÉΓòÉ
  13165.  
  13166. Open the Contents view and expand this section to see a list of methods. 
  13167.  
  13168.  
  13169. ΓòÉΓòÉΓòÉ 2.18.1.1. MRect::free() ΓòÉΓòÉΓòÉ
  13170.  
  13171. free() 
  13172.  
  13173. Releases all allocated storage for the MRect instance. Currently does nothing, 
  13174. since no storage is allocated. 
  13175.  
  13176. void 
  13177.  
  13178.  
  13179. ΓòÉΓòÉΓòÉ 2.18.1.2. MRect::setNull() ΓòÉΓòÉΓòÉ
  13180.  
  13181. setNull() 
  13182.  
  13183. Sets all the values in the MRect instance to null pointers. 
  13184.  
  13185. void 
  13186.  
  13187.  
  13188. ΓòÉΓòÉΓòÉ 2.18.2. Setting rectangle size and position ΓòÉΓòÉΓòÉ
  13189.  
  13190. Open the Contents view and expand this section to see a list of methods. 
  13191.  
  13192.  
  13193. ΓòÉΓòÉΓòÉ 2.18.2.1. MRect::clipRect() ΓòÉΓòÉΓòÉ
  13194.  
  13195. clipRect(const MRect *) 
  13196.  
  13197.       const MRect *   Clipping rectangle 
  13198.  
  13199.  If the corner opposite the starting point of the given rectangle is inside the 
  13200.  boundary of the current rectangle, sets the corner opposite the starting point 
  13201.  of the current rectangle equal to it. 
  13202.  
  13203.  int 
  13204.  
  13205.  
  13206. ΓòÉΓòÉΓòÉ 2.18.2.2. MRect::copyFromRECTLInc() ΓòÉΓòÉΓòÉ
  13207.  
  13208. copyFromRECTLInc(const void *) 
  13209.  
  13210.       const void *   Input RECTL 
  13211.  
  13212.  Sets the rectangle parameters to values read from the given RECTL, plus a 
  13213.  1-pixel bounding line. 
  13214.  
  13215.  void 
  13216.  
  13217.  
  13218. ΓòÉΓòÉΓòÉ 2.18.2.3. MRect::copyFromRECTLNorm() ΓòÉΓòÉΓòÉ
  13219.  
  13220. copyFromRECTLNorm(const void *) 
  13221.  
  13222.       const void *   Input RECTL 
  13223.  
  13224.  Sets the rectangle parameters to values read from the given RECTL. 
  13225.  
  13226.  void 
  13227.  
  13228.  
  13229. ΓòÉΓòÉΓòÉ 2.18.2.4. MRect::init() ΓòÉΓòÉΓòÉ
  13230.  
  13231. init() 
  13232.  
  13233. Sets the rectangle parameters to {0,0,0,0}. 
  13234.  
  13235. void 
  13236.  
  13237. init(const MRect *) 
  13238.  
  13239.       const MRect *   Rectangle to initialize from 
  13240.  
  13241.  Sets the rectangle parameters to values read from the given MRect. 
  13242.  
  13243.  void 
  13244.  
  13245.  init(float tx, float ty, float twid, float thi) 
  13246.  
  13247.       float tx   New X 
  13248.  
  13249.       float ty   New Y 
  13250.  
  13251.       float twid   New width 
  13252.  
  13253.       float thi   New height 
  13254.  
  13255.  Sets the rectangle parameters to the given values. 
  13256.  
  13257.  void 
  13258.  
  13259.  init(MStream *st) 
  13260.  
  13261.       MStream *st   Input stream 
  13262.  
  13263.  Sets the rectangle parameters to values read from st (see MStream). 
  13264.  
  13265.  void 
  13266.  
  13267.  
  13268. ΓòÉΓòÉΓòÉ 2.18.2.5. MRect::inset() ΓòÉΓòÉΓòÉ
  13269.  
  13270. inset(float,float) 
  13271.  
  13272.       float   Horizontal inset 
  13273.  
  13274.       float   Vertical inset 
  13275.  
  13276.  Resizes and offsets the rectangle by the given values in all directions. 
  13277.  
  13278.  For example, if the current rectangle has width 10 and height 20 and starts at 
  13279.  the point {0,0}, inset(2,3) will resize it to width 6 and height 14 and move 
  13280.  its starting point to {2,3}. 
  13281.  
  13282.  Returns pointer to current rectangle. 
  13283.  
  13284.  MRect * 
  13285.  
  13286.  
  13287. ΓòÉΓòÉΓòÉ 2.18.2.6. MRect::insetRect() ΓòÉΓòÉΓòÉ
  13288.  
  13289. insetRect(float, float) 
  13290.  
  13291.       float   Horizontal inset 
  13292.  
  13293.       float   Vertical inset 
  13294.  
  13295.  Resizes and offsets the rectangle by the given values in all directions 
  13296.  (identical to inset(float, float)). 
  13297.  
  13298.  Returns pointer to current rectangle. 
  13299.  
  13300.  MRect * 
  13301.  
  13302.  
  13303. ΓòÉΓòÉΓòÉ 2.18.2.7. MRect::intersectRect() ΓòÉΓòÉΓòÉ
  13304.  
  13305. intersectRect(const MRect *) 
  13306.  
  13307.       const MRect *   Rectangle to compare to 
  13308.  
  13309.  Determines whether there is any intersection between the current and the given 
  13310.  rectangles. If there is, resizes and offsets the rectangle to the size and 
  13311.  position of the area of intersection. (Compare with MRect::doesIntersect().) 
  13312.  
  13313.  For example, if the current rectangle has width 10 and height 20 and starts at 
  13314.  the point {0,0}, and theRect has width 10 and height 4 and starts at the point 
  13315.  {2,3}, intersectRect(theRect) will resize the current rectangle to width 8 and 
  13316.  height 4 and move its starting point to {2,3} 
  13317.  
  13318.  Returns 1 if they intersect, 0 otherwise. 
  13319.  
  13320.  int 
  13321.  
  13322.  
  13323. ΓòÉΓòÉΓòÉ 2.18.2.8. MRect::offsetHi() ΓòÉΓòÉΓòÉ
  13324.  
  13325. offsetHi(float) 
  13326.  
  13327.       float   Height offset 
  13328.  
  13329.  Changes the current rectangle's height by the given amount, leaving the 
  13330.  starting point unchanged. 
  13331.  
  13332.  void 
  13333.  
  13334.  
  13335. ΓòÉΓòÉΓòÉ 2.18.2.9. MRect::offsetWid() ΓòÉΓòÉΓòÉ
  13336.  
  13337. offsetWid(float) 
  13338.  
  13339.       float   Width offset 
  13340.  
  13341.  Changes the current rectangle's width by the given amount, leaving the 
  13342.  starting point unchanged. 
  13343.  
  13344.  void 
  13345.  
  13346.  
  13347. ΓòÉΓòÉΓòÉ 2.18.2.10. MRect::offsetX() ΓòÉΓòÉΓòÉ
  13348.  
  13349. offsetX(float) 
  13350.  
  13351.       float   X offset 
  13352.  
  13353.  Moves the starting point of the current rectangle horizontally by the given 
  13354.  amount, leaving height and width unchanged. 
  13355.  
  13356.  void 
  13357.  
  13358.  
  13359. ΓòÉΓòÉΓòÉ 2.18.2.11. MRect::offsetY() ΓòÉΓòÉΓòÉ
  13360.  
  13361. offsetY(float) 
  13362.  
  13363.       float   Y offset 
  13364.  
  13365.  Moves the starting point of the current rectangle vertically by the given 
  13366.  amount, leaving height and width unchanged. 
  13367.  
  13368.  void 
  13369.  
  13370.  
  13371. ΓòÉΓòÉΓòÉ 2.18.2.12. MRect::round() ΓòÉΓòÉΓòÉ
  13372.  
  13373. round() 
  13374.  
  13375. Rounds the height, width, and starting X and Y coordinates of the current 
  13376. rectangle to the nearest integers. Used to avoid problems when drawing lines 
  13377. that are not aligned with pixel boundaries. 
  13378.  
  13379. void 
  13380.  
  13381.  
  13382. ΓòÉΓòÉΓòÉ 2.18.2.13. MRect::scaleDown() ΓòÉΓòÉΓòÉ
  13383.  
  13384. scaleDown(float) 
  13385.  
  13386.       float   Scale factor 
  13387.  
  13388.  Divides the height, width, and starting X and Y coordinates of the current 
  13389.  rectangle by the given value. 
  13390.  
  13391.  void 
  13392.  
  13393.  
  13394. ΓòÉΓòÉΓòÉ 2.18.2.14. MRect::scaleUp() ΓòÉΓòÉΓòÉ
  13395.  
  13396. scaleUp(float) 
  13397.  
  13398.       float   Scale factor 
  13399.  
  13400.  Multiples the height, width, and starting X and Y coordinates of the current 
  13401.  rectangle by the given value. 
  13402.  
  13403.  void 
  13404.  
  13405.  
  13406. ΓòÉΓòÉΓòÉ 2.18.2.15. MRect::set() ΓòÉΓòÉΓòÉ
  13407.  
  13408. set(float, float, float, float) 
  13409.  
  13410.       float   New X 
  13411.  
  13412.       float   New Y 
  13413.  
  13414.       float   New width 
  13415.  
  13416.       float   New height 
  13417.  
  13418.  Sets the rectangle parameters to the given values. 
  13419.  
  13420.  void 
  13421.  
  13422.  
  13423. ΓòÉΓòÉΓòÉ 2.18.2.16. MRect::setCX() ΓòÉΓòÉΓòÉ
  13424.  
  13425. setCX(float) 
  13426.  
  13427.       float   New maximum X 
  13428.  
  13429.  Changes the current rectangle's width to the difference between the X 
  13430.  coordinate of the starting point and the given X value, leaving the starting 
  13431.  point unchanged. 
  13432.  
  13433.  void 
  13434.  
  13435.  
  13436. ΓòÉΓòÉΓòÉ 2.18.2.17. MRect::setCY() ΓòÉΓòÉΓòÉ
  13437.  
  13438. setCY(float) 
  13439.  
  13440.       float   New maximum Y 
  13441.  
  13442.  Changes the current rectangle's height to the difference between theY 
  13443.  coordinate of the starting point and the givenY value, leaving the starting 
  13444.  point unchanged. 
  13445.  
  13446.  void 
  13447.  
  13448.  
  13449. ΓòÉΓòÉΓòÉ 2.18.2.18. MRect::setHi() ΓòÉΓòÉΓòÉ
  13450.  
  13451. setHi(float) 
  13452.  
  13453.       float   New height 
  13454.  
  13455.  Sets the rectangle's height to the given value, leaving the starting point 
  13456.  unchanged. 
  13457.  
  13458.  void 
  13459.  
  13460.  
  13461. ΓòÉΓòÉΓòÉ 2.18.2.19. MRect::setWid() ΓòÉΓòÉΓòÉ
  13462.  
  13463. setWid(float) 
  13464.  
  13465.       float   New width 
  13466.  
  13467.  Sets the rectangle's width to the given value, leaving the starting point 
  13468.  unchanged. 
  13469.  
  13470.  void 
  13471.  
  13472.  
  13473. ΓòÉΓòÉΓòÉ 2.18.2.20. MRect::setX() ΓòÉΓòÉΓòÉ
  13474.  
  13475. setX(float) 
  13476.  
  13477.       float   New X coordinate 
  13478.  
  13479.  Moves the starting point of the current rectangle horizontally to the given X 
  13480.  coordinate. 
  13481.  
  13482.  void 
  13483.  
  13484.  
  13485. ΓòÉΓòÉΓòÉ 2.18.2.21. MRect::setY() ΓòÉΓòÉΓòÉ
  13486.  
  13487. setY(float) 
  13488.  
  13489.       float   New Y coordinate 
  13490.  
  13491.  Moves the starting point of the current rectangle vertically to the givenY 
  13492.  coordinate. 
  13493.  
  13494.  void 
  13495.  
  13496.  
  13497. ΓòÉΓòÉΓòÉ 2.18.2.22. MRect::sizeByCorner() ΓòÉΓòÉΓòÉ
  13498.  
  13499. sizeByCorner(int, float, float) 
  13500.  
  13501.       int   Which corner? 
  13502.  
  13503.       float   X offset 
  13504.  
  13505.       float   Y offset 
  13506.  
  13507.  Resizes/moves the current rectangle by offsetting the given corner (see "Frame 
  13508.  corner constants") vertically and/or horizontally by the given amounts. 
  13509.  
  13510.  void 
  13511.  
  13512.  
  13513. ΓòÉΓòÉΓòÉ 2.18.3. Retrieving rectangle size and position ΓòÉΓòÉΓòÉ
  13514.  
  13515. Open the Contents view and expand this section to see a list of methods. 
  13516.  
  13517.  
  13518. ΓòÉΓòÉΓòÉ 2.18.3.1. MRect::getCX() ΓòÉΓòÉΓòÉ
  13519.  
  13520. getCX() const 
  13521.  
  13522. Returns the X coordinate of the corner of the current rectangle opposite the 
  13523. starting point. 
  13524.  
  13525. float 
  13526.  
  13527.  
  13528. ΓòÉΓòÉΓòÉ 2.18.3.2. MRect::getCY() ΓòÉΓòÉΓòÉ
  13529.  
  13530. getCY() const 
  13531.  
  13532. Returns theY coordinate of the corner of the current rectangle opposite the 
  13533. starting point. 
  13534.  
  13535. float 
  13536.  
  13537.  
  13538. ΓòÉΓòÉΓòÉ 2.18.3.3. MRect::getHi() ΓòÉΓòÉΓòÉ
  13539.  
  13540. getHi() const 
  13541.  
  13542. Returns the rectangle height. 
  13543.  
  13544. float 
  13545.  
  13546.  
  13547. ΓòÉΓòÉΓòÉ 2.18.3.4. MRect::getWid() ΓòÉΓòÉΓòÉ
  13548.  
  13549. getWid() const 
  13550.  
  13551. Returns the rectangle width. 
  13552.  
  13553. float 
  13554.  
  13555.  
  13556. ΓòÉΓòÉΓòÉ 2.18.3.5. MRect::getX() ΓòÉΓòÉΓòÉ
  13557.  
  13558. getX() const 
  13559.  
  13560. Returns the X coordinate of the rectangle's starting point. 
  13561.  
  13562. float 
  13563.  
  13564.  
  13565. ΓòÉΓòÉΓòÉ 2.18.3.6. MRect::getY() ΓòÉΓòÉΓòÉ
  13566.  
  13567. getY() const 
  13568.  
  13569. Returns the Y coordinate of the rectangle's starting point. 
  13570.  
  13571. float 
  13572.  
  13573.  
  13574. ΓòÉΓòÉΓòÉ 2.18.3.7. MRect::isNull() ΓòÉΓòÉΓòÉ
  13575.  
  13576. isNull() const 
  13577.  
  13578. Returns 1 if the rectangle is null, 0 otherwise. 
  13579.  
  13580. int 
  13581.  
  13582.  
  13583. ΓòÉΓòÉΓòÉ 2.18.4. Outputting an MRect instance ΓòÉΓòÉΓòÉ
  13584.  
  13585. Open the Contents view and expand this section to see a list of methods. 
  13586.  
  13587.  
  13588. ΓòÉΓòÉΓòÉ 2.18.4.1. MRect::copyToRECTLInc() ΓòÉΓòÉΓòÉ
  13589.  
  13590. copyToRECTLInc(void *) const 
  13591.  
  13592.       const void *   Output RECTL 
  13593.  
  13594.  Sets the given RECTL identical to the current rectangle, including a 1-pixel 
  13595.  bounding line. 
  13596.  
  13597.  void 
  13598.  
  13599.  
  13600. ΓòÉΓòÉΓòÉ 2.18.4.2. MRect::copyToRECTLNorm() ΓòÉΓòÉΓòÉ
  13601.  
  13602. copyToRECTLNorm(void *) const 
  13603.  
  13604.       const void *   Output RECTL 
  13605.  
  13606.  Sets the given RECTL identical to the current rectangle, not including a 
  13607.  1-pixel bounding line. 
  13608.  
  13609.  void 
  13610.  
  13611.  
  13612. ΓòÉΓòÉΓòÉ 2.18.4.3. MRect::write() ΓòÉΓòÉΓòÉ
  13613.  
  13614. write(MStream *st) const 
  13615.  
  13616.       MStream *st   Output stream 
  13617.  
  13618.  Outputs all stored values to st (see MStream). 
  13619.  
  13620.  void 
  13621.  
  13622.  
  13623. ΓòÉΓòÉΓòÉ 2.18.5. Determining intersections with a rectangle ΓòÉΓòÉΓòÉ
  13624.  
  13625. Open the Contents view and expand this section to see a list of methods. 
  13626.  
  13627.  
  13628. ΓòÉΓòÉΓòÉ 2.18.5.1. MRect::doesIntersect() ΓòÉΓòÉΓòÉ
  13629.  
  13630. doesIntersect(const MRect *) const 
  13631.  
  13632.       const MRect *   Rectangle to compare to 
  13633.  
  13634.  Determines whether there is any intersection between the current and the given 
  13635.  rectangles. (Compare with MRect::intersectRect().) 
  13636.  
  13637.  Returns 1 if they intersect, 0 otherwise. 
  13638.  
  13639.  int 
  13640.  
  13641.  
  13642. ΓòÉΓòÉΓòÉ 2.18.5.2. MRect::pointIn() ΓòÉΓòÉΓòÉ
  13643.  
  13644. pointIn(const MPoint *) const 
  13645.  
  13646.       const MPoint *   Point 
  13647.  
  13648.  Returns 1 if the given point is within the boundaries of the current 
  13649.  rectangle; 0 otherwise. 
  13650.  
  13651.  int 
  13652.  
  13653.  pointIn(const void *) const 
  13654.  
  13655.       const void *   Pointer to a POINTL structure 
  13656.  
  13657.  Returns 1 if the given point is within the boundaries of the current 
  13658.  rectangle; 0 otherwise. 
  13659.  
  13660.  int 
  13661.  
  13662.  
  13663. ΓòÉΓòÉΓòÉ 2.18.6. MRect operator ΓòÉΓòÉΓòÉ
  13664.  
  13665. Open the Contents view and expand this section to see a list of methods. 
  13666.  
  13667.  
  13668. ΓòÉΓòÉΓòÉ 2.18.6.1. MRect::operator==() ΓòÉΓòÉΓòÉ
  13669.  
  13670. operator==(const MRect &) const 
  13671.  
  13672.       const MRect &   Rectangle 
  13673.  
  13674.  Returns 1 if the height, width, and starting point of the given rectangle and 
  13675.  of the current rectangle are identical; 0 otherwise. 
  13676.  
  13677.  int 
  13678.  
  13679.  
  13680. ΓòÉΓòÉΓòÉ 2.19. MSelection ΓòÉΓòÉΓòÉ
  13681.  
  13682. selection.h is the source file for this class. 
  13683.  
  13684. An MSelection represents a set of model contents, such as ranges and graphs, 
  13685. and also maintains other information about the view and model that it is 
  13686. associated with. 
  13687.  
  13688. Each MSheetView instance maintains an MSelection which represents the current 
  13689. selection within the view - that is, the set of objects which a user's actions 
  13690. are expected to affect (see MSheetView). However, MSelection is used throughout 
  13691. Mesa DOK, particularly within MMesaModel, to represent a generic set of 
  13692. objects. For example, when an action is added to the undo list, the current 
  13693. selection is journaled; whenever an action is undone or redone, the journaled 
  13694. selection becomes the current selection. 
  13695.  
  13696. Within a given selection there is an "active selection" - for example, there is 
  13697. a base cell which is highlighted by an extra rectangle when the selected range 
  13698. is displayed. 
  13699.  
  13700. In general, when an action is performed on an MSelection, it affects the entire 
  13701. active selection and not anything else. For example, if the active selection is 
  13702. a frame, the MSelection will still maintain a range reference and a base cell 
  13703. reference. However, a command to reformat the current selection will reformat 
  13704. only the frame, not the range or base cell. 
  13705.  
  13706. Each MSelection instance keeps track of: 
  13707.  
  13708.      which page is being displayed in the model, and what type of page (layer 
  13709.       or script); 
  13710.  
  13711.       (The method names in this class may be somewhat confusing - for 
  13712.       historical reasons, "sheet" is used to refer to a layer page, "script" to 
  13713.       a script page, and "layer" to a page in general. Elsewhere within Mesa 
  13714.       DOK, and consistently within this document, "layer" refers to a layer 
  13715.       page, "page" refers to a page in general, and "sheet" is not generally 
  13716.       used.) 
  13717.  
  13718.      the selected range on that page, if it's a layer, or the script name, if 
  13719.       it's a script; 
  13720.  
  13721.      the active selection, which can include frames; 
  13722.  
  13723.      the upper-left corner to display in the sheet view (see MSheetView); 
  13724.  
  13725.      the default selections on other pages in the model, used to set the 
  13726.       correct selection when a new page is displayed (see MSelection::prime()). 
  13727.  
  13728.  Much of this information is maintained in string or index form, rather than as 
  13729.  actual pointers to the selected objects. For example, 
  13730.  MSelection::canEditContents() must query any selected frames to determine 
  13731.  their type. However, since only the names of selected frames are stored within 
  13732.  the MSelection instance, the method must first query the given model for a 
  13733.  pointer to the named frame. This is necessary, since MSelections are stored in 
  13734.  the model's undo list and therefore the objects referred to by the MSelection 
  13735.  may not always exist. 
  13736.  
  13737.  
  13738. ΓòÉΓòÉΓòÉ 2.19.1. Initializing and destroying an MSelection instance ΓòÉΓòÉΓòÉ
  13739.  
  13740. Open the Contents view and expand this section to see a list of methods. 
  13741.  
  13742.  
  13743. ΓòÉΓòÉΓòÉ 2.19.1.1. MSelection::free() ΓòÉΓòÉΓòÉ
  13744.  
  13745. free() 
  13746.  
  13747. Releases any storage allocated by this instance. 
  13748.  
  13749. void 
  13750.  
  13751.  
  13752. ΓòÉΓòÉΓòÉ 2.19.1.2. MSelection::init() ΓòÉΓòÉΓòÉ
  13753.  
  13754. init() 
  13755.  
  13756. Initializes the instance to default values. 
  13757.  
  13758. void 
  13759.  
  13760. init(MStream *st) 
  13761.  
  13762.       MStream *st   Input stream 
  13763.  
  13764.  Initializes the instance with values read from st (see MStream). 
  13765.  
  13766.  void 
  13767.  
  13768.  init(const MSelection *, int) 
  13769.  
  13770.       const MSelection *   MSelection instance to initialize from 
  13771.  
  13772.       int   Which selections? (1 for all, 0 for just the active selection) 
  13773.  
  13774.  Initializes the instance with the indicated values from the given MSelection. 
  13775.  
  13776.  void 
  13777.  
  13778.  
  13779. ΓòÉΓòÉΓòÉ 2.19.1.3. MSelection::initToA1() ΓòÉΓòÉΓòÉ
  13780.  
  13781. initToA1() 
  13782.  
  13783. Initializes the instance to cell [A]A1. 
  13784.  
  13785. void 
  13786.  
  13787.  
  13788. ΓòÉΓòÉΓòÉ 2.19.2. Handling ranges and base cell in an MSelection instance ΓòÉΓòÉΓòÉ
  13789.  
  13790. Open the Contents view and expand this section to see a list of methods. 
  13791.  
  13792.  
  13793. ΓòÉΓòÉΓòÉ 2.19.2.1. MSelection::fillRange() ΓòÉΓòÉΓòÉ
  13794.  
  13795. fillRange(MRange *) const 
  13796.  
  13797.       MRange *   Storage location 
  13798.  
  13799.  Stores the current range, if the current page is a layer. 
  13800.  
  13801.  void 
  13802.  
  13803.  
  13804. ΓòÉΓòÉΓòÉ 2.19.2.2. MSelection::getAdPtr() ΓòÉΓòÉΓòÉ
  13805.  
  13806. getAdPtr() const 
  13807.  
  13808. Returns pointer to base cell. 
  13809.  
  13810. const MAddress * 
  13811.  
  13812.  
  13813. ΓòÉΓòÉΓòÉ 2.19.2.3. MSelection::getItem() ΓòÉΓòÉΓòÉ
  13814.  
  13815. getItem(int, MAddress &, MAddress &) const 
  13816.  
  13817.       int   Which item? 
  13818.  
  13819.       MAddress &   Upper left corner address 
  13820.  
  13821.       MAddress &   Lower right corner address 
  13822.  
  13823.  Passes through to MRange::getItem() for the selected range, storing the 
  13824.  corners of the indicated subrange. 
  13825.  
  13826.  void 
  13827.  
  13828.  
  13829. ΓòÉΓòÉΓòÉ 2.19.2.4. MSelection::getRangeCount() ΓòÉΓòÉΓòÉ
  13830.  
  13831. getRangeCount() const 
  13832.  
  13833. Passes through to MRange::getCount() for the selected range, returning the 
  13834. number of discrete subranges. 
  13835.  
  13836. int 
  13837.  
  13838.  
  13839. ΓòÉΓòÉΓòÉ 2.19.2.5. MSelection::getRangePtr() ΓòÉΓòÉΓòÉ
  13840.  
  13841. getRangePtr() const 
  13842.  
  13843. Returns pointer to the currently selected range. 
  13844.  
  13845. const MRange * 
  13846.  
  13847.  
  13848. ΓòÉΓòÉΓòÉ 2.19.2.6. MSelection::getUnconstRangePtr() ΓòÉΓòÉΓòÉ
  13849.  
  13850. getUnconstRangePtr() 
  13851.  
  13852. Returns a pointer to the selected range. 
  13853.  
  13854. MRange * 
  13855.  
  13856.  
  13857. ΓòÉΓòÉΓòÉ 2.19.2.7. MSelection::inRange() ΓòÉΓòÉΓòÉ
  13858.  
  13859. const MAddress *   Address 
  13860.  
  13861. Passes through to MRange::inRange() for the selected range, returning 1 if the 
  13862. given address is within the current range; 0 otherwise. 
  13863.  
  13864. int 
  13865.  
  13866.  
  13867. ΓòÉΓòÉΓòÉ 2.19.2.8. MSelection::inWhichRange() ΓòÉΓòÉΓòÉ
  13868.  
  13869. inWhichRange(const MAddress *, MAddress &, MAddress &) const 
  13870.  
  13871.       const MAddress *   Address to check for 
  13872.  
  13873.       MAddress &   Storage location for upper-left corner 
  13874.  
  13875.       MAddress &   Storage location for upper-right corner 
  13876.  
  13877.  Passes through to MRange::inWhichRange() for the selected range, returning 1 
  13878.  if the given address is within the current range; 0 otherwise. 
  13879.  
  13880.  int 
  13881.  
  13882.  
  13883. ΓòÉΓòÉΓòÉ 2.19.2.9. MSelection::isASpreadsheet() ΓòÉΓòÉΓòÉ
  13884.  
  13885. isASpreadsheet() const 
  13886.  
  13887. Returns 1 if the active selection is a range of cells, 0 otherwise. 
  13888.  
  13889. int 
  13890.  
  13891.  
  13892. ΓòÉΓòÉΓòÉ 2.19.2.10. MSelection::isColInRange() ΓòÉΓòÉΓòÉ
  13893.  
  13894. isColInRange(int i1, int i2) const 
  13895.  
  13896.       int   Which column? 
  13897.  
  13898.       int   Which layer? 
  13899.  
  13900.  Returns 1 if the given column in the given layer is within the selected range. 
  13901.  
  13902.  int 
  13903.  
  13904.  
  13905. ΓòÉΓòÉΓòÉ 2.19.2.11. MSelection::isRowInRange() ΓòÉΓòÉΓòÉ
  13906.  
  13907. isRowInRange(int, int) const 
  13908.  
  13909.       int   Which row? 
  13910.  
  13911.       int   Which layer? 
  13912.  
  13913.  Returns 1 if the given row in the given layer is within the selected range. 
  13914.  
  13915.  int 
  13916.  
  13917.  
  13918. ΓòÉΓòÉΓòÉ 2.19.2.12. MSelection::makeARange() ΓòÉΓòÉΓòÉ
  13919.  
  13920. makeARange() 
  13921.  
  13922. Removes everything in the selection besides the range, and frees the allocated 
  13923. resources. 
  13924.  
  13925. void 
  13926.  
  13927.  
  13928. ΓòÉΓòÉΓòÉ 2.19.2.13. MSelection::set() ΓòÉΓòÉΓòÉ
  13929.  
  13930. set(const MAddress *) 
  13931.  
  13932.       const MAddress *   Address to store as base cell 
  13933.  
  13934.  Sets the base cell address to the given address, and clears all ranges from 
  13935.  the selection list. 
  13936.  
  13937.  void 
  13938.  
  13939.  
  13940. ΓòÉΓòÉΓòÉ 2.19.2.14. MSelection::setAdButNotRange() ΓòÉΓòÉΓòÉ
  13941.  
  13942. setAdButNotRange(const MAddress *) 
  13943.  
  13944.       const MAddress *   Address to store as base cell 
  13945.  
  13946.  Sets the base cell address to the given address, leaving the rest of the 
  13947.  selection list unchanged. 
  13948.  
  13949.  void 
  13950.  
  13951.  
  13952. ΓòÉΓòÉΓòÉ 2.19.2.15. MSelection::setAddressAndRange() ΓòÉΓòÉΓòÉ
  13953.  
  13954. setAddressAndRange(const MAddress *, const MRange *) 
  13955.  
  13956.       const MAddress *   Address to store as base cell 
  13957.  
  13958.       const MRange *   Range to store as selected range 
  13959.  
  13960.  Sets the base cell address to the given address, and sets the current range to 
  13961.  the given range. 
  13962.  
  13963.  void 
  13964.  
  13965.  
  13966. ΓòÉΓòÉΓòÉ 2.19.2.16. MSelection::setAndSort() ΓòÉΓòÉΓòÉ
  13967.  
  13968. setAndSort(const MAddress *, const MAddress *) 
  13969.  
  13970.       const MAddress *   One corner of new range 
  13971.  
  13972.       const MAddress *   Other corner of new range 
  13973.  
  13974.  Ensures that the active selection is a range (by selecting a default range if 
  13975.  it's not), then passes the given addresses through to MRange::setAndSort() for 
  13976.  that range, which sets it to the range defined by the given addresses. 
  13977.  
  13978.  void 
  13979.  
  13980.  
  13981. ΓòÉΓòÉΓòÉ 2.19.2.17. MSelection::setAndSortItem() ΓòÉΓòÉΓòÉ
  13982.  
  13983. setAndSortItem( int item, const MAddress *, const MAddress * ) 
  13984.  
  13985.       int item   Which item in the range list? 
  13986.  
  13987.       const MAddress *   One corner of new range 
  13988.  
  13989.       const MAddress *   Other corner of new range 
  13990.  
  13991.  Passes through to MRange::setItem() for the active range, setting the given 
  13992.  item in its range list to the new range, then sorts all the items in the 
  13993.  active range list into upper-left, lower-right order. 
  13994.  
  13995.  void 
  13996.  
  13997.  
  13998. ΓòÉΓòÉΓòÉ 2.19.2.18. MSelection::zap() ΓòÉΓòÉΓòÉ
  13999.  
  14000. zap() 
  14001.  
  14002. Reinitializes the selection to cell [A]A1. 
  14003.  
  14004. void 
  14005.  
  14006.  
  14007. ΓòÉΓòÉΓòÉ 2.19.2.19. MSelection::zapRange() ΓòÉΓòÉΓòÉ
  14008.  
  14009. zapRange() 
  14010.  
  14011. Sets the range and base cell to cell [A]A1, leaving the rest of the selection 
  14012. unchanged. 
  14013.  
  14014. void 
  14015.  
  14016.  
  14017. ΓòÉΓòÉΓòÉ 2.19.2.20. MSelection::zapToLayer() ΓòÉΓòÉΓòÉ
  14018.  
  14019. zapToLayer() 
  14020.  
  14021. Sets the range and base cell to cell A1 of the current layer. 
  14022.  
  14023. void 
  14024.  
  14025.  
  14026. ΓòÉΓòÉΓòÉ 2.19.3. Handling frames in an MSelection instance ΓòÉΓòÉΓòÉ
  14027.  
  14028. Open the Contents view and expand this section to see a list of methods. 
  14029.  
  14030.  
  14031. ΓòÉΓòÉΓòÉ 2.19.3.1. MSelection::getFrameName() ΓòÉΓòÉΓòÉ
  14032.  
  14033. getFrameName(int) const 
  14034.  
  14035.       int   Which frame? 
  14036.  
  14037.  Returns the frame name for the given frame. 
  14038.  
  14039.  const char * 
  14040.  
  14041.  
  14042. ΓòÉΓòÉΓòÉ 2.19.3.2. MSelection::isFrameSelected() ΓòÉΓòÉΓòÉ
  14043.  
  14044. isFrameSelected() const 
  14045.  
  14046. Returns frame number of the active selected frame, or 0 if no frame is 
  14047. selected. 
  14048.  
  14049. int 
  14050.  
  14051. isFrameSelected(const char *) const 
  14052.  
  14053.       const char *   Frame name 
  14054.  
  14055.  Returns 1 if the named frame is in the selection, 0 otherwise. 
  14056.  
  14057.  int 
  14058.  
  14059.  
  14060. ΓòÉΓòÉΓòÉ 2.19.3.3. MSelection::makeNoGraph() ΓòÉΓòÉΓòÉ
  14061.  
  14062. makeNoGraph() 
  14063.  
  14064. Removes all selected frames from the selection, and frees the allocated 
  14065. resources. 
  14066.  
  14067. void 
  14068.  
  14069.  
  14070. ΓòÉΓòÉΓòÉ 2.19.3.4. MSelection::setFrameSelection() ΓòÉΓòÉΓòÉ
  14071.  
  14072. setFrameSelection(const char *) 
  14073.  
  14074.       const char *   Name of frame 
  14075.  
  14076.  Sets the active selection to the given frame name. 
  14077.  
  14078.  void 
  14079.  
  14080.  
  14081. ΓòÉΓòÉΓòÉ 2.19.4. Handling multiple pages in an MSelection instance ΓòÉΓòÉΓòÉ
  14082.  
  14083. Open the Contents view and expand this section to see a list of methods. 
  14084.  
  14085.  
  14086. ΓòÉΓòÉΓòÉ 2.19.4.1. MSelection::findSelection() ΓòÉΓòÉΓòÉ
  14087.  
  14088. findSelection(int) const 
  14089.  
  14090.       int   Which layer? 
  14091.  
  14092.  Returns the default selection stored for that layer, or NULL if layer doesn't 
  14093.  exist. 
  14094.  
  14095.  const MSelection * 
  14096.  
  14097.  
  14098. ΓòÉΓòÉΓòÉ 2.19.4.2. MSelection::getLayer() ΓòÉΓòÉΓòÉ
  14099.  
  14100. getLayer() const 
  14101.  
  14102. Returns the current layer number. 
  14103.  
  14104. int 
  14105.  
  14106.  
  14107. ΓòÉΓòÉΓòÉ 2.19.4.3. MSelection::getLayerName() ΓòÉΓòÉΓòÉ
  14108.  
  14109. getLayerName(MMesaModel *) 
  14110.  
  14111.       MMesaModel *   Model containing page name list 
  14112.  
  14113.  Returns script name if the current page is a script; otherwise, returns a 
  14114.  blank string. 
  14115.  
  14116.  const char * 
  14117.  
  14118.  
  14119. ΓòÉΓòÉΓòÉ 2.19.4.4. MSelection::isScriptLayer() ΓòÉΓòÉΓòÉ
  14120.  
  14121. isScriptLayer() const 
  14122.  
  14123. Returns 1 if the current selection is a script page; 0 otherwise. 
  14124.  
  14125. int 
  14126.  
  14127.  
  14128. ΓòÉΓòÉΓòÉ 2.19.4.5. MSelection::isSheetLayer() ΓòÉΓòÉΓòÉ
  14129.  
  14130. isSheetLayer() const 
  14131.  
  14132. Returns 1 if the current selection is a layer page; 0 otherwise. 
  14133.  
  14134. int 
  14135.  
  14136.  
  14137. ΓòÉΓòÉΓòÉ 2.19.4.6. MSelection::makeScript() ΓòÉΓòÉΓòÉ
  14138.  
  14139. makeScript() 
  14140.  
  14141. Removes everything, including the range, from the selection, and makes it a 
  14142. script-page selection. 
  14143.  
  14144. void 
  14145.  
  14146.  
  14147. ΓòÉΓòÉΓòÉ 2.19.4.7. MSelection::prime() ΓòÉΓòÉΓòÉ
  14148.  
  14149. prime(int, const MAddress *) 
  14150.  
  14151.       int   Which layer? 
  14152.  
  14153.       const MAddress *   Address to store as base cell 
  14154.  
  14155.  Stores the given base cell in the instance's selection list for the current 
  14156.  layer, then selects the given layer and turns the stored selection for that 
  14157.  layer into the active selection. 
  14158.  
  14159.  void 
  14160.  
  14161.  prime(int, const MAddress *, const MRange *) 
  14162.  
  14163.       int   Which layer? 
  14164.  
  14165.       const MAddress *   Address to store as base cell 
  14166.  
  14167.       const MRange *   Range to store as selected range 
  14168.  
  14169.  Stores the given base cell and range in the instance's selection list for the 
  14170.  current layer, then selects the given layer and turns the stored selection for 
  14171.  that layer into the active selection. 
  14172.  
  14173.  void 
  14174.  
  14175.  prime(int, const MSelection *) 
  14176.  
  14177.       int   Which layer? 
  14178.  
  14179.       const MSelection *   Selection to store as current selection 
  14180.  
  14181.  Stores the given selection in the instance's selection list for the current 
  14182.  layer, then selects the given layer and turns the stored selection for that 
  14183.  layer into the active selection. 
  14184.  
  14185.  void 
  14186.  
  14187.  
  14188. ΓòÉΓòÉΓòÉ 2.19.4.8. MSelection::setLayer() ΓòÉΓòÉΓòÉ
  14189.  
  14190. setLayer(int, MMesaModel *) 
  14191.  
  14192.       int   Which page? 
  14193.  
  14194.       MMesaModel *   Mesa model containing page name list 
  14195.  
  14196.  Sets the displayed page within the MSelection to the given page. If the given 
  14197.  page is a layer, either restores the stored selection for that page or sets a 
  14198.  default selection if no stored selection is available. If the given page is a 
  14199.  script, retrieves the script name from the model. 
  14200.  
  14201.  void 
  14202.  
  14203.  
  14204. ΓòÉΓòÉΓòÉ 2.19.4.9. MSelection::testForSheetLayer() ΓòÉΓòÉΓòÉ
  14205.  
  14206. testForSheetLayer(int) 
  14207.  
  14208.       int   Which page? 
  14209.  
  14210.  Returns 1 if the given page is a layer, 0 otherwise. 
  14211.  
  14212.  static int 
  14213.  
  14214.  
  14215. ΓòÉΓòÉΓòÉ 2.19.4.10. MSelection::testForScriptLayer() ΓòÉΓòÉΓòÉ
  14216.  
  14217. testForScriptLayer(int i) 
  14218.  
  14219.       int    Which page? 
  14220.  
  14221.  Returns 1 if the given page is a script, 0 otherwise. 
  14222.  
  14223.  static int 
  14224.  
  14225.  
  14226. ΓòÉΓòÉΓòÉ 2.19.5. Handling upper-left display cell in an MSelection instance ΓòÉΓòÉΓòÉ
  14227.  
  14228. Open the Contents view and expand this section to see a list of methods. 
  14229.  
  14230.  
  14231. ΓòÉΓòÉΓòÉ 2.19.5.1. MSelection::getUpperLeftColumn() ΓòÉΓòÉΓòÉ
  14232.  
  14233. getUpperLeftColumn() const 
  14234.  
  14235. Returns column of the first cell being displayed. 
  14236.  
  14237. int 
  14238.  
  14239.  
  14240. ΓòÉΓòÉΓòÉ 2.19.5.2. MSelection::getUpperLeftLayer() ΓòÉΓòÉΓòÉ
  14241.  
  14242. getUpperLeftLayer() const 
  14243.  
  14244. Returns layer of the first cell being displayed. 
  14245.  
  14246. int 
  14247.  
  14248.  
  14249. ΓòÉΓòÉΓòÉ 2.19.5.3. MSelection::getUpperLeftPtr() ΓòÉΓòÉΓòÉ
  14250.  
  14251. getUpperLeftPtr() const 
  14252.  
  14253. Returns address of the first cell being displayed. 
  14254.  
  14255. const MAddress * 
  14256.  
  14257.  
  14258. ΓòÉΓòÉΓòÉ 2.19.5.4. MSelection::getUpperLeftRow() ΓòÉΓòÉΓòÉ
  14259.  
  14260. getUpperLeftRow() const 
  14261.  
  14262. Returns row of the first cell being displayed. 
  14263.  
  14264. int 
  14265.  
  14266.  
  14267. ΓòÉΓòÉΓòÉ 2.19.5.5. MSelection::setUpperLeft() ΓòÉΓòÉΓòÉ
  14268.  
  14269. setUpperLeft(const MAddress *) 
  14270.  
  14271.       const MAddress *   New upper-left corner to display 
  14272.  
  14273.  Sets the upper left corner of the display to the given address. 
  14274.  
  14275.  void 
  14276.  
  14277.  
  14278. ΓòÉΓòÉΓòÉ 2.19.5.6. MSelection::setUpperLeftColumn() ΓòÉΓòÉΓòÉ
  14279.  
  14280. setUpperLeftColumn(int) 
  14281.  
  14282.       int   New left column 
  14283.  
  14284.  Sets the left column to display to the given value. 
  14285.  
  14286.  void 
  14287.  
  14288.  
  14289. ΓòÉΓòÉΓòÉ 2.19.5.7. MSelection::setUpperLeftRow() ΓòÉΓòÉΓòÉ
  14290.  
  14291. setUpperLeftRow(int) 
  14292.  
  14293.       int   New top row 
  14294.  
  14295.  Sets the top row to display to the given value. 
  14296.  
  14297.  void 
  14298.  
  14299.  
  14300. ΓòÉΓòÉΓòÉ 2.19.6. Querying the MSelection instance ΓòÉΓòÉΓòÉ
  14301.  
  14302. Open the Contents view and expand this section to see a list of methods. 
  14303.  
  14304.  
  14305. ΓòÉΓòÉΓòÉ 2.19.6.1. MSelection::canEditContents() ΓòÉΓòÉΓòÉ
  14306.  
  14307. canEditContents(MMesaModel *) const 
  14308.  
  14309.       MMesaModel *   Model containing frame list 
  14310.  
  14311.  Determines whether the current selection can be textually edited. (The given 
  14312.  model is used to retrieve the frame type, if a frame is selected.) 
  14313.  
  14314.  If it is a range of cells or a text box, returns 1; otherwise returns 0. 
  14315.  
  14316.  int 
  14317.  
  14318.  
  14319. ΓòÉΓòÉΓòÉ 2.19.6.2. MSelection::deltaOnlyRange() ΓòÉΓòÉΓòÉ
  14320.  
  14321. deltaOnlyRange(const MSelection *) const 
  14322.  
  14323.       const MSelection *   MSelection to compare to 
  14324.  
  14325.  Is the only difference between the current and the given selections the range? 
  14326.  
  14327.  Returns 1 if so; 0 otherwise. 
  14328.  
  14329.  int 
  14330.  
  14331.  
  14332. ΓòÉΓòÉΓòÉ 2.19.6.3. MSelection::getSelectionContents() ΓòÉΓòÉΓòÉ
  14333.  
  14334. getSelectionContents(MMesaModel *) const 
  14335.  
  14336.       MMesaModel *   Model containing the frame list 
  14337.  
  14338.  If the current active selection is a range, returns the contents of the base 
  14339.  cell in string form. 
  14340.  
  14341.  If the current active selection is a text box, returns its text. 
  14342.  
  14343.  Otherwise, returns an empty string. 
  14344.  
  14345.  char * 
  14346.  
  14347.  
  14348. ΓòÉΓòÉΓòÉ 2.19.6.4. MSelection::getSelectionName() ΓòÉΓòÉΓòÉ
  14349.  
  14350. getSelectionName(MMesaModel *) const 
  14351.  
  14352.       MMesaModel *   Model containing page name and frame list 
  14353.  
  14354.  If the current page is a script, returns the script name. 
  14355.  
  14356.  If one or more frames are selected, returns the name of the first frame. 
  14357.  
  14358.  Otherwise, returns the address of the base cell, in string form. 
  14359.  
  14360.  char * 
  14361.  
  14362.  
  14363. ΓòÉΓòÉΓòÉ 2.19.6.5. MSelection::getSelectionRange()] ΓòÉΓòÉΓòÉ
  14364.  
  14365. getSelectionRange(MMesaModel *, int &)] 
  14366.  
  14367.       MMesaModel *   Model containing page name and frame list 
  14368.  
  14369.       int &   Storage location 
  14370.  
  14371.  If the current page is a script, returns the script name. 
  14372.  
  14373.  If one or more frames are selected, returns the name of the first frame. 
  14374.  
  14375.  Otherwise, returns the address of the selected range in string form and stores 
  14376.  the length of the string. 
  14377.  
  14378.  char * 
  14379.  
  14380.  
  14381. ΓòÉΓòÉΓòÉ 2.19.6.6. MSelection::hasSelection() ΓòÉΓòÉΓòÉ
  14382.  
  14383. hasSelection() const 
  14384.  
  14385. Returns 1 if the selection has any contents, 0 otherwise. 
  14386.  
  14387. int 
  14388.  
  14389.  
  14390. ΓòÉΓòÉΓòÉ 2.19.6.7. MSelection::isZapped() ΓòÉΓòÉΓòÉ
  14391.  
  14392. isZapped() const 
  14393.  
  14394. Returns 1 if the current selection is empty; 0 otherwise. 
  14395.  
  14396. int 
  14397.  
  14398.  
  14399. ΓòÉΓòÉΓòÉ 2.19.7. Writing an MSelection out ΓòÉΓòÉΓòÉ
  14400.  
  14401. Open the Contents view and expand this section to see a list of methods. 
  14402.  
  14403.  
  14404. ΓòÉΓòÉΓòÉ 2.19.7.1. MSelection::write() ΓòÉΓòÉΓòÉ
  14405.  
  14406. write(MStream *st) const 
  14407.  
  14408.       MStream *st   Output stream 
  14409.  
  14410.  Writes all stored values out to st (see MStream). 
  14411.  
  14412.  void 
  14413.  
  14414.  
  14415. ΓòÉΓòÉΓòÉ 2.19.8. MSelection operators ΓòÉΓòÉΓòÉ
  14416.  
  14417. Open the Contents view and expand this section to see a list of methods. 
  14418.  
  14419.  
  14420. ΓòÉΓòÉΓòÉ 2.19.8.1. MSelection::operator=() ΓòÉΓòÉΓòÉ
  14421.  
  14422. operator=(const MSelection &) 
  14423.  
  14424.       const MSelection &   MSelection instance to initialize from 
  14425.  
  14426.  Initialize the instance with values from the given MSelection. 
  14427.  
  14428.  Returns pointer to current MSelection. 
  14429.  
  14430.  MSelection & 
  14431.  
  14432.  operator=(const MSelection *) 
  14433.  
  14434.       const MSelection *   MSelection instance to initialize from 
  14435.  
  14436.  Initialize the instance with values from the given MSelection. 
  14437.  
  14438.  Returns pointer to current MSelection. 
  14439.  
  14440.  MSelection & 
  14441.  
  14442.  
  14443. ΓòÉΓòÉΓòÉ 2.20. MSheetView ΓòÉΓòÉΓòÉ
  14444.  
  14445. sheetview.h is the source file for this class. 
  14446.  
  14447. This class inherits from MView 
  14448.  
  14449. Represents a view into a layer of data, including row and column headers. 
  14450.  
  14451. An MSheetView instance can be created as part of an MMesaView instance (see 
  14452. MMesaView) or can be controlled directly by your application window. In either 
  14453. case, it will both draw a given model on the screen, and handle mouse input to 
  14454. the model. 
  14455.  
  14456. Each MSheetView instance keeps track of: 
  14457.  
  14458.      the Mesa view that contains it (see MMesaView), if any; 
  14459.  
  14460.      the model it displays (see MMesaModel); 
  14461.  
  14462.      the magnification level it should display at; 
  14463.  
  14464.      the current selection within the view (see MSelection); 
  14465.  
  14466.      mouse-input information (what mouse buttons have been pressed, where?); 
  14467.  
  14468.      context-sensitive menus available for the sheet; 
  14469.  
  14470.      whether something is currently being selected. 
  14471.  
  14472.  It also maintains a cache buffer to speed redisplay, and keeps track of the 
  14473.  current context menu and the "superview" window just like any other MView 
  14474.  subclass (see MView). 
  14475.  
  14476.  
  14477. ΓòÉΓòÉΓòÉ 2.20.1. Creating and destroying an MSheetView instance ΓòÉΓòÉΓòÉ
  14478.  
  14479. Open the Contents view and expand this section to see a list of methods. 
  14480.  
  14481.  
  14482. ΓòÉΓòÉΓòÉ 2.20.1.1. MSheetView::MSheetView() ΓòÉΓòÉΓòÉ
  14483.  
  14484. MSheetView(HWND, MMesaModel *, MMesaView *) 
  14485.  
  14486.       HWND   Parent of the sheet 
  14487.  
  14488.       MMesaModel *   Model being viewed 
  14489.  
  14490.       MMesaView *   Application view instance 
  14491.  
  14492.  Passes the parent up the chain to MView, to create the window, and associates 
  14493.  the parameters to their respective instance variables. 
  14494.  
  14495.  void 
  14496.  
  14497.  MSheetView(MWindow *, MMesaModel *, MMesaView *) 
  14498.  
  14499.       MWindow *   Parent of the sheet 
  14500.  
  14501.       MMesaModel *   Model being viewed 
  14502.  
  14503.       MMesaView *   Application view instance. 
  14504.  
  14505.  Passes the parent up the chain to MView, to create the window, and associates 
  14506.  the parameters to their respective instance variables. 
  14507.  
  14508.  void 
  14509.  
  14510.  
  14511. ΓòÉΓòÉΓòÉ 2.20.1.2. MSheetView::~MSheetView() ΓòÉΓòÉΓòÉ
  14512.  
  14513. ~MSheetView() [virtual] 
  14514.  
  14515. Frees any resources allocated, and destroys any menus that are in the instance. 
  14516.  
  14517. void 
  14518.  
  14519.  
  14520. ΓòÉΓòÉΓòÉ 2.20.1.3. MSheetView::setUp() ΓòÉΓòÉΓòÉ
  14521.  
  14522. setUp(const MRect *, int = 0) [virtual] 
  14523.  
  14524.       const MRect *   Size 
  14525.  
  14526.       int   Window style; default is 0. 
  14527.  
  14528.  Loads the popup menus and passes parameters to MView::setUp(), which creates a 
  14529.  new view window of the given size and style. 
  14530.  
  14531.  void 
  14532.  
  14533.  
  14534. ΓòÉΓòÉΓòÉ 2.20.2. Querying the current selection ΓòÉΓòÉΓòÉ
  14535.  
  14536. Open the Contents view and expand this section to see a list of methods. 
  14537.  
  14538.  
  14539. ΓòÉΓòÉΓòÉ 2.20.2.1. MSheetView::canEditContents() ΓòÉΓòÉΓòÉ
  14540.  
  14541. canEditContents() [virtual] 
  14542.  
  14543. Passes through to MSelection::canEditContents() for the current selection, 
  14544. returning 1 if the current selection is editable, 0 otherwise. 
  14545.  
  14546. int 
  14547.  
  14548.  
  14549. ΓòÉΓòÉΓòÉ 2.20.2.2. MSheetView::changedSize() ΓòÉΓòÉΓòÉ
  14550.  
  14551. changedSize(HWND, MChange *) [virtual] 
  14552.  
  14553.       HWND   Unused 
  14554.  
  14555.       MChange *   Unused 
  14556.  
  14557.  If the current selection's base cell or upper-left displayed cell are beyond 
  14558.  the maximum row or column being displayed in that layer, sets the currently 
  14559.  selected range and base cell to A1 of that layer. 
  14560.  
  14561.  Always returns 0. 
  14562.  
  14563.  MRESULT 
  14564.  
  14565.  
  14566. ΓòÉΓòÉΓòÉ 2.20.2.3. MSheetView::getCurAdPtr() ΓòÉΓòÉΓòÉ
  14567.  
  14568. getCurAdPtr() [virtual] 
  14569.  
  14570. Passes through to MSelection::getAdPtr() for the current selection, returning 
  14571. the current base cell. 
  14572.  
  14573. const MAddress * 
  14574.  
  14575.  
  14576. ΓòÉΓòÉΓòÉ 2.20.2.4. MSheetView::getCurLayer() ΓòÉΓòÉΓòÉ
  14577.  
  14578. getCurLayer() [virtual] 
  14579.  
  14580. Passes through to MSelection::getLayer() for the current selection, returning 
  14581. the layer number currently visible. 
  14582.  
  14583. int 
  14584.  
  14585.  
  14586. ΓòÉΓòÉΓòÉ 2.20.2.5. MSheetView::getCurRngPtr() ΓòÉΓòÉΓòÉ
  14587.  
  14588. getCurRngPtr() [virtual] 
  14589.  
  14590. Passes through to MSelection::getRangePtr() for the current selection, 
  14591. returning the current range in the current layer's selection. 
  14592.  
  14593. const MRange * 
  14594.  
  14595.  
  14596. ΓòÉΓòÉΓòÉ 2.20.2.6. MSheetView::getCurSelection() ΓòÉΓòÉΓòÉ
  14597.  
  14598. getCurSelection() [virtual] 
  14599.  
  14600. Returns the current selection. 
  14601.  
  14602. const MSelection * 
  14603.  
  14604.  
  14605. ΓòÉΓòÉΓòÉ 2.20.2.7. MSheetView::getLayerName() ΓòÉΓòÉΓòÉ
  14606.  
  14607. getLayerName() [virtual] 
  14608.  
  14609. Passes through to MSelection::getLayerName() for the current selection, 
  14610. returning the current layer's name. 
  14611.  
  14612. const char * 
  14613.  
  14614.  
  14615. ΓòÉΓòÉΓòÉ 2.20.2.8. MSheetView::getLayerNumber() ΓòÉΓòÉΓòÉ
  14616.  
  14617. getLayerNumber() [virtual] 
  14618.  
  14619. Passes through to MSelection::getLayer() for the current selection, returning 
  14620. the current layer's number. 
  14621.  
  14622. int 
  14623.  
  14624.  
  14625. ΓòÉΓòÉΓòÉ 2.20.2.9. MSheetView::getSelectionContents() ΓòÉΓòÉΓòÉ
  14626.  
  14627. getSelectionContents() [virtual] 
  14628.  
  14629. Passes through to MSelection::getSelectionContents(), returning the string form 
  14630. of the current selection's contents. 
  14631.  
  14632. char * 
  14633.  
  14634.  
  14635. ΓòÉΓòÉΓòÉ 2.20.2.10. MSheetView::getSelectionName() ΓòÉΓòÉΓòÉ
  14636.  
  14637. getSelectionName() [virtual] 
  14638.  
  14639. Passes through to MSelection::getSelectionName(), returning the string form of 
  14640. the current selection's name. 
  14641.  
  14642. char * 
  14643.  
  14644.  
  14645. ΓòÉΓòÉΓòÉ 2.20.2.11. MSheetView::getSelectionRange() ΓòÉΓòÉΓòÉ
  14646.  
  14647. getSelectionRange() [virtual] 
  14648.  
  14649. Passes through to MSelection::getSelectionRange()], returning the string form 
  14650. of the current selection's range. 
  14651.  
  14652. char * 
  14653.  
  14654.  
  14655. ΓòÉΓòÉΓòÉ 2.20.2.12. MSheetView::isScriptSelected() ΓòÉΓòÉΓòÉ
  14656.  
  14657. isScriptSelected() [virtual] 
  14658.  
  14659. Passes through to MSelection::isScriptLayer() for the current selection, 
  14660. returning 1 if the current selection is a script layer, 0 otherwise. 
  14661.  
  14662. int 
  14663.  
  14664.  
  14665. ΓòÉΓòÉΓòÉ 2.20.2.13. MSheetView::isSheetSelected() ΓòÉΓòÉΓòÉ
  14666.  
  14667. isSheetSelected() [virtual] 
  14668.  
  14669. Passes through to MSelection::isSheetLayer() for the current selection, 
  14670. returning 1 if the current selection is a range of data, 0 otherwise. 
  14671.  
  14672. int 
  14673.  
  14674.  
  14675. ΓòÉΓòÉΓòÉ 2.20.3. Changing the current selection ΓòÉΓòÉΓòÉ
  14676.  
  14677. Open the Contents view and expand this section to see a list of methods. 
  14678.  
  14679.  
  14680. ΓòÉΓòÉΓòÉ 2.20.3.1. MSheetView::deselectFrames() ΓòÉΓòÉΓòÉ
  14681.  
  14682. deselectFrames() [virtual] 
  14683.  
  14684. Removes all frames from the current selection and redisplays the previously 
  14685. selected frame. 
  14686.  
  14687. void 
  14688.  
  14689.  
  14690. ΓòÉΓòÉΓòÉ 2.20.3.2. MSheetView::extendSelection() ΓòÉΓòÉΓòÉ
  14691.  
  14692. extendSelection(MAddress *tmp) [virtual] 
  14693.  
  14694.       MAddress *tmp   Corner to extend selection to 
  14695.  
  14696.  Extends the current selection to include the given address. 
  14697.  
  14698.  void 
  14699.  
  14700.  
  14701. ΓòÉΓòÉΓòÉ 2.20.3.3. MSheetView::select() ΓòÉΓòÉΓòÉ
  14702.  
  14703. select(const MSelection *) [virtual] 
  14704.  
  14705.       const MSelection *   New selection 
  14706.  
  14707.  Sets the current selection to the given value. 
  14708.  
  14709.  void 
  14710.  
  14711.  select(const char *) [virtual] 
  14712.  
  14713.       const char *   Frame name 
  14714.  
  14715.  Passes through to MSelection::setFrameSelection() for the current selection, 
  14716.  setting the current selection tot he named frame. 
  14717.  
  14718.  void 
  14719.  
  14720.  
  14721. ΓòÉΓòÉΓòÉ 2.20.3.4. MSheetView::setAddressAndRange() ΓòÉΓòÉΓòÉ
  14722.  
  14723. setAddressAndRange(const MAddress *, const MRange *) [virtual] 
  14724.  
  14725.       const MAddress *   New address 
  14726.  
  14727.       const MRange *   New range 
  14728.  
  14729.  Sets the currently selected address and range to the given values. 
  14730.  
  14731.  void 
  14732.  
  14733.  
  14734. ΓòÉΓòÉΓòÉ 2.20.3.5. MSheetView::setCurAd() ΓòÉΓòÉΓòÉ
  14735.  
  14736. setCurAd(const MAddress *) [virtual] 
  14737.  
  14738.       const MAddress *   Address to make current 
  14739.  
  14740.  Sets the currently selected address. If editing a formula, stores the address 
  14741.  (in string format) in the edit view and updates the edit view. 
  14742.  
  14743.  void 
  14744.  
  14745.  
  14746. ΓòÉΓòÉΓòÉ 2.20.3.6. MSheetView::setCurRange() ΓòÉΓòÉΓòÉ
  14747.  
  14748. setCurRange(const MRange *) [virtual] 
  14749.  
  14750.       const MRange *   Range to make current 
  14751.  
  14752.  Sets the currently selected range, and updates other windows as needed. 
  14753.  
  14754.  void 
  14755.  
  14756.  
  14757. ΓòÉΓòÉΓòÉ 2.20.3.7. MSheetView::setLayer() ΓòÉΓòÉΓòÉ
  14758.  
  14759. setLayer(int) [virtual] 
  14760.  
  14761.       int   New layer 
  14762.  
  14763.  Sets the layer being displayed and updates other windows and views as needed. 
  14764.  
  14765.  void 
  14766.  
  14767.  
  14768. ΓòÉΓòÉΓòÉ 2.20.3.8. MSheetView::setSelection() ΓòÉΓòÉΓòÉ
  14769.  
  14770. setSelection(const MSelection *) [virtual] 
  14771.  
  14772.       const MSelection *   MSelection instance to make current 
  14773.  
  14774.  Notifies all parent windows that a layer change is about to occur if 
  14775.  necessary, then sets the current selection to the given selection. 
  14776.  
  14777.  void 
  14778.  
  14779.  
  14780. ΓòÉΓòÉΓòÉ 2.20.3.9. MSheetView::setToNullSelectedRange() ΓòÉΓòÉΓòÉ
  14781.  
  14782. setToNullSelectedRange() [virtual] 
  14783.  
  14784. Clears the current selected range while keeping the current base cell 
  14785. unchanged. 
  14786.  
  14787. void 
  14788.  
  14789.  
  14790. ΓòÉΓòÉΓòÉ 2.20.4. Handling input to the view ΓòÉΓòÉΓòÉ
  14791.  
  14792. Open the Contents view and expand this section to see a list of methods. 
  14793.  
  14794.  
  14795. ΓòÉΓòÉΓòÉ 2.20.4.1. MSheetView::bkgColorDroppedAt() ΓòÉΓòÉΓòÉ
  14796.  
  14797. bkgColorDroppedAt(MColor, int, int) [virtual] 
  14798.  
  14799.       MColor   Color dropped on sheet 
  14800.  
  14801.       int   X coordinate of location dropped 
  14802.  
  14803.       int   Y coordinate of location dropped 
  14804.  
  14805.  Determines what sort of item the color was dropped on (a frame, a range, etc.) 
  14806.  and routes the event accordingly, setting the item's background color to the 
  14807.  given color. 
  14808.  
  14809.  void 
  14810.  
  14811.  
  14812. ΓòÉΓòÉΓòÉ 2.20.4.2. MSheetView::colorDroppedAt() ΓòÉΓòÉΓòÉ
  14813.  
  14814. colorDroppedAt(MColor, int, int) [virtual] 
  14815.  
  14816.       MColor   Color dropped on sheet 
  14817.  
  14818.       int   X coordinate of location dropped 
  14819.  
  14820.       int   Y coordinate of location dropped 
  14821.  
  14822.  Determines what sort of item the color was dropped on (a frame, a range, etc.) 
  14823.  and routes the event accordingly, setting the item's foreground color to the 
  14824.  given color. 
  14825.  
  14826.  void 
  14827.  
  14828.  
  14829. ΓòÉΓòÉΓòÉ 2.20.4.3. MSheetView::dragDrop() ΓòÉΓòÉΓòÉ
  14830.  
  14831. dragDrop(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  14832.  
  14833.             HWND   Unused
  14834.  
  14835.       ULONG   Unused 
  14836.  
  14837.       MPARAM   Items being dropped - bitmaps or metafiles 
  14838.  
  14839.       MPARAM   Unused 
  14840.  
  14841.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  14842.       passed to default window handler.) 
  14843.  
  14844.  Determines what to do for each item dropped onto the sheet view, and sets the 
  14845.  processing flag to 1. 
  14846.  
  14847.  Always returns 0. 
  14848.  
  14849.  MRESULT 
  14850.  
  14851.  
  14852. ΓòÉΓòÉΓòÉ 2.20.4.4. MSheetView::dragOver() ΓòÉΓòÉΓòÉ
  14853.  
  14854. dragOver(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  14855.  
  14856.             HWND   Unused
  14857.  
  14858.       ULONG   Unused 
  14859.  
  14860.       MPARAM   Items being dropped - bitmaps or metafiles 
  14861.  
  14862.       MPARAM   X,Y coordinates of current location 
  14863.  
  14864.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  14865.       passed to default window handler.) 
  14866.  
  14867.  Determines whether the items being dragged over the sheet can be dropped onto 
  14868.  the sheet at the given point, passes the appropriate message to OS/2, and sets 
  14869.  the handled/processed flag to 1. 
  14870.  
  14871.  MRESULT 
  14872.  
  14873.  
  14874. ΓòÉΓòÉΓòÉ 2.20.4.5. MSheetView::fontDroppedAt() ΓòÉΓòÉΓòÉ
  14875.  
  14876. fontDroppedAt(const MFont *, int, int) [virtual] 
  14877.  
  14878.       const MFont *   Font dropped 
  14879.  
  14880.       int   X coordinate where it was dropped 
  14881.  
  14882.       int   Y coordinate where it was dropped 
  14883.  
  14884.  Determines what part of the view the font was dropped on, and either passes 
  14885.  through to the appropriate subsection (e.g; if the font was dropped on a 
  14886.  frame), or changes the font directly if dropped on a cell or the selected 
  14887.  range. 
  14888.  
  14889.  void 
  14890.  
  14891.  
  14892. ΓòÉΓòÉΓòÉ 2.20.4.6. MSheetView::handleChar() ΓòÉΓòÉΓòÉ
  14893.  
  14894. handleChar(int, int, int &) [virtual] 
  14895.  
  14896.       int   Character entered 
  14897.  
  14898.       int   Flags set 
  14899.  
  14900.       int &   Was the character processed? 1 for yes, 0 for no. 
  14901.  
  14902.  Handles the keystrokes for arrow keys, navigation, and so forth. 
  14903.  
  14904.  MRESULT 
  14905.  
  14906.  
  14907. ΓòÉΓòÉΓòÉ 2.20.4.7. MSheetView::handleMouse2Motion() ΓòÉΓòÉΓòÉ
  14908.  
  14909. handleMouse2Motion(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  14910.  
  14911.             HWND   Unused
  14912.  
  14913.       ULONG   Unused 
  14914.  
  14915.       MPARAM   X and Y coordinates of mouse-pointer location 
  14916.  
  14917.       MPARAM   Unused 
  14918.  
  14919.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  14920.       passed to default window handler.) 
  14921.  
  14922.  Handles the mouse action as appopriate, based on the current application state 
  14923.  (i.e. are we editing a formula? copying a range? etc.) and the location of the 
  14924.  mouse action (e.g; a range or a frame). Sets the handled flag to 1 if the 
  14925.  action is handled. 
  14926.  
  14927.  MRESULT 
  14928.  
  14929.  
  14930. ΓòÉΓòÉΓòÉ 2.20.4.8. MSheetView::mouse1Click() ΓòÉΓòÉΓòÉ
  14931.  
  14932. mouse1Click(const MPoint *, int, int &) [virtual] 
  14933.  
  14934.       const MPoint *   Unused 
  14935.  
  14936.       int   Unused 
  14937.  
  14938.       int &   Unused 
  14939.  
  14940.  Does nothing. 
  14941.  
  14942.  void 
  14943.  
  14944.  
  14945. ΓòÉΓòÉΓòÉ 2.20.4.9. MSheetView::mouse1Down() ΓòÉΓòÉΓòÉ
  14946.  
  14947. mouse1Down(const MPoint *, int, int &) [virtual] 
  14948.  
  14949.       const MPoint *   Point the mouse went down at 
  14950.  
  14951.       int   Key flags 
  14952.  
  14953.       int &   Unused 
  14954.  
  14955.  Stores the position and flags, and passes through to 
  14956.  MSheetView::mouse1MotionStart(). 
  14957.  
  14958.  void 
  14959.  
  14960.  
  14961. ΓòÉΓòÉΓòÉ 2.20.4.10. MSheetView::mouse1MotionEnd() ΓòÉΓòÉΓòÉ
  14962.  
  14963. mouse1MotionEnd(int &) [virtual] 
  14964.  
  14965.       int &   Was it handled? 1 for yes, 0 for no. 
  14966.  
  14967.  If the mouse is currently being used to select an object or resize a row or 
  14968.  column, handles the operation and sets the handled flag to 1. Otherwise does 
  14969.  nothing. 
  14970.  
  14971.  void 
  14972.  
  14973.  
  14974. ΓòÉΓòÉΓòÉ 2.20.4.11. MSheetView::mouse1MotionStart() ΓòÉΓòÉΓòÉ
  14975.  
  14976. mouse1MotionStart(int &) [virtual] 
  14977.  
  14978.       int &   Was it handled? 1 for yes, 0 for no. 
  14979.  
  14980.  Based on the mouse position and the view's state, determines what action is 
  14981.  being initiated. Sets internal values accordingly. 
  14982.  
  14983.  void 
  14984.  
  14985.  
  14986. ΓòÉΓòÉΓòÉ 2.20.4.12. MSheetView::mouse1Up() ΓòÉΓòÉΓòÉ
  14987.  
  14988. mouse1Up(const MPoint *, int, int &) [virtual] 
  14989.  
  14990.       const MPoint *   Unused 
  14991.  
  14992.       int   Unused 
  14993.  
  14994.       int &   Was it handled? 1 for yes, 0 for no. 
  14995.  
  14996.  If a selection process was occuring, passes through to 
  14997.  MSheetView::mouse1MotionEnd(). 
  14998.  
  14999.  void 
  15000.  
  15001.  
  15002. ΓòÉΓòÉΓòÉ 2.20.4.13. MSheetView::mouse2Down() ΓòÉΓòÉΓòÉ
  15003.  
  15004. mouse2Down(const MPoint *, int, int &) [virtual] 
  15005.  
  15006.       const MPoint *   Point the mouse went down at 
  15007.  
  15008.       int   Key flags 
  15009.  
  15010.       int &   Unused 
  15011.  
  15012.  Stores the position and flags, and passes through to 
  15013.  MSheetView::mouse2MotionStart(). 
  15014.  
  15015.  void 
  15016.  
  15017.  
  15018. ΓòÉΓòÉΓòÉ 2.20.4.14. MSheetView::mouse2MotionEnd() ΓòÉΓòÉΓòÉ
  15019.  
  15020. mouse2MotionEnd(int &) [virtual] 
  15021.  
  15022.       int &   Was it handled? 1 for yes, 0 for no. 
  15023.  
  15024.  If the mouse is currently being used to select an object or resize a row or 
  15025.  column, handles the operation and sets the handled flag to 1. Otherwise does 
  15026.  nothing. 
  15027.  
  15028.  void 
  15029.  
  15030.  
  15031. ΓòÉΓòÉΓòÉ 2.20.4.15. MSheetView::mouse2MotionStart() ΓòÉΓòÉΓòÉ
  15032.  
  15033. mouse2MotionStart(int &) [virtual] 
  15034.  
  15035.       int &   Was it handled? 1 for yes, 0 for no. 
  15036.  
  15037.  Based on the mouse position and the view's state, determines what action is 
  15038.  being initiated. Sets internal values accordingly. 
  15039.  
  15040.  void 
  15041.  
  15042.  
  15043. ΓòÉΓòÉΓòÉ 2.20.4.16. MSheetView::mouse2Up() ΓòÉΓòÉΓòÉ
  15044.  
  15045. mouse2Up(const MPoint *, int, int &) [virtual] 
  15046.  
  15047.       const MPoint *   Unused 
  15048.  
  15049.       int   Unused 
  15050.  
  15051.       int &   Was it handled? 1 for yes, 0 for no. 
  15052.  
  15053.  If a selection process was occuring, passes through to 
  15054.  MSheetView::mouse2MotionEnd(). 
  15055.  
  15056.  void 
  15057.  
  15058.  
  15059. ΓòÉΓòÉΓòÉ 2.20.4.17. MSheetView::winContextMenu() ΓòÉΓòÉΓòÉ
  15060.  
  15061. winContextMenu(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  15062.  
  15063.             HWND   Unused
  15064.  
  15065.       ULONG   Unused 
  15066.  
  15067.       MPARAM   X and Y OS/2 window coordinates of point 
  15068.  
  15069.       MPARAM   Unused 
  15070.  
  15071.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  15072.       passed to default window handler.) 
  15073.  
  15074.  Determines what part of the sheet view - row headers, column headers, selected 
  15075.  range, frame, etc. - lies under the given point, stores the appropriate 
  15076.  context menu, and passes the given parameters to MView::winContextMenu() to 
  15077.  show the menu. 
  15078.  
  15079.  Always returns 1. 
  15080.  
  15081.  MRESULT 
  15082.  
  15083.  
  15084. ΓòÉΓòÉΓòÉ 2.20.4.18. MSheetView::winMouseMove() ΓòÉΓòÉΓòÉ
  15085.  
  15086. winMouseMove(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  15087.  
  15088.       HWND   Window handle
  15089.  
  15090.       ULONG   Message 
  15091.  
  15092.       MPARAM   X and Y OS/2 window coordinates of point 
  15093.  
  15094.       MPARAM   Unused 
  15095.  
  15096.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  15097.       passed to default window handler.) 
  15098.  
  15099.  Based on the type of mouse action and the internal state of the view, handles 
  15100.  the action appropriately. 
  15101.  
  15102.  MRESULT 
  15103.  
  15104.  
  15105. ΓòÉΓòÉΓòÉ 2.20.5. Handling view display and redisplay ΓòÉΓòÉΓòÉ
  15106.  
  15107. Open the Contents view and expand this section to see a list of methods. 
  15108.  
  15109.  
  15110. ΓòÉΓòÉΓòÉ 2.20.5.1. MSheetView::bufferWindow() ΓòÉΓòÉΓòÉ
  15111.  
  15112. bufferWindow() [virtual] 
  15113.  
  15114. Is this window to be buffered (see MWindow::bufferWindow())? 
  15115.  
  15116. Always returns 1. 
  15117.  
  15118. int 
  15119.  
  15120.  
  15121. ΓòÉΓòÉΓòÉ 2.20.5.2. MSheetView::displayAddress() ΓòÉΓòÉΓòÉ
  15122.  
  15123. displayAddress(const MAddress *) [virtual] 
  15124.  
  15125.       const MAddress *   Address of the cell to display 
  15126.  
  15127.  If the given cell is displayed within the sheet view, redisplay it. 
  15128.  
  15129.  void 
  15130.  
  15131.  
  15132. ΓòÉΓòÉΓòÉ 2.20.5.3. MSheetView::displayFrame() ΓòÉΓòÉΓòÉ
  15133.  
  15134. displayFrame(const char *) 
  15135.  
  15136.       const char *   Frame name 
  15137.  
  15138.  If the given frame is displayed within the sheet view, redisplay it. 
  15139.  
  15140.  void 
  15141.  
  15142.  
  15143. ΓòÉΓòÉΓòÉ 2.20.5.4. MSheetView::displayRange() ΓòÉΓòÉΓòÉ
  15144.  
  15145. displayRange(const MRange *) [virtual] 
  15146.  
  15147.       const MRange *   MRange to show 
  15148.  
  15149.  If any cell in the given frame is displayed within the sheet view, redisplay 
  15150.  it. 
  15151.  
  15152.  void 
  15153.  
  15154.  
  15155. ΓòÉΓòÉΓòÉ 2.20.5.5. MSheetView::displayRangeDiff() ΓòÉΓòÉΓòÉ
  15156.  
  15157. displayRangeDiff(const MRange *, const MRange *) [virtual] 
  15158.  
  15159.       const MRange *   Range 1 
  15160.  
  15161.       const MRange *   Range 2 
  15162.  
  15163.  If any cell in one, but not both, of the given ranges is displayed within the 
  15164.  sheet view, redisplay it. 
  15165.  
  15166.  void 
  15167.  
  15168.  
  15169. ΓòÉΓòÉΓòÉ 2.20.5.6. MSheetView::displaySelectionDiff() ΓòÉΓòÉΓòÉ
  15170.  
  15171. displaySelectionDiff(const MSelection *, const MSelection *) [virtual] 
  15172.  
  15173.       const MSelection *   Selection 1 
  15174.  
  15175.       const MSelection *   Selection 2 
  15176.  
  15177.  If the two selections are ranges, passes the range pointers through to 
  15178.  MSheetView::displayRangeDiff(). Otherwise, redisplays the entire sheet. 
  15179.  
  15180.  void 
  15181.  
  15182.  
  15183. ΓòÉΓòÉΓòÉ 2.20.5.7. MSheetView::drawSelf() ΓòÉΓòÉΓòÉ
  15184.  
  15185. drawSelf(MDraw *, const MRect *) [virtual] 
  15186.  
  15187.       MDraw *   Region to draw to 
  15188.  
  15189.       const MRect *   Clipping rectangle 
  15190.  
  15191.  Draws the sheet to the draw region, clipped to within the clipping rectangle 
  15192.  provided (see MWindow::drawSelf()). 
  15193.  
  15194.  Always returns 1. 
  15195.  
  15196.  int 
  15197.  
  15198.  
  15199. ΓòÉΓòÉΓòÉ 2.20.5.8. MSheetView::getDrawScale() ΓòÉΓòÉΓòÉ
  15200.  
  15201. getDrawScale() [virtual] 
  15202.  
  15203. Returns 1 if the current magnification is 100%, and 32 otherwise. 
  15204.  
  15205. float 
  15206.  
  15207.  
  15208. ΓòÉΓòÉΓòÉ 2.20.5.9. MSheetView::getUpperLeft() ΓòÉΓòÉΓòÉ
  15209.  
  15210. getUpperLeft() [virtual] 
  15211.  
  15212. Passes through to MSelection::getUpperLeftPtr() for the current selection, 
  15213. returning the address of of the upper-left cell currently being displayed. 
  15214.  
  15215. const MAddress * 
  15216.  
  15217.  
  15218. ΓòÉΓòÉΓòÉ 2.20.5.10. MSheetView::getUpperLeftColumn() ΓòÉΓòÉΓòÉ
  15219.  
  15220. getUpperLeftColumn() [virtual] 
  15221.  
  15222. Passes through to MSelection::getUpperLeftColumn() for the current selection, 
  15223. returning the left-most column currently being displayed. 
  15224.  
  15225. int 
  15226.  
  15227.  
  15228. ΓòÉΓòÉΓòÉ 2.20.5.11. MSheetView::getUpperLeftRow() ΓòÉΓòÉΓòÉ
  15229.  
  15230. getUpperLeftRow() [virtual] 
  15231.  
  15232. Passes through to MSelection::getUpperLeftRow() for the current selection, 
  15233. returning the upper-most row currently being displayed. 
  15234.  
  15235. int 
  15236.  
  15237.  
  15238. ΓòÉΓòÉΓòÉ 2.20.5.12. MSheetView::getViewScale() ΓòÉΓòÉΓòÉ
  15239.  
  15240. getViewScale() [virtual] 
  15241.  
  15242. Returns the current magnification. 
  15243.  
  15244. float 
  15245.  
  15246.  
  15247. ΓòÉΓòÉΓòÉ 2.20.5.13. MSheetView::scrollFrom() ΓòÉΓòÉΓòÉ
  15248.  
  15249. scrollFrom(int, int) [virtual] 
  15250.  
  15251.       int   Row 
  15252.  
  15253.       int   Column 
  15254.  
  15255.  Scrolls the sheet so that the cell at the given row and column appears at the 
  15256.  upper left of the cell, then redisplays as needed. 
  15257.  
  15258.  void 
  15259.  
  15260.  
  15261. ΓòÉΓòÉΓòÉ 2.20.5.14. MSheetView::scrollToVisible() ΓòÉΓòÉΓòÉ
  15262.  
  15263. scrollToVisible(const MAddress *, int = 0) [virtual] 
  15264.  
  15265.       const MAddress *   Address to display 
  15266.  
  15267.       int   Actually scroll? 1 to scroll, 0 to not scroll. Default is 0. 
  15268.  
  15269.  Determines the necessary offset to make the given cell appear in the sheet 
  15270.  view (and scrolling if appropriate). Returns 1 if there is an offset necessary 
  15271.  to display the given cell, 0 otherwise. (In other words, returns 0 if the 
  15272.  given cell is already being displayed.) 
  15273.  
  15274.  int 
  15275.  
  15276.  
  15277. ΓòÉΓòÉΓòÉ 2.20.5.15. MSheetView::setUpperLeftColumn() ΓòÉΓòÉΓòÉ
  15278.  
  15279. setUpperLeftColumn(int) [virtual] 
  15280.  
  15281.       int   New upper left column 
  15282.  
  15283.  Sets the left column of the displayed area to the given column. 
  15284.  
  15285.  void 
  15286.  
  15287.  
  15288. ΓòÉΓòÉΓòÉ 2.20.5.16. MSheetView::setUpperLeftRow() ΓòÉΓòÉΓòÉ
  15289.  
  15290. setUpperLeftRow(int) [virtual] 
  15291.  
  15292.       int   New upper left row 
  15293.  
  15294.  Sets the top row of the displayed area to the given row. 
  15295.  
  15296.  void 
  15297.  
  15298.  
  15299. ΓòÉΓòÉΓòÉ 2.20.5.17. MSheetView::setViewScale() ΓòÉΓòÉΓòÉ
  15300.  
  15301. setViewScale(float s) [virtual] 
  15302.  
  15303.       float s   New magnification. 
  15304.  
  15305.  Sets the magnification of the sheet view. 
  15306.  
  15307.  void 
  15308.  
  15309.  
  15310. ΓòÉΓòÉΓòÉ 2.20.6. Querying an MSheetView instance ΓòÉΓòÉΓòÉ
  15311.  
  15312. Open the Contents view and expand this section to see a list of methods. 
  15313.  
  15314.  
  15315. ΓòÉΓòÉΓòÉ 2.20.6.1. MSheetView::getMesaView() ΓòÉΓòÉΓòÉ
  15316.  
  15317. getMesaView() [virtual] 
  15318.  
  15319. Returns a pointer to the Mesa view that controls this sheet view, if any. For 
  15320. more information, see "MMesaView". 
  15321.  
  15322. MMesaView * 
  15323.  
  15324.  
  15325. ΓòÉΓòÉΓòÉ 2.20.6.2. MSheetView::hasDrawSelf() ΓòÉΓòÉΓòÉ
  15326.  
  15327. hasDrawSelf() [virtual] 
  15328.  
  15329. Always returns 1, indicating that MSheetView has a drawSelf() method (see 
  15330. MWindow::hasDrawSelf()). 
  15331.  
  15332. int 
  15333.  
  15334.  
  15335. ΓòÉΓòÉΓòÉ 2.20.6.3. MSheetView::isEditing() ΓòÉΓòÉΓòÉ
  15336.  
  15337. isEditing() [virtual] 
  15338.  
  15339. Passes through to MMesaView::isEditing() for the Mesa view, returning 1 if 
  15340. editing, 0 if not. 
  15341.  
  15342. int 
  15343.  
  15344.  
  15345. ΓòÉΓòÉΓòÉ 2.20.6.4. MSheetView::isEditingFormula() ΓòÉΓòÉΓòÉ
  15346.  
  15347. isEditingFormula() [virtual] 
  15348.  
  15349. Passes through to MMesaView::isEditingFormula() for the Mesa view, returning 1 
  15350. if editing a formula, 0 if not. 
  15351.  
  15352. int 
  15353.  
  15354.  
  15355. ΓòÉΓòÉΓòÉ 2.20.7. Transforming between view and layer coordinate frames ΓòÉΓòÉΓòÉ
  15356.  
  15357. Open the Contents view and expand this section to see a list of methods. 
  15358.  
  15359.  
  15360. ΓòÉΓòÉΓòÉ 2.20.7.1. MSheetView::transformFromSheetToView() ΓòÉΓòÉΓòÉ
  15361.  
  15362. transformFromSheetToView(MRect *, MRect * = NULL) [virtual] 
  15363.  
  15364.       MRect *   Rectangle to be transformed 
  15365.  
  15366.       MRect *   Client window rectangle. Default is NULL (will be recalculated 
  15367.       automatically) 
  15368.  
  15369.  Transforms the first given rectangle from layer coordinates (relative to the 
  15370.  upper left ot A1) to view coordinates (relative to upper left of view), 
  15371.  applying any scaling factors and transformations that are needed. 
  15372.  
  15373.  void 
  15374.  
  15375.  
  15376. ΓòÉΓòÉΓòÉ 2.20.7.2. MSheetView::transformPoint() ΓòÉΓòÉΓòÉ
  15377.  
  15378. transformPoint(MPoint *, MRect * = NULL) [virtual] 
  15379.  
  15380.       MPoint *   Point to transform 
  15381.  
  15382.       MRect *   View rectangle to transform into. Defaults to null. 
  15383.  
  15384.  Transforms a point from OS/2 window coordinates to frame coordinates. If view 
  15385.  rectangle is not given, queries the client window of the sheet. Offsets the 
  15386.  point within that rectangle, and then performs any scaling necessary on it. 
  15387.  
  15388.  void 
  15389.  
  15390.  
  15391. ΓòÉΓòÉΓòÉ 2.20.7.3. MSheetView::transformFromViewToSheet() ΓòÉΓòÉΓòÉ
  15392.  
  15393. transformFromViewToSheet(MRect *, MRect * = NULL) [virtual] 
  15394.  
  15395.       MRect *   Rectangle to be transformed 
  15396.  
  15397.       MRect *   Client window rectangle. Default is NULL (will be recalculated 
  15398.       automatically) 
  15399.  
  15400.  Transforms the first given rectangle from view coordinates (relative to upper 
  15401.  left of view) to layer coordinates (relative to the upper left ot A1), 
  15402.  applying any scaling factors and transformations that are needed. 
  15403.  
  15404.  void 
  15405.  
  15406.  
  15407. ΓòÉΓòÉΓòÉ 2.20.8. Handling row and column headers ΓòÉΓòÉΓòÉ
  15408.  
  15409. Open the Contents view and expand this section to see a list of methods. 
  15410.  
  15411.  
  15412. ΓòÉΓòÉΓòÉ 2.20.8.1. MSheetView::setColumnTitleHeight() ΓòÉΓòÉΓòÉ
  15413.  
  15414. setColumnTitleHeight(int) [virtual] 
  15415.  
  15416.       int   New height of column headings 
  15417.  
  15418.   Sets the height of the title above each column. 
  15419.  
  15420.   void 
  15421.  
  15422.  
  15423. ΓòÉΓòÉΓòÉ 2.20.8.2. MSheetView::setColumnTitles() ΓòÉΓòÉΓòÉ
  15424.  
  15425. setColumnTitles(const char **title, int numTitle) [virtual] 
  15426.  
  15427.       const char **title   List of titles for column headings 
  15428.  
  15429.       int numTitle   How many titles in the list? 
  15430.  
  15431.   Sets the text of the given number of column headings to the given titles. 
  15432.  
  15433.   void 
  15434.  
  15435.  
  15436. ΓòÉΓòÉΓòÉ 2.20.8.3. MSheetView::setRowTitleWidth() ΓòÉΓòÉΓòÉ
  15437.  
  15438. setRowTitleWidth(int) [virtual] 
  15439.  
  15440.       int   New width of row headings 
  15441.  
  15442.   Sets the width of the row headings. 
  15443.  
  15444.   void 
  15445.  
  15446.  
  15447. ΓòÉΓòÉΓòÉ 2.20.9. Other methods ΓòÉΓòÉΓòÉ
  15448.  
  15449. Open the Contents view and expand this section to see a list of methods. 
  15450.  
  15451.  
  15452. ΓòÉΓòÉΓòÉ 2.20.9.1. MSheetView::newShape() ΓòÉΓòÉΓòÉ
  15453.  
  15454. newShape(int, const char *, int, int, int, int, int, int) [virtual] 
  15455.  
  15456.       int    Type of shape (see "Shape and imported graphic type constants") 
  15457.  
  15458.       const MAddress *   Anchor cell 
  15459.  
  15460.       int    X start position, offset from the address passed in 
  15461.  
  15462.       int   X start position, offset from the address passed in 
  15463.  
  15464.       int   Width 
  15465.  
  15466.       int   Height 
  15467.  
  15468.       int   Line width 
  15469.  
  15470.       int    Line type (arrowheads) 
  15471.  
  15472.  Passes through to MMesaModel::newShape(), creating a new shape in the 
  15473.  associated model. 
  15474.  
  15475.  void 
  15476.  
  15477.  
  15478. ΓòÉΓòÉΓòÉ 2.20.9.2. MSheetView::setCursor() ΓòÉΓòÉΓòÉ
  15479.  
  15480. setCursor(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  15481.  
  15482.             HWND   Unused
  15483.  
  15484.       ULONG   Unused 
  15485.  
  15486.       MPARAM   Unused 
  15487.  
  15488.       MPARAM   Unused 
  15489.  
  15490.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  15491.       passed to default window handler.) 
  15492.  
  15493.  Returns 0. 
  15494.  
  15495.  MRESULT 
  15496.  
  15497.  
  15498. ΓòÉΓòÉΓòÉ 2.21. MStream ΓòÉΓòÉΓòÉ
  15499.  
  15500. stream.h is the source file for this class. 
  15501.  
  15502. This class inherits from MObject 
  15503.  
  15504. Handles input and output in a platform-independant fashion. 
  15505.  
  15506. There are two subclasses of MStream defined within Mesa DOK - one to handle 
  15507. clipboard I/O (see MClipStream) and one to handle file I/O (see MFileStream). 
  15508. They behave identically on the application side, which allows other classes to 
  15509. write themselves out to and read themselves in from a "stream" of data without 
  15510. worrying about the details of the I/O device being used. You can subclass 
  15511. MStream within your own application to handle application-specific I/O in the 
  15512. same way. 
  15513.  
  15514. Most Mesa DOK classes can accept an MStream parameter for input or output. When 
  15515. an item is written to a stream, it should include an identifier, followed by 
  15516. the position in the stream of the next item (this allows stream-reading 
  15517. functions to simply skip over items they wish to ignore), followed by the item 
  15518. itself. The stream-output methods of each class are responsible for writing the 
  15519. items out a way that can be read by the appropriate stream-input methods; 
  15520. MStream itself does nothing but transfer the bits from one place to another. 
  15521.  
  15522. Each MStream subclass instance keeps track of its current position within the 
  15523. stream, and of the position of the next element in the stream (so that the 
  15524. current element can be skipped over). It also contains an exception, used to 
  15525. pass error messages back and forth (see MException) and a version number, which 
  15526. is not currently used for anything. 
  15527.  
  15528.  
  15529. ΓòÉΓòÉΓòÉ 2.21.1. Creating and destroying an MStream instance ΓòÉΓòÉΓòÉ
  15530.  
  15531. Open the Contents view and expand this section to see a list of methods. 
  15532.  
  15533.  
  15534. ΓòÉΓòÉΓòÉ 2.21.1.1. MStream::MStream() ΓòÉΓòÉΓòÉ
  15535.  
  15536. MStream() 
  15537.  
  15538. Sets the version to 0. 
  15539.  
  15540. void 
  15541.  
  15542.  
  15543. ΓòÉΓòÉΓòÉ 2.21.1.2. MStream::~MStream() ΓòÉΓòÉΓòÉ
  15544.  
  15545. ~MStream() [virtual] 
  15546.  
  15547. Frees any allocated resources. 
  15548.  
  15549. void 
  15550.  
  15551.  
  15552. ΓòÉΓòÉΓòÉ 2.21.2. Reading values ΓòÉΓòÉΓòÉ
  15553.  
  15554. Open the Contents view and expand this section to see a list of methods. 
  15555.  
  15556.  
  15557. ΓòÉΓòÉΓòÉ 2.21.2.1. MStream::endRead() ΓòÉΓòÉΓòÉ
  15558.  
  15559. endRead() 
  15560.  
  15561. Moves to the next element in the stream, possibly skipping the current element. 
  15562.  
  15563. void 
  15564.  
  15565.  
  15566. ΓòÉΓòÉΓòÉ 2.21.2.2. MStream::read()=0 ΓòÉΓòÉΓòÉ
  15567.  
  15568. read(void *, int) = 0[virtual] 
  15569.  
  15570.       void *   Buffer to read into 
  15571.  
  15572.       int   Number of bytes to read 
  15573.  
  15574.  Does nothing; however, every class that inherits from MStream must implement 
  15575.  this method to read a specified number of bytes from the stream into the 
  15576.  buffer. 
  15577.  
  15578.  Returns the number of bytes read. 
  15579.  
  15580.  int 
  15581.  
  15582.  
  15583. ΓòÉΓòÉΓòÉ 2.21.2.3. MStream::readChar() ΓòÉΓòÉΓòÉ
  15584.  
  15585. readChar() 
  15586.  
  15587. Reads an appropriate number of bytes for a single character, and returns that 
  15588. value. 
  15589.  
  15590. int 
  15591.  
  15592.  
  15593. ΓòÉΓòÉΓòÉ 2.21.2.4. MStream::readInt() ΓòÉΓòÉΓòÉ
  15594.  
  15595. readInt() 
  15596.  
  15597. Reads an appropriate number of bytes for an integer, and returns that value. 
  15598.  
  15599. int 
  15600.  
  15601.  
  15602. ΓòÉΓòÉΓòÉ 2.21.2.5. MStream::readLong() ΓòÉΓòÉΓòÉ
  15603.  
  15604. readLong() 
  15605.  
  15606. Reads an appropriate number of bytes for a long integer, and returns that 
  15607. value. 
  15608.  
  15609. long 
  15610.  
  15611.  
  15612. ΓòÉΓòÉΓòÉ 2.21.2.6. MStream::readLongDouble() ΓòÉΓòÉΓòÉ
  15613.  
  15614. readLongDouble() 
  15615.  
  15616. Reads an appropriate number of bytes for a long double, and returns that value. 
  15617.  
  15618. long double 
  15619.  
  15620.  
  15621. ΓòÉΓòÉΓòÉ 2.21.2.7. MStream::readNumber() ΓòÉΓòÉΓòÉ
  15622.  
  15623. readNumber() 
  15624.  
  15625. Reads an appropriate number of bytes for a double, and returns that value. 
  15626.  
  15627. double 
  15628.  
  15629.  
  15630. ΓòÉΓòÉΓòÉ 2.21.2.8. MStream::readPointer() ΓòÉΓòÉΓòÉ
  15631.  
  15632. readPointer() 
  15633.  
  15634. Reads an appropriate number of bytes for a pointer, and returns that value. 
  15635. Note that the stream actually writes and reads the address, and so this method 
  15636. is only useful for pointers to structures that are in the same place as they 
  15637. were when they were written. 
  15638.  
  15639. void * 
  15640.  
  15641.  
  15642. ΓòÉΓòÉΓòÉ 2.21.2.9. MStream::readPtr() ΓòÉΓòÉΓòÉ
  15643.  
  15644. readPtr() 
  15645.  
  15646. Reads an appropriate number of bytes for a single character, and returns a 
  15647. pointer to a null-terminated string. Note that the string must be MFree'd to 
  15648. avoid memory leaks. 
  15649.  
  15650. void * 
  15651.  
  15652.  
  15653. ΓòÉΓòÉΓòÉ 2.21.2.10. MStream::readShort() ΓòÉΓòÉΓòÉ
  15654.  
  15655. readShort() 
  15656.  
  15657. Reads an appropriate number of bytes for a short integer, and returns that 
  15658. value. 
  15659.  
  15660. short 
  15661.  
  15662.  
  15663. ΓòÉΓòÉΓòÉ 2.21.2.11. MStream::readStr() ΓòÉΓòÉΓòÉ
  15664.  
  15665. readStr() 
  15666.  
  15667. Reads an appropriate number of bytes and returns a pointer to a null-terminated 
  15668. string. Note that the string must be MFree'd to avoid memory leaks. 
  15669.  
  15670. char * 
  15671.  
  15672.  
  15673. ΓòÉΓòÉΓòÉ 2.21.2.12. MStream::readString() ΓòÉΓòÉΓòÉ
  15674.  
  15675. readString() 
  15676.  
  15677. Reads an appropriate number of bytes and returns a pointer to a null-terminated 
  15678. string. Note that the string must be MFree'd to avoid memory leaks. 
  15679.  
  15680. char * 
  15681.  
  15682.  
  15683. ΓòÉΓòÉΓòÉ 2.21.2.13. MStream::readUChar() ΓòÉΓòÉΓòÉ
  15684.  
  15685. readUChar() 
  15686.  
  15687. Reads an appropriate number of bytes for a single unsigned character, and 
  15688. returns that value. 
  15689.  
  15690. int 
  15691.  
  15692.  
  15693. ΓòÉΓòÉΓòÉ 2.21.2.14. MStream::readULong() ΓòÉΓòÉΓòÉ
  15694.  
  15695. readULong() 
  15696.  
  15697. Reads an appropriate number of bytes for an unsigned long integer, and returns 
  15698. that value. 
  15699.  
  15700. unsigned long 
  15701.  
  15702.  
  15703. ΓòÉΓòÉΓòÉ 2.21.2.15. MStream::readUShort() ΓòÉΓòÉΓòÉ
  15704.  
  15705. readUShort() 
  15706.  
  15707. Reads an appropriate number of bytes for an unsigned short integer, and returns 
  15708. that value. 
  15709.  
  15710. unsigned short 
  15711.  
  15712.  
  15713. ΓòÉΓòÉΓòÉ 2.21.2.16. MStream::readXLDouble() ΓòÉΓòÉΓòÉ
  15714.  
  15715. readXLDouble() 
  15716.  
  15717. Reads an appropriate number of bytes for an Excel-format double, and returns 
  15718. that value. 
  15719.  
  15720. double 
  15721.  
  15722.  
  15723. ΓòÉΓòÉΓòÉ 2.21.2.17. MStream::readXLInt() ΓòÉΓòÉΓòÉ
  15724.  
  15725. readXLInt() 
  15726.  
  15727. Reads an appropriate number of bytes for an Excel-format integer, and returns 
  15728. that value. 
  15729.  
  15730. int 
  15731.  
  15732.  
  15733. ΓòÉΓòÉΓòÉ 2.21.2.18. MStream::readXLRK() ΓòÉΓòÉΓòÉ
  15734.  
  15735. readXLRK() 
  15736.  
  15737. Reads an appropriate number of bytes for an Excel-format compact floating point 
  15738. number, and returns that value. Consult the Microsoft Excel reference for 
  15739. format specifics. 
  15740.  
  15741. double 
  15742.  
  15743.  
  15744. ΓòÉΓòÉΓòÉ 2.21.2.19. MStream::readXLString() ΓòÉΓòÉΓòÉ
  15745.  
  15746. readXLString(char *) 
  15747.  
  15748.       char *   Buffer to store the string 
  15749.  
  15750.  Reads an appropriate number of bytes for an Excel-format string, and stores 
  15751.  that value. 
  15752.  
  15753.  void 
  15754.  
  15755.  
  15756. ΓòÉΓòÉΓòÉ 2.21.2.20. MStream::setupRead() ΓòÉΓòÉΓòÉ
  15757.  
  15758. setupRead() 
  15759.  
  15760. Reads the data type of the current element in the stream, sets the next 
  15761. position to the location of the next element in the stream, and positions the 
  15762. stream pointer to the start of the current element itself. 
  15763.  
  15764. Returns data type of the element in the stream. 
  15765.  
  15766. int 
  15767.  
  15768.  
  15769. ΓòÉΓòÉΓòÉ 2.21.2.21. MStream::unsetRead() ΓòÉΓòÉΓòÉ
  15770.  
  15771. unsetRead() 
  15772.  
  15773. Cancels the pending read operaton, resetting the stream position to the data 
  15774. type of the current element. 
  15775.  
  15776. void 
  15777.  
  15778.  
  15779. ΓòÉΓòÉΓòÉ 2.21.3. Writing values ΓòÉΓòÉΓòÉ
  15780.  
  15781. Open the Contents view and expand this section to see a list of methods. 
  15782.  
  15783.  
  15784. ΓòÉΓòÉΓòÉ 2.21.3.1. MStream::endWrite() ΓòÉΓòÉΓòÉ
  15785.  
  15786. endWrite() 
  15787.  
  15788. Writes the starting position of the next item to the stream. 
  15789.  
  15790. void 
  15791.  
  15792.  
  15793. ΓòÉΓòÉΓòÉ 2.21.3.2. MStream::endWK3Write() ΓòÉΓòÉΓòÉ
  15794.  
  15795. endWK3Write() 
  15796.  
  15797. Writes the starting position of the next item to the stream. 
  15798.  
  15799. void 
  15800.  
  15801.  
  15802. ΓòÉΓòÉΓòÉ 2.21.3.3. MStream::endXLWrite() ΓòÉΓòÉΓòÉ
  15803.  
  15804. endXLWrite() 
  15805.  
  15806. Writes the starting position of the next item to the stream. 
  15807.  
  15808. void 
  15809.  
  15810.  
  15811. ΓòÉΓòÉΓòÉ 2.21.3.4. MStream::setupWrite() ΓòÉΓòÉΓòÉ
  15812.  
  15813. setupWrite(int) 
  15814.  
  15815.       int   Data type of the element to be written 
  15816.  
  15817.  Writes the data type out, prepares a location for the next position, and sets 
  15818.  the stream position to the appropriate spot to begin writing data. 
  15819.  
  15820.  void 
  15821.  
  15822.  
  15823. ΓòÉΓòÉΓòÉ 2.21.3.5. MStream::setupWK3Write() ΓòÉΓòÉΓòÉ
  15824.  
  15825. setupWK3Write(int) 
  15826.  
  15827.       int   Data type of the element to be written 
  15828.  
  15829.  Writes the data type out, prepares a location for the next position, and sets 
  15830.  the stream position to the appropriate spot to begin writing data. 
  15831.  
  15832.  void 
  15833.  
  15834.  
  15835. ΓòÉΓòÉΓòÉ 2.21.3.6. MStream::setupXLWrite() ΓòÉΓòÉΓòÉ
  15836.  
  15837. setupXLWrite(int) 
  15838.  
  15839.       int   Data type of the element to be written 
  15840.  
  15841.  Writes the data type out, prepares a location for the next position, and sets 
  15842.  the stream position to the appropriate spot to begin writing data. 
  15843.  
  15844.  void 
  15845.  
  15846.  
  15847. ΓòÉΓòÉΓòÉ 2.21.3.7. MStream::write()=0 ΓòÉΓòÉΓòÉ
  15848.  
  15849. write(const void *, int) = 0 [virtual] 
  15850.  
  15851.       const void *   Buffer from which to write 
  15852.  
  15853.       int   Number of bytes to write 
  15854.  
  15855.  Does nothing; however, every class that inherits from MStream must implement 
  15856.  this method to write a specified number of bytes from the buffer to the 
  15857.  stream. 
  15858.  
  15859.  Returns the number of bytes written. 
  15860.  
  15861.  int 
  15862.  
  15863.  
  15864. ΓòÉΓòÉΓòÉ 2.21.3.8. MStream::writeInt() ΓòÉΓòÉΓòÉ
  15865.  
  15866. writeInt(int) 
  15867.  
  15868.       int   Value to be written 
  15869.  
  15870.  Writes the given value to the stream. 
  15871.  
  15872.  void 
  15873.  
  15874.  
  15875. ΓòÉΓòÉΓòÉ 2.21.3.9. MStream::writeLongDouble() ΓòÉΓòÉΓòÉ
  15876.  
  15877. writeLongDouble(long double d) 
  15878.  
  15879.       long double d   Value to be written 
  15880.  
  15881.  Writes the given value to the stream. 
  15882.  
  15883.  void 
  15884.  
  15885.  
  15886. ΓòÉΓòÉΓòÉ 2.21.3.10. MStream::writeNumber() ΓòÉΓòÉΓòÉ
  15887.  
  15888. writeNumber(double) 
  15889.  
  15890.       double   Value to be written 
  15891.  
  15892.  Writes the given value to the stream. 
  15893.  
  15894.  void 
  15895.  
  15896.  
  15897. ΓòÉΓòÉΓòÉ 2.21.3.11. MStream::writePointer() ΓòÉΓòÉΓòÉ
  15898.  
  15899. writePointer(void *) 
  15900.  
  15901.       void *   Pointer to be written. 
  15902.  
  15903.  Writes the address of the given pointer to the stream. Note that this is only 
  15904.  useful if the pointer will be in the same location at read-time. 
  15905.  
  15906.  void 
  15907.  
  15908.  
  15909. ΓòÉΓòÉΓòÉ 2.21.3.12. MStream::writePtr() ΓòÉΓòÉΓòÉ
  15910.  
  15911. writePtr(const void *, int) 
  15912.  
  15913.       const void *   Pointer to a string value to be written 
  15914.  
  15915.       int   Number of bytes to write 
  15916.  
  15917.  Writes the given value to the stream. 
  15918.  
  15919.  void 
  15920.  
  15921.  
  15922. ΓòÉΓòÉΓòÉ 2.21.3.13. MStream::writeRTF() ΓòÉΓòÉΓòÉ
  15923.  
  15924. writeRTF(const char *) 
  15925.  
  15926.       const char *   Value to be written 
  15927.  
  15928.  Writes the given value to the stream. 
  15929.  
  15930.  void 
  15931.  
  15932.  
  15933. ΓòÉΓòÉΓòÉ 2.21.3.14. MStream::writes() ΓòÉΓòÉΓòÉ
  15934.  
  15935. writes(const char *) 
  15936.  
  15937.       const char *   Value to be written 
  15938.  
  15939.  Writes the given value to the stream. 
  15940.  
  15941.  void 
  15942.  
  15943.  
  15944. ΓòÉΓòÉΓòÉ 2.21.3.15. MStream::writeShort() ΓòÉΓòÉΓòÉ
  15945.  
  15946. writeShort(short) 
  15947.  
  15948.       short   Value to be written 
  15949.  
  15950.  Writes the given value to the stream. 
  15951.  
  15952.  void 
  15953.  
  15954.  
  15955. ΓòÉΓòÉΓòÉ 2.21.3.16. MStream::writeStr() ΓòÉΓòÉΓòÉ
  15956.  
  15957. writeStr(const char *) 
  15958.  
  15959.       const char *   Value to be written 
  15960.  
  15961.  Writes the given value to the stream. 
  15962.  
  15963.  void 
  15964.  
  15965.  
  15966. ΓòÉΓòÉΓòÉ 2.21.3.17. MStream::writeString() ΓòÉΓòÉΓòÉ
  15967.  
  15968. writeString(const char *) 
  15969.  
  15970.       const char *   Value to be written 
  15971.  
  15972.  Writes the given value to the stream. 
  15973.  
  15974.  void 
  15975.  
  15976.  
  15977. ΓòÉΓòÉΓòÉ 2.21.3.18. MStream::writeUChar() ΓòÉΓòÉΓòÉ
  15978.  
  15979. writeUChar(unsigned char) 
  15980.  
  15981.       unsigned char   Value to be written 
  15982.  
  15983.  Writes the given value to the stream. 
  15984.  
  15985.  void 
  15986.  
  15987.  
  15988. ΓòÉΓòÉΓòÉ 2.21.4. Querying the MStream instance ΓòÉΓòÉΓòÉ
  15989.  
  15990. Open the Contents view and expand this section to see a list of methods. 
  15991.  
  15992.  
  15993. ΓòÉΓòÉΓòÉ 2.21.4.1. MStream::getError() ΓòÉΓòÉΓòÉ
  15994.  
  15995. getError() 
  15996.  
  15997. Passes through to MException::getError() for the stream's exception, returning 
  15998. the stored error value or noError, if no error is stored. 
  15999.  
  16000. int 
  16001.  
  16002.  
  16003. ΓòÉΓòÉΓòÉ 2.21.4.2. MStream::getException() ΓòÉΓòÉΓòÉ
  16004.  
  16005. getException() 
  16006.  
  16007. Returns a pointer to the stream's exception. 
  16008.  
  16009. const MException * 
  16010.  
  16011.  
  16012. ΓòÉΓòÉΓòÉ 2.21.4.3. MStream::getStreamLen()=0 ΓòÉΓòÉΓòÉ
  16013.  
  16014. getStreamLen() = 0[virtual] 
  16015.  
  16016. Does nothing; however, every class that inherits from MStream must implement 
  16017. this method to return the total size of the stream. 
  16018.  
  16019. int 
  16020.  
  16021.  
  16022. ΓòÉΓòÉΓòÉ 2.21.4.4. MStream::getVersion() ΓòÉΓòÉΓòÉ
  16023.  
  16024. getVersion() 
  16025.  
  16026. Returns the version number. 
  16027.  
  16028. int 
  16029.  
  16030.  
  16031. ΓòÉΓòÉΓòÉ 2.21.4.5. MStream::isError() ΓòÉΓòÉΓòÉ
  16032.  
  16033. isError() 
  16034.  
  16035. TRUE if an error is set, FALSE otherwise 
  16036.  
  16037. int 
  16038.  
  16039.  
  16040. ΓòÉΓòÉΓòÉ 2.21.5. Navigating within the stream ΓòÉΓòÉΓòÉ
  16041.  
  16042. Open the Contents view and expand this section to see a list of methods. 
  16043.  
  16044.  
  16045. ΓòÉΓòÉΓòÉ 2.21.5.1. MStream::getPos()=0 ΓòÉΓòÉΓòÉ
  16046.  
  16047. getPos() =0 [virtual] 
  16048.  
  16049. Does nothing; however, every class that inherits from MStream must implement 
  16050. this method to return the position within the stream. 
  16051.  
  16052. int 
  16053.  
  16054.  
  16055. ΓòÉΓòÉΓòÉ 2.21.5.2. MStream::isEOF()=0 ΓòÉΓòÉΓòÉ
  16056.  
  16057. isEOF() =0 [virtual] 
  16058.  
  16059. Does nothing; however, every class that inherits from MStream must implement 
  16060. this method to return 1 if at the end of the stream; 0 otherwise. 
  16061.  
  16062. int 
  16063.  
  16064.  
  16065. ΓòÉΓòÉΓòÉ 2.21.5.3. MStream::seek()=0 ΓòÉΓòÉΓòÉ
  16066.  
  16067. seek(int) = 0[virtual] 
  16068.  
  16069.       int   New position 
  16070.  
  16071.  Does nothing; however, every class that inherits from MStream must implement 
  16072.  this method to move to the specified position within the stream. 
  16073.  
  16074.  Returns the new position within the stream. 
  16075.  
  16076.  int 
  16077.  
  16078.  
  16079. ΓòÉΓòÉΓòÉ 2.21.6. Setting attributes and version number ΓòÉΓòÉΓòÉ
  16080.  
  16081. Open the Contents view and expand this section to see a list of methods. 
  16082.  
  16083.  
  16084. ΓòÉΓòÉΓòÉ 2.21.6.1. MStream::setAttributes() ΓòÉΓòÉΓòÉ
  16085.  
  16086. setAttributes(const char *) [virtual] 
  16087.  
  16088.       const char *   Attribute string to set 
  16089.  
  16090.  Does nothing; however, any class that inherits from MStream may implement this 
  16091.  method to set OS/2 attributes. 
  16092.  
  16093.  void 
  16094.  
  16095.  
  16096. ΓòÉΓòÉΓòÉ 2.21.6.2. MStream::setMesaAttributes() ΓòÉΓòÉΓòÉ
  16097.  
  16098. setMesaAttributes() [virtual] 
  16099.  
  16100. Does nothing; however, any class that inherits from MStream may implement this 
  16101. method to set any Mesa-specific attributes. 
  16102.  
  16103. void 
  16104.  
  16105.  
  16106. ΓòÉΓòÉΓòÉ 2.21.6.3. MStream::setVersion() ΓòÉΓòÉΓòÉ
  16107.  
  16108. setVersion(int) 
  16109.  
  16110.       int   New version number 
  16111.  
  16112.  Sets the version of the stream to the value passed in. 
  16113.  
  16114.  void 
  16115.  
  16116.  
  16117. ΓòÉΓòÉΓòÉ 2.22. MView ΓòÉΓòÉΓòÉ
  16118.  
  16119. view.h is the source file for this class. 
  16120.  
  16121. This class inherits from MWindow 
  16122.  
  16123. Handles abstract views - display regions that can be placed inside a normal 
  16124. OS/2 window. The other Mesa DOK view classes, such as MMesaView and MSheetView, 
  16125. are all subclasses of MView. 
  16126.  
  16127. Each MView instance keeps track of the current context menu, the parent window, 
  16128. and a "superparent" window. It also keeps track of the same information as 
  16129. MWindow (see MWindow). 
  16130.  
  16131. To create a customized display region within your application, simply create 
  16132. your own MView subclass. 
  16133.  
  16134.  
  16135. ΓòÉΓòÉΓòÉ 2.22.1. Creating, destroying, and setting up an MView instance ΓòÉΓòÉΓòÉ
  16136.  
  16137. Open the Contents view and expand this section to see a list of methods. 
  16138.  
  16139.  
  16140. ΓòÉΓòÉΓòÉ 2.22.1.1. MView::MView() ΓòÉΓòÉΓòÉ
  16141.  
  16142. MView(HWND, int, HWND=0) 
  16143.  
  16144.       HWND   Handle to parent window 
  16145.  
  16146.       int   Context menu identifier 
  16147.  
  16148.       HWND   Superparent window 
  16149.  
  16150.  Passes through to MWindow::MWindow(), sets the parent and superparent of the 
  16151.  instance, and loads the context menu. 
  16152.  
  16153.  void 
  16154.  
  16155.  MView(MWindow *, int, HWND=0) 
  16156.  
  16157.       MWindow *   Parent window 
  16158.  
  16159.       int   Context menu identifier 
  16160.  
  16161.       HWND   Superparent window 
  16162.  
  16163.  Passes through to MWindow::MWindow(), sets the parent and superparent of the 
  16164.  instance, and loads the context menu. 
  16165.  
  16166.  void 
  16167.  
  16168.  
  16169. ΓòÉΓòÉΓòÉ 2.22.1.2. MView::~MView() ΓòÉΓòÉΓòÉ
  16170.  
  16171. ~MView() [virtual] 
  16172.  
  16173. Destroys the MView instance and releases all allocated resources, including any 
  16174. context menus. 
  16175.  
  16176. void 
  16177.  
  16178.  
  16179. ΓòÉΓòÉΓòÉ 2.22.1.3. MView::cleanUp() ΓòÉΓòÉΓòÉ
  16180.  
  16181. cleanUp() [virtual] 
  16182.  
  16183. Passes through to MWindow::cleanUp(). 
  16184.  
  16185. void 
  16186.  
  16187.  
  16188. ΓòÉΓòÉΓòÉ 2.22.1.4. MView::setUp() ΓòÉΓòÉΓòÉ
  16189.  
  16190. setUp(const MRect *, int = 0) [virtual] 
  16191.  
  16192.       const MRect *   Rectangle to create window within 
  16193.  
  16194.       int    Window style. Default is 0 
  16195.  
  16196.  Creates a new window the size and location of the given rectangle. 
  16197.  
  16198.  void 
  16199.  
  16200.  
  16201. ΓòÉΓòÉΓòÉ 2.22.2. Handling format changes ΓòÉΓòÉΓòÉ
  16202.  
  16203. Open the Contents view and expand this section to see a list of methods. 
  16204.  
  16205.  
  16206. ΓòÉΓòÉΓòÉ 2.22.2.1. MView::bkgColorDroppedAt() ΓòÉΓòÉΓòÉ
  16207.  
  16208. bkgColorDroppedAt(MColor, int, int) [virtual] 
  16209.  
  16210.       MColor   Background color that was dropped 
  16211.  
  16212.       int   x coord of the drop 
  16213.  
  16214.       int   y coord of the drop 
  16215.  
  16216.  By default, this method does nothing; any class that inherits from MView may 
  16217.  override this method to handle a background color being dropped on the view. 
  16218.  
  16219.  void 
  16220.  
  16221.  
  16222. ΓòÉΓòÉΓòÉ 2.22.2.2. MView::colorDroppedAt() ΓòÉΓòÉΓòÉ
  16223.  
  16224. colorDroppedAt(MColor, int, int) [virtual] 
  16225.  
  16226.       MColor   Color that was dropped 
  16227.  
  16228.       int   x coord of the drop 
  16229.  
  16230.       int   y coord of the drop 
  16231.  
  16232.  By default, this method does nothing; any class that inherits from MView may 
  16233.  override this method to handle a color being dropped on the view. 
  16234.  
  16235.  void 
  16236.  
  16237.  
  16238. ΓòÉΓòÉΓòÉ 2.22.2.3. MView::fontDroppedAt() ΓòÉΓòÉΓòÉ
  16239.  
  16240. fontDroppedAt(const MFont *, int, int) [virtual] 
  16241.  
  16242.       const MFont *   Font that was dropped   . 
  16243.  
  16244.       int   x coord of the drop 
  16245.  
  16246.       int   y coord of the drop 
  16247.  
  16248.  By default, this method does nothing; any class that inherits from MView may 
  16249.  override this method to handle a font being dropped on the view. 
  16250.  
  16251.  void 
  16252.  
  16253.  
  16254. ΓòÉΓòÉΓòÉ 2.22.2.4. MView::winPresParamChanged() ΓòÉΓòÉΓòÉ
  16255.  
  16256. winPresParamChanged(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16257.  
  16258.       HWND   Window handle
  16259.  
  16260.       ULONG   Message 
  16261.  
  16262.       MPARAM   Parameter 1 
  16263.  
  16264.       MPARAM   Parameter 2 
  16265.  
  16266.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16267.       passed to default window handler.) 
  16268.  
  16269.  Responds to a FOREGROUNDCOLOR, BACKGROUNDCOLOR, or FONTNAMESIZE change in 
  16270.  presentation parameters by converting the OS/2 message into a bkgColorDropped, 
  16271.  ColorDropped, or FontDropped method. 
  16272.  
  16273.  MRESULT 
  16274.  
  16275.  
  16276. ΓòÉΓòÉΓòÉ 2.22.3. Displaying the view ΓòÉΓòÉΓòÉ
  16277.  
  16278. Open the Contents view and expand this section to see a list of methods. 
  16279.  
  16280.  
  16281. ΓòÉΓòÉΓòÉ 2.22.3.1. MView::drawSelf() ΓòÉΓòÉΓòÉ
  16282.  
  16283. drawSelf(MDraw *, const MRect *) [virtual] 
  16284.  
  16285.       MDraw   Region to draw to 
  16286.  
  16287.       const MRect *   Clipping rectangle 
  16288.  
  16289.  By default, this method returns 1 and does nothing; any class that inherits 
  16290.  from MView must override this method to handle drawing itself. 
  16291.  
  16292.  int 
  16293.  
  16294.  
  16295. ΓòÉΓòÉΓòÉ 2.22.4. Setting and identifying parent windows ΓòÉΓòÉΓòÉ
  16296.  
  16297. Open the Contents view and expand this section to see a list of methods. 
  16298.  
  16299.  
  16300. ΓòÉΓòÉΓòÉ 2.22.4.1. MView::getSuperHWND() ΓòÉΓòÉΓòÉ
  16301.  
  16302. getSuperHWND() [virtual] 
  16303.  
  16304. Returns handle to the parent window. 
  16305.  
  16306. HWND 
  16307.  
  16308.  
  16309. ΓòÉΓòÉΓòÉ 2.22.4.2. MView::getSuperview() ΓòÉΓòÉΓòÉ
  16310.  
  16311. getSuperview() [virtual] 
  16312.  
  16313. Returns the parent window. 
  16314.  
  16315. MWindow * 
  16316.  
  16317.  
  16318. ΓòÉΓòÉΓòÉ 2.22.4.3. MView::setSuperHWND() ΓòÉΓòÉΓòÉ
  16319.  
  16320. setSuperHWND(HWND) [virtual] 
  16321.  
  16322.       HWND   New parent window 
  16323.  
  16324.   Sets the parent window to the given window. 
  16325.  
  16326.   void 
  16327.  
  16328.  
  16329. ΓòÉΓòÉΓòÉ 2.22.4.4. MView::setSuperview() ΓòÉΓòÉΓòÉ
  16330.  
  16331. setSuperview(MWindow *) [virtual] 
  16332.  
  16333.       MWindow *   New parent window 
  16334.  
  16335.   Sets the parent window to the given window. 
  16336.  
  16337.  void 
  16338.  
  16339.  
  16340. ΓòÉΓòÉΓòÉ 2.22.4.5. MView::setViewPos() ΓòÉΓòÉΓòÉ
  16341.  
  16342. setViewPos(const MRect *) [virtual] 
  16343.  
  16344.       const MRect *   New position for the view 
  16345.  
  16346.  Sets the coordinates of the current view to those of the rectangle passed in. 
  16347.  
  16348.  void 
  16349.  
  16350.  
  16351. ΓòÉΓòÉΓòÉ 2.22.5. Handling help and context-sensitive menus ΓòÉΓòÉΓòÉ
  16352.  
  16353. Open the Contents view and expand this section to see a list of methods. 
  16354.  
  16355.  
  16356. ΓòÉΓòÉΓòÉ 2.22.5.1. MView::getObjectMenu() ΓòÉΓòÉΓòÉ
  16357.  
  16358. getObjectMenu() [virtual] 
  16359.  
  16360. Returns item identifier of the context menu. 
  16361.  
  16362. int 
  16363.  
  16364.  
  16365. ΓòÉΓòÉΓòÉ 2.22.5.2. MView::winContextMenu() ΓòÉΓòÉΓòÉ
  16366.  
  16367. winContextMenu(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16368.  
  16369.       HWND   Window handle
  16370.  
  16371.       ULONG   Message 
  16372.  
  16373.       MPARAM   Parameter 1 
  16374.  
  16375.       MPARAM   Parameter 2 
  16376.  
  16377.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16378.       passed to default window handler.) 
  16379.  
  16380.  Pops up the currently-specified context menu. 
  16381.  
  16382.  MRESULT 
  16383.  
  16384.  
  16385. ΓòÉΓòÉΓòÉ 2.22.5.3. MView::winHelp() ΓòÉΓòÉΓòÉ
  16386.  
  16387. winHelp(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16388.  
  16389.       HWND   Window handle
  16390.  
  16391.       ULONG   Message 
  16392.  
  16393.       MPARAM   Parameter 1 
  16394.  
  16395.       MPARAM   Parameter 2 
  16396.  
  16397.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16398.       passed to default window handler.) 
  16399.  
  16400.  Passes through to WinPostMessage(), sets handled flag to 1 and returns 0. 
  16401.  
  16402.  MRESULT 
  16403.  
  16404.  
  16405. ΓòÉΓòÉΓòÉ 2.23. MWindow ΓòÉΓòÉΓòÉ
  16406.  
  16407. mwindow.h is the source file for this class. 
  16408.  
  16409. This class inherits from MObject 
  16410.  
  16411. MWindow is the basic Mesa window class; all windows within the application are 
  16412. subclasses of MWindow. 
  16413.  
  16414. In many cases, MWindow functions simply pass messages along to the default OS/2 
  16415. window handler and pass the results back. (Unless otherwise noted, the methods 
  16416. described here do precisely that. For any function which returns an MRESULT, 
  16417. the meaning of the return parameter is the same as the meaning of the return 
  16418. parameter for the corresponding OS/2 message.) 
  16419.  
  16420. Each MWindow instance keeps track of the frame and client window, if 
  16421. appropriate, and of the default window procedure function for the frame window 
  16422. (in order to pass messages back to the default message handler). 
  16423.  
  16424.  
  16425. ΓòÉΓòÉΓòÉ 2.23.1. Creating and destroying an MWindow instance ΓòÉΓòÉΓòÉ
  16426.  
  16427. Open the Contents view and expand this section to see a list of methods. 
  16428.  
  16429.  
  16430. ΓòÉΓòÉΓòÉ 2.23.1.1. MWindow::MWindow() ΓòÉΓòÉΓòÉ
  16431.  
  16432. MWindow() 
  16433.  
  16434. Clears the values for frame, client, and window procedure function. 
  16435.  
  16436. void 
  16437.  
  16438.  
  16439. ΓòÉΓòÉΓòÉ 2.23.1.2. MWindow::~MWindow() ΓòÉΓòÉΓòÉ
  16440.  
  16441. ~MWindow() [virtual] 
  16442.  
  16443. Destroys the MWindow instance. 
  16444.  
  16445. void 
  16446.  
  16447.  
  16448. ΓòÉΓòÉΓòÉ 2.23.1.3. MWindow::aboutToDestroy() ΓòÉΓòÉΓòÉ
  16449.  
  16450. aboutToDestroy() [virtual] 
  16451.  
  16452. Clears the values for frame and client windows. 
  16453.  
  16454. void 
  16455.  
  16456.  
  16457. ΓòÉΓòÉΓòÉ 2.23.2. MWindow methods ΓòÉΓòÉΓòÉ
  16458.  
  16459. Open the Contents view and expand this section to see a list of methods. 
  16460.  
  16461.  
  16462. ΓòÉΓòÉΓòÉ 2.23.2.1. MWindow::bufferWindow() ΓòÉΓòÉΓòÉ
  16463.  
  16464. bufferWindow() [virtual] 
  16465.  
  16466. By default, this method returns 0; any class that inherits from MWindow may 
  16467. override this method to indicate whether the window display should be buffered 
  16468. (1 for yes, 0 for no). 
  16469.  
  16470. int 
  16471.  
  16472.  
  16473. ΓòÉΓòÉΓòÉ 2.23.2.2. MWindow::canExecute() ΓòÉΓòÉΓòÉ
  16474.  
  16475. canExecute(int, int &) [virtual] 
  16476.  
  16477.       int   Command 
  16478.  
  16479.       int &   Storage location for flags 
  16480.  
  16481.  By default, this method returns 0 and clears all flags; any class that 
  16482.  inherits from MWindow may override this method to indicate whether the window 
  16483.  can execute the given message (1 for yes, 0 for no). 
  16484.  
  16485.  int 
  16486.  
  16487.  
  16488. ΓòÉΓòÉΓòÉ 2.23.2.3. MWindow::changedSize() ΓòÉΓòÉΓòÉ
  16489.  
  16490. changedSize(HWND, MChange *) [virtual] 
  16491.  
  16492.       HWND   Window handle 
  16493.  
  16494.       MChange *   List of cells whose size has changed 
  16495.  
  16496.  By default, this method returns 0 and does nothing; any class that inherits 
  16497.  from MWindow may override this method to deal with a size change of the window 
  16498.  or its contents. 
  16499.  
  16500.  MRESULT 
  16501.  
  16502.  
  16503. ΓòÉΓòÉΓòÉ 2.23.2.4. MWindow::cleanUp() ΓòÉΓòÉΓòÉ
  16504.  
  16505. cleanUp() [virtual] 
  16506.  
  16507. Sets values of the frame and client windows, if they exist, and adds the frame 
  16508. window to the controller's destroy list. 
  16509.  
  16510. void 
  16511.  
  16512.  
  16513. ΓòÉΓòÉΓòÉ 2.23.2.5. MWindow::contentsChanged() ΓòÉΓòÉΓòÉ
  16514.  
  16515. contentsChanged(MChange *) [virtual] 
  16516.  
  16517.       MChange *   List of cells whose contents have changed 
  16518.  
  16519.  By default, this method does nothing; any class that inherits from MWindow may 
  16520.  override this method to indicate that the contents of a range of cells has 
  16521.  changed and deal with the changes. 
  16522.  
  16523.  void 
  16524.  
  16525.  
  16526. ΓòÉΓòÉΓòÉ 2.23.2.6. MWindow::createStdWindow() ΓòÉΓòÉΓòÉ
  16527.  
  16528. createStdWindow(HWND, ULONG, PULONG, PSZ, ULONG, HMODULE, ULONG, PHWND) 
  16529. [virtual] 
  16530.  
  16531.       HWND   Parent window handle 
  16532.  
  16533.       ULONG   Style of the frame window 
  16534.  
  16535.       PULONG   Create flags 
  16536.  
  16537.       PSZ   Client window class 
  16538.  
  16539.       ULONG   Client style 
  16540.  
  16541.       HMODULE   Handle to the resource management module 
  16542.  
  16543.       ULONG   Resource ID to associate to the window 
  16544.  
  16545.       PHWND   Client window handle 
  16546.  
  16547.  Passes through to WinCreateStdWindow(). Subclasses the window procedure and 
  16548.  installs appHandleWindowProc() as the message handler. Stores this pointer as 
  16549.  the window value and returns a handle to the frame window created. 
  16550.  
  16551.  HWND 
  16552.  
  16553.  
  16554. ΓòÉΓòÉΓòÉ 2.23.2.7. MWindow::createWindow() ΓòÉΓòÉΓòÉ
  16555.  
  16556. createWindow (HWND, PSZ, ULONG, LONG, LONG, LONG, LONG, HWND, HWND) [virtual] 
  16557.  
  16558.       HWND   Parent window handle 
  16559.  
  16560.       PSZ   Window Name 
  16561.  
  16562.       ULONG      Style 
  16563.  
  16564.       LONG   X coordinate 
  16565.  
  16566.       LONG   Y coordinate 
  16567.  
  16568.       LONG   Width 
  16569.  
  16570.       LONG   Height 
  16571.  
  16572.       HWND    Owner window 
  16573.  
  16574.       HWND   Handle of window behind which this window will be placed. 
  16575.  
  16576.  Creates a window of the class M_APP_WINDOW and returns a handle to the window 
  16577.  created. 
  16578.  
  16579.  HWND 
  16580.  
  16581.  
  16582. ΓòÉΓòÉΓòÉ 2.23.2.8. MWindow::cycleCalcIndicator() ΓòÉΓòÉΓòÉ
  16583.  
  16584. cycleCalcIndicator() [virtual] 
  16585.  
  16586. By default, this method does nothing; any class that inherits from MWindow may 
  16587. override this method to implement a visual indicator of recalculation efforts. 
  16588.  
  16589. void 
  16590.  
  16591.  
  16592. ΓòÉΓòÉΓòÉ 2.23.2.9. MWindow::dragDiscardObject() ΓòÉΓòÉΓòÉ
  16593.  
  16594. dragDiscardObject(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16595.  
  16596.       HWND   Window handle
  16597.  
  16598.       ULONG   Message 
  16599.  
  16600.       MPARAM   Parameter 1 
  16601.  
  16602.       MPARAM   Parameter 2 
  16603.  
  16604.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16605.       passed to default window handler.) 
  16606.  
  16607.  By default, this method returns 0 and does nothing; the parameters are passed 
  16608.  through to the default window handler, and trigger the behavior associated 
  16609.  with the DM_DISCARDOBJECT message. 
  16610.  
  16611.  MRESULT 
  16612.  
  16613.  
  16614. ΓòÉΓòÉΓòÉ 2.23.2.10. MWindow::dragDrop() ΓòÉΓòÉΓòÉ
  16615.  
  16616. dragDrop(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16617.  
  16618.       HWND   Window handle
  16619.  
  16620.       ULONG   Message 
  16621.  
  16622.       MPARAM   Parameter 1 
  16623.  
  16624.       MPARAM   Parameter 2 
  16625.  
  16626.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16627.       passed to default window handler.) 
  16628.  
  16629.  By default, this method returns 0 and does nothing; the parameters are passed 
  16630.  through to the default window handler, and trigger the behavior associated 
  16631.  with the DM_DROP message. 
  16632.  
  16633.  MRESULT 
  16634.  
  16635.  
  16636. ΓòÉΓòÉΓòÉ 2.23.2.11. MWindow::dragDropHelp() ΓòÉΓòÉΓòÉ
  16637.  
  16638. dragDropHelp(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16639.  
  16640.       HWND   Window handle
  16641.  
  16642.       ULONG   Message 
  16643.  
  16644.       MPARAM   Parameter 1 
  16645.  
  16646.       MPARAM   Parameter 2 
  16647.  
  16648.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16649.       passed to default window handler.) 
  16650.  
  16651.  By default, this method returns 0 and does nothing; the parameters are passed 
  16652.  through to the default window handler, and trigger the behavior associated 
  16653.  with the DM_DROPHELP message. 
  16654.  
  16655.  MRESULT 
  16656.  
  16657.  
  16658. ΓòÉΓòÉΓòÉ 2.23.2.12. MWindow::dragEmphasizeTarget() ΓòÉΓòÉΓòÉ
  16659.  
  16660. dragEmphasizeTarget(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16661.  
  16662.       HWND   Window handle
  16663.  
  16664.       ULONG   Message 
  16665.  
  16666.       MPARAM   Parameter 1 
  16667.  
  16668.       MPARAM   Parameter 2 
  16669.  
  16670.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16671.       passed to default window handler.) 
  16672.  
  16673.  By default, this method returns 0 and does nothing; the parameters are passed 
  16674.  through to the default window handler, and trigger the behavior associated 
  16675.  with the DM_EMPHASIZETARGET message. 
  16676.  
  16677.  MRESULT 
  16678.  
  16679.  
  16680. ΓòÉΓòÉΓòÉ 2.23.2.13. MWindow::dragEndConversation() ΓòÉΓòÉΓòÉ
  16681.  
  16682. dragEndConversation(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16683.  
  16684.       HWND   Window handle
  16685.  
  16686.       ULONG   Message 
  16687.  
  16688.       MPARAM   Parameter 1 
  16689.  
  16690.       MPARAM   Parameter 2 
  16691.  
  16692.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16693.       passed to default window handler.) 
  16694.  
  16695.  By default, this method returns 0 and does nothing; the parameters are passed 
  16696.  through to the default window handler, and trigger the behavior associated 
  16697.  with the DM_ENDCONVERSATION message. 
  16698.  
  16699.  MRESULT 
  16700.  
  16701.  
  16702. ΓòÉΓòÉΓòÉ 2.23.2.14. MWindow::dragError() ΓòÉΓòÉΓòÉ
  16703.  
  16704. dragError(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16705.  
  16706.       HWND   Window handle
  16707.  
  16708.       ULONG   Message 
  16709.  
  16710.       MPARAM   Parameter 1 
  16711.  
  16712.       MPARAM   Parameter 2 
  16713.  
  16714.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16715.       passed to default window handler.) 
  16716.  
  16717.  By default, this method returns 0 and does nothing; the parameters are passed 
  16718.  through to the default window handler, and trigger the behavior associated 
  16719.  with the DM_DRAGERROR message. 
  16720.  
  16721.  MRESULT 
  16722.  
  16723.  
  16724. ΓòÉΓòÉΓòÉ 2.23.2.15. MWindow::dragFileComplete() ΓòÉΓòÉΓòÉ
  16725.  
  16726. dragFileComplete(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16727.  
  16728.       HWND   Window handle
  16729.  
  16730.       ULONG   Message 
  16731.  
  16732.       MPARAM   Parameter 1 
  16733.  
  16734.       MPARAM   Parameter 2 
  16735.  
  16736.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16737.       passed to default window handler.) 
  16738.  
  16739.  By default, this method returns 0 and does nothing; the parameters are passed 
  16740.  through to the default window handler, and trigger the behavior associated 
  16741.  with the DM_DRAGFILECOMPLETE message. 
  16742.  
  16743.  MRESULT 
  16744.  
  16745.  
  16746. ΓòÉΓòÉΓòÉ 2.23.2.16. MWindow::dragFileRendered() ΓòÉΓòÉΓòÉ
  16747.  
  16748. dragFileRendered(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16749.  
  16750.       HWND   Window handle
  16751.  
  16752.       ULONG   Message 
  16753.  
  16754.       MPARAM   Parameter 1 
  16755.  
  16756.       MPARAM   Parameter 2 
  16757.  
  16758.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16759.       passed to default window handler.) 
  16760.  
  16761.  By default, this method returns 0 and does nothing; the parameters are passed 
  16762.  through to the default window handler, and trigger the behavior associated 
  16763.  with the DM_FILERENDERED message. 
  16764.  
  16765.  MRESULT 
  16766.  
  16767.  
  16768. ΓòÉΓòÉΓòÉ 2.23.2.17. MWindow::dragLeave() ΓòÉΓòÉΓòÉ
  16769.  
  16770. dragLeave(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16771.  
  16772.       HWND   Window handle
  16773.  
  16774.       ULONG   Message 
  16775.  
  16776.       MPARAM   Parameter 1 
  16777.  
  16778.       MPARAM   Parameter 2 
  16779.  
  16780.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16781.       passed to default window handler.) 
  16782.  
  16783.  By default, this method returns 0 and does nothing; the parameters are passed 
  16784.  through to the default window handler, and trigger the behavior associated 
  16785.  with the DM_DRAGLEAVE message. 
  16786.  
  16787.  MRESULT 
  16788.  
  16789.  
  16790. ΓòÉΓòÉΓòÉ 2.23.2.18. MWindow::dragOver() ΓòÉΓòÉΓòÉ
  16791.  
  16792. dragOver(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16793.  
  16794.       HWND   Window handle
  16795.  
  16796.       ULONG   Message 
  16797.  
  16798.       MPARAM   Parameter 1 
  16799.  
  16800.       MPARAM   Parameter 2 
  16801.  
  16802.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16803.       passed to default window handler.) 
  16804.  
  16805.  By default, this method returns 0 and does nothing; the parameters are passed 
  16806.  through to the default window handler, and trigger the behavior associated 
  16807.  with the DM_DRAGOVER message. 
  16808.  
  16809.  MRESULT 
  16810.  
  16811.  
  16812. ΓòÉΓòÉΓòÉ 2.23.2.19. MWindow::dragOverNotify() ΓòÉΓòÉΓòÉ
  16813.  
  16814. dragOverNotify(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16815.  
  16816.       HWND   Window handle
  16817.  
  16818.       ULONG   Message 
  16819.  
  16820.       MPARAM   Parameter 1 
  16821.  
  16822.       MPARAM   Parameter 2 
  16823.  
  16824.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16825.       passed to default window handler.) 
  16826.  
  16827.  By default, this method returns 0 and does nothing; the parameters are passed 
  16828.  through to the default window handler, and trigger the behavior associated 
  16829.  with the DM_DRAGOVERNOTIFY message. 
  16830.  
  16831.  MRESULT 
  16832.  
  16833.  
  16834. ΓòÉΓòÉΓòÉ 2.23.2.20. MWindow::dragPrintObject() ΓòÉΓòÉΓòÉ
  16835.  
  16836. dragPrintObject(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16837.  
  16838.       HWND   Window handle
  16839.  
  16840.       ULONG   Message 
  16841.  
  16842.       MPARAM   Parameter 1 
  16843.  
  16844.       MPARAM   Parameter 2 
  16845.  
  16846.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16847.       passed to default window handler.) 
  16848.  
  16849.  By default, this method returns 0 and does nothing; the parameters are passed 
  16850.  through to the default window handler, and trigger the behavior associated 
  16851.  with the DM_PRINTOBJECT message. 
  16852.  
  16853.  MRESULT 
  16854.  
  16855.  
  16856. ΓòÉΓòÉΓòÉ 2.23.2.21. MWindow::dragRender() ΓòÉΓòÉΓòÉ
  16857.  
  16858. dragRender(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16859.  
  16860.       HWND   Window handle
  16861.  
  16862.       ULONG   Message 
  16863.  
  16864.       MPARAM   Parameter 1 
  16865.  
  16866.       MPARAM   Parameter 2 
  16867.  
  16868.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16869.       passed to default window handler.) 
  16870.  
  16871.  By default, this method returns 0 and does nothing; the parameters are passed 
  16872.  through to the default window handler, and trigger the behavior associated 
  16873.  with the DM_RENDER message. 
  16874.  
  16875.  MRESULT 
  16876.  
  16877.  
  16878. ΓòÉΓòÉΓòÉ 2.23.2.22. MWindow::dragRenderComplete() ΓòÉΓòÉΓòÉ
  16879.  
  16880. dragRenderComplete(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16881.  
  16882.       HWND   Window handle
  16883.  
  16884.       ULONG   Message 
  16885.  
  16886.       MPARAM   Parameter 1 
  16887.  
  16888.       MPARAM   Parameter 2 
  16889.  
  16890.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16891.       passed to default window handler.) 
  16892.  
  16893.  By default, this method returns 0 and does nothing; the parameters are passed 
  16894.  through to the default window handler, and trigger the behavior associated 
  16895.  with the DM_RENDERCOMPLETE message. 
  16896.  
  16897.  MRESULT 
  16898.  
  16899.  
  16900. ΓòÉΓòÉΓòÉ 2.23.2.23. MWindow::dragRenderFile() ΓòÉΓòÉΓòÉ
  16901.  
  16902. dragRenderFile(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16903.  
  16904.       HWND   Window handle
  16905.  
  16906.       ULONG   Message 
  16907.  
  16908.       MPARAM   Parameter 1 
  16909.  
  16910.       MPARAM   Parameter 2 
  16911.  
  16912.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16913.       passed to default window handler.) 
  16914.  
  16915.  By default, this method returns 0 and does nothing; the parameters are passed 
  16916.  through to the default window handler, and trigger the behavior associated 
  16917.  with the DM_RENDERFILE message. 
  16918.  
  16919.  MRESULT 
  16920.  
  16921.  
  16922. ΓòÉΓòÉΓòÉ 2.23.2.24. MWindow::dragRenderPrepare() ΓòÉΓòÉΓòÉ
  16923.  
  16924. dragRenderPrepare(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  16925.  
  16926.       HWND   Window handle
  16927.  
  16928.       ULONG   Message 
  16929.  
  16930.       MPARAM   Parameter 1 
  16931.  
  16932.       MPARAM   Parameter 2 
  16933.  
  16934.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  16935.       passed to default window handler.) 
  16936.  
  16937.  By default, this method returns 0 and does nothing; the parameters are passed 
  16938.  through to the default window handler, and trigger the behavior associated 
  16939.  with the DM_RENDERPREPARE message. 
  16940.  
  16941.  MRESULT 
  16942.  
  16943.  
  16944. ΓòÉΓòÉΓòÉ 2.23.2.25. MWindow::drawSelf() ΓòÉΓòÉΓòÉ
  16945.  
  16946. drawSelf(MDraw *, const MRect *) [virtual] 
  16947.  
  16948.       MDraw *   Region to draw in 
  16949.  
  16950.       const MRect *   Clipping rectangle 
  16951.  
  16952.  By default, this method returns 1 and does nothing; any class that inherits 
  16953.  from MWindow should override this method to implement its own drawing behavior 
  16954.  and return 1 if redrawn, or 0 otherwise. 
  16955.  
  16956.  int 
  16957.  
  16958.  
  16959. ΓòÉΓòÉΓòÉ 2.23.2.26. MWindow::formatChanged() ΓòÉΓòÉΓòÉ
  16960.  
  16961. formatChanged(MChange *) [virtual] 
  16962.  
  16963.       MChange *   List of cells that have had a format change 
  16964.  
  16965.  By default, this method does nothing; any class that inherits from MWindow may 
  16966.  override this method to indicate that the display format for a range of cells 
  16967.  has changed. 
  16968.  
  16969.  void 
  16970.  
  16971.  
  16972. ΓòÉΓòÉΓòÉ 2.23.2.27. MWindow::getButtonValue() ΓòÉΓòÉΓòÉ
  16973.  
  16974. getButtonValue(int) [virtual] 
  16975.  
  16976.       int   Identifier of the button to retrieve value of 
  16977.  
  16978.  Valid only for check boxes, 3-state boxes, and radio buttons. 
  16979.  
  16980.  Returns the state of the button (1 if selected, 2 if not selected, 0 if 
  16981.  undetermined). 
  16982.  
  16983.  int 
  16984.  
  16985.  
  16986. ΓòÉΓòÉΓòÉ 2.23.2.28. MWindow::getClientWindow() ΓòÉΓòÉΓòÉ
  16987.  
  16988. getClientWindow() const [virtual] 
  16989.  
  16990. Returns handle of the client window. 
  16991.  
  16992. HWND 
  16993.  
  16994.  
  16995. ΓòÉΓòÉΓòÉ 2.23.2.29. MWindow::getClientWindowViewRect() ΓòÉΓòÉΓòÉ
  16996.  
  16997. getClientWindowViewRect(MRect *) const [virtual] 
  16998.  
  16999.       MRect *   MRect instance to make equal to client window 
  17000.  
  17001.  Sets the given rectangle to the size of the client window. 
  17002.  
  17003.  void 
  17004.  
  17005.  getClientWindowViewRect(RECTL *) const [virtual] 
  17006.  
  17007.       RECTL *   RECTL to store values in 
  17008.  
  17009.  Sets the given rectangle to the size of the client window. 
  17010.  
  17011.  void 
  17012.  
  17013.  
  17014. ΓòÉΓòÉΓòÉ 2.23.2.30. MWindow::getDrawScale() ΓòÉΓòÉΓòÉ
  17015.  
  17016. getDrawScale() [virtual] 
  17017.  
  17018. By default, this method returns 1.0; any class that inherits from MWindow may 
  17019. override this method to return the current draw scale. 
  17020.  
  17021. float 
  17022.  
  17023.  
  17024. ΓòÉΓòÉΓòÉ 2.23.2.31. MWindow::getFont() ΓòÉΓòÉΓòÉ
  17025.  
  17026. getFont() [virtual] 
  17027.  
  17028. Returns the current window default font. 
  17029.  
  17030. const MFont * 
  17031.  
  17032.  
  17033. ΓòÉΓòÉΓòÉ 2.23.2.32. MWindow::getFormat() ΓòÉΓòÉΓòÉ
  17034.  
  17035. getFormat() [virtual] 
  17036.  
  17037. Returns the current window default format. 
  17038.  
  17039. const MFormat * 
  17040.  
  17041.  
  17042. ΓòÉΓòÉΓòÉ 2.23.2.33. MWindow::getFrameRect() ΓòÉΓòÉΓòÉ
  17043.  
  17044. getFrameRect(MRect *) const [virtual] 
  17045.  
  17046.       MRect *   MRect instance to make equal to frame window 
  17047.  
  17048.  Sets the given rectangle to the size of the frame window. 
  17049.  
  17050.  void 
  17051.  
  17052.  getFrameRect(RECTL *) const [virtual] 
  17053.  
  17054.       RECTL *   RECTL to store values in 
  17055.  
  17056.  Sets the given rectangle to the size of the frame window. 
  17057.  
  17058.  void 
  17059.  
  17060.  
  17061. ΓòÉΓòÉΓòÉ 2.23.2.34. MWindow::getFrameWindow() ΓòÉΓòÉΓòÉ
  17062.  
  17063. getFrameWindow() const [virtual] 
  17064.  
  17065. Returns handle of the frame window. 
  17066.  
  17067. HWND 
  17068.  
  17069.  
  17070. ΓòÉΓòÉΓòÉ 2.23.2.35. MWindow::getItemText() ΓòÉΓòÉΓòÉ
  17071.  
  17072. getItemText(int, char *) [virtual] 
  17073.  
  17074.       int    Item identifier 
  17075.  
  17076.       char *   Buffer to store the text 
  17077.  
  17078.  Stores the text of the given item. 
  17079.  
  17080.  void 
  17081.  
  17082.  
  17083. ΓòÉΓòÉΓòÉ 2.23.2.36. MWindow::getItemValue() ΓòÉΓòÉΓòÉ
  17084.  
  17085. getItemValue(int) [virtual] 
  17086.  
  17087.       int   Item identifier 
  17088.  
  17089.  Returns the numeric equivalent of the given item's text, or 0 if no numeric 
  17090.  equivalent exists. 
  17091.  
  17092.  double 
  17093.  
  17094.  
  17095. ΓòÉΓòÉΓòÉ 2.23.2.37. MWindow::getRadioValue() ΓòÉΓòÉΓòÉ
  17096.  
  17097. getRadioValue(int, const int *) [virtual] 
  17098.  
  17099.       int   Number of items in the list 
  17100.  
  17101.       const int *   Array of item identifiers 
  17102.  
  17103.  Returns the index number of the first item in the given list which has a 
  17104.  non-zero value, or 0 if all are de-selected. 
  17105.  
  17106.  int 
  17107.  
  17108.  
  17109. ΓòÉΓòÉΓòÉ 2.23.2.38. MWindow::getRect() ΓòÉΓòÉΓòÉ
  17110.  
  17111. getRect(MRect *) const [virtual] 
  17112.  
  17113.       MRect *   Storage for the rectangle 
  17114.  
  17115.  Sets the given rectangle to the size of the client window. 
  17116.  
  17117.  void 
  17118.  
  17119.  getRect(RECTL *) const [virtual] 
  17120.  
  17121.       RECTL *   Storage for the rectangle 
  17122.  
  17123.  Sets the given rectangle to the size of the client window. 
  17124.  
  17125.  void 
  17126.  
  17127.  
  17128. ΓòÉΓòÉΓòÉ 2.23.2.39. MWindow::getSelectValue() ΓòÉΓòÉΓòÉ
  17129.  
  17130. getSelectValue(int) [virtual] 
  17131.  
  17132.       int   Item identifier of the listbox in question 
  17133.  
  17134.   Returns the item number selected in the given listbox. 
  17135.  
  17136.  int 
  17137.  
  17138.  
  17139. ΓòÉΓòÉΓòÉ 2.23.2.40. MWindow::getSpinValue() ΓòÉΓòÉΓòÉ
  17140.  
  17141. getSpinValue(int) [virtual] 
  17142.  
  17143.       int   Item identifier of the spinbutton in question 
  17144.  
  17145.  Returns the value selected for the given spinbutton. 
  17146.  
  17147.  int 
  17148.  
  17149.  
  17150. ΓòÉΓòÉΓòÉ 2.23.2.41. MWindow::getWinProc() ΓòÉΓòÉΓòÉ
  17151.  
  17152. getWinProc() [virtual] 
  17153.  
  17154. Returns the original window procedure of the frame window. 
  17155.  
  17156. PFNWP 
  17157.  
  17158.  
  17159. ΓòÉΓòÉΓòÉ 2.23.2.42. MWindow::handleChar() ΓòÉΓòÉΓòÉ
  17160.  
  17161. handleChar(int, int, int &) [virtual] 
  17162.  
  17163.       int   Character 
  17164.  
  17165.       int   Key flags 
  17166.  
  17167.       int &   Handled flag 
  17168.  
  17169.  By default, this method returns 0 and does nothing; any class that inherits 
  17170.  from MWindow may override this method to handle keyboard characters. 
  17171.  
  17172.  MRESULT 
  17173.  
  17174.  
  17175. ΓòÉΓòÉΓòÉ 2.23.2.43. MWindow::hasDrawSelf() ΓòÉΓòÉΓòÉ
  17176.  
  17177. hasDrawSelf() [virtual] 
  17178.  
  17179. Returns 0, indicating that this class does not have a drawSelf() method. 
  17180.  
  17181. int 
  17182.  
  17183.  
  17184. ΓòÉΓòÉΓòÉ 2.23.2.44. MWindow::invalidateRect() ΓòÉΓòÉΓòÉ
  17185.  
  17186. invalidateRect(const MRect *) [virtual] 
  17187.  
  17188.       const MRect *   Rectangle to invalidate 
  17189.  
  17190.  Creates an RECTL equivalent to the given rectangle and passes it through to 
  17191.  WinInvalidateRect(). 
  17192.  
  17193.  void 
  17194.  
  17195.  
  17196. ΓòÉΓòÉΓòÉ 2.23.2.45. MWindow::isMesaWindow() ΓòÉΓòÉΓòÉ
  17197.  
  17198. isMesaWindow(HWND) 
  17199.  
  17200.       HWND   Window handle 
  17201.  
  17202.  Returns 1 if the given HWND represents a Mesa window, 0 otherwise. 
  17203.  
  17204.  static int 
  17205.  
  17206.  
  17207. ΓòÉΓòÉΓòÉ 2.23.2.46. MWindow::isWindowMaximized() ΓòÉΓòÉΓòÉ
  17208.  
  17209. isWindowMaximized(HWND) 
  17210.  
  17211.       HWND   Window handle 
  17212.  
  17213.  Returns 1 if the window is maximized, 0 otherwise. 
  17214.  
  17215.  static int 
  17216.  
  17217.  
  17218. ΓòÉΓòÉΓòÉ 2.23.2.47. MWindow::isWindowMinimized() ΓòÉΓòÉΓòÉ
  17219.  
  17220. isWindowMinimized(HWND) 
  17221.  
  17222.       HWND   Window handle 
  17223.  
  17224.  Returns 1 if the window is minimized, 0 otherwise. 
  17225.  
  17226.  static int 
  17227.  
  17228.  
  17229. ΓòÉΓòÉΓòÉ 2.23.2.48. MWindow::itemNumFromList() ΓòÉΓòÉΓòÉ
  17230.  
  17231. itemNumFromList(int, int, const int *) [virtual] 
  17232.  
  17233.       int   Item identifier to look for 
  17234.  
  17235.       int   Number of elements in the item list 
  17236.  
  17237.       const int *   List of item identifiers 
  17238.  
  17239.  Returns the index of the given item identifier in the given list of 
  17240.  identifiers, or 0 if not found. 
  17241.  
  17242.  int 
  17243.  
  17244.  
  17245. ΓòÉΓòÉΓòÉ 2.23.2.49. MWindow::memOpenRevert() ΓòÉΓòÉΓòÉ
  17246.  
  17247. memOpenRevert(int &) [virtual] 
  17248.  
  17249.       int &   Handled flag 
  17250.  
  17251.  By default, this method does nothing; any class that inherits from MWindow may 
  17252.  override this method. For example, the Mesa 2 application implements this 
  17253.  method to open a file, if one is scheduled to be opened. 
  17254.  
  17255.  void 
  17256.  
  17257.  
  17258. ΓòÉΓòÉΓòÉ 2.23.2.50. MWindow::mouse1Click() ΓòÉΓòÉΓòÉ
  17259.  
  17260. mouse1Click(const MPoint *, int, int &) [virtual] 
  17261.  
  17262.       const MPoint *   Location of the mouse 
  17263.  
  17264.       int   Keyboard control flags 
  17265.  
  17266.       int &   Has it been handled? 1 for yes, 0 for no. 
  17267.  
  17268.  This method is called if the message handler does not handle 
  17269.  MWindow::winButton1Click(). By default, it does nothing; any class that 
  17270.  inherits from MWindow may override this method to handle the event (and should 
  17271.  set the handled flag to 1, if so). 
  17272.  
  17273.  void 
  17274.  
  17275.  
  17276. ΓòÉΓòÉΓòÉ 2.23.2.51. MWindow::mouse1DblClick() ΓòÉΓòÉΓòÉ
  17277.  
  17278. mouse1DblClick(const MPoint *, int, int &) [virtual] 
  17279.  
  17280.       const MPoint *   Location of the mouse 
  17281.  
  17282.       int   Keyboard control flags 
  17283.  
  17284.       int &   Has it been handled? 1 for yes, 0 for no. 
  17285.  
  17286.  This method is called if the message handler does not handle 
  17287.  MWindow::winButton1DoubleClick(). By default, it does nothing; any class that 
  17288.  inherits from MWindow may override this method to handle the event (and should 
  17289.  set the handled flag to 1, if so). 
  17290.  
  17291.  void 
  17292.  
  17293.  
  17294. ΓòÉΓòÉΓòÉ 2.23.2.52. MWindow::mouse1Down() ΓòÉΓòÉΓòÉ
  17295.  
  17296. mouse1Down(const MPoint *, int, int &) [virtual] 
  17297.  
  17298.       const MPoint *   Location of the mouse 
  17299.  
  17300.       int   Keyboard control flags 
  17301.  
  17302.       int &   Has it been handled? 1 for yes, 0 for no. 
  17303.  
  17304.  This method is called if the message handler does not handle 
  17305.  MWindow::winButton1(). By default, it does nothing; any class that inherits 
  17306.  from MWindow may override this method to handle the event (and should set the 
  17307.  handled flag to 1, if so). 
  17308.  
  17309.  void 
  17310.  
  17311.  
  17312. ΓòÉΓòÉΓòÉ 2.23.2.53. MWindow::mouse1MotionEnd() ΓòÉΓòÉΓòÉ
  17313.  
  17314. mouse1MotionEnd(int &) [virtual] 
  17315.  
  17316.       int &   Has it been handled? 1 for yes, 0 for no. 
  17317.  
  17318.  This method is called if the message handler does not handle 
  17319.  MWindow::winButton1MotionEnd(). By default, it does nothing; any class that 
  17320.  inherits from MWindow may override this method to handle the event (and should 
  17321.  set the handled flag to 1, if so). 
  17322.  
  17323.  void 
  17324.  
  17325.  
  17326. ΓòÉΓòÉΓòÉ 2.23.2.54. MWindow::mouse1MotionStart() ΓòÉΓòÉΓòÉ
  17327.  
  17328. mouse1MotionStart(int &) [virtual] 
  17329.  
  17330.       int &   Has it been handled? 1 for yes, 0 for no. 
  17331.  
  17332.  This method is called if the message handler does not handle 
  17333.  MWindow::winButton1MotionStart(). By default, it does nothing; any class that 
  17334.  inherits from MWindow may override this method to handle the event (and should 
  17335.  set the handled flag to 1, if so). 
  17336.  
  17337.  void 
  17338.  
  17339.  
  17340. ΓòÉΓòÉΓòÉ 2.23.2.55. MWindow::mouse1Up() ΓòÉΓòÉΓòÉ
  17341.  
  17342. mouse1Up(const MPoint *, int, int &) [virtual] 
  17343.  
  17344.       const MPoint *   Location of the mouse 
  17345.  
  17346.       int   Keyboard control flags 
  17347.  
  17348.       int &   Has it been handled? 1 for yes, 0 for no. 
  17349.  
  17350.  This method is called if the message handler does not handle 
  17351.  MWindow::winButton1Up(). By default, it does nothing; any class that inherits 
  17352.  from MWindow may override this method to handle the event (and should set the 
  17353.  handled flag to 1, if so). 
  17354.  
  17355.  void 
  17356.  
  17357.  
  17358. ΓòÉΓòÉΓòÉ 2.23.2.56. MWindow::mouse2Click() ΓòÉΓòÉΓòÉ
  17359.  
  17360. mouse2Click(const MPoint *, int, int &) [virtual] 
  17361.  
  17362.       const MPoint *   Location of the mouse 
  17363.  
  17364.       int   Keyboard control flags 
  17365.  
  17366.       int &   Has it been handled? 1 for yes, 0 for no. 
  17367.  
  17368.  This method is called if the message handler does not handle 
  17369.  MWindow::winButton2Click(). By default, it does nothing; any class that 
  17370.  inherits from MWindow may override this method to handle the event (and should 
  17371.  set the handled flag to 1, if so). 
  17372.  
  17373.  void 
  17374.  
  17375.  
  17376. ΓòÉΓòÉΓòÉ 2.23.2.57. MWindow::mouse2DblClick() ΓòÉΓòÉΓòÉ
  17377.  
  17378. mouse2DblClick(const MPoint *, int, int &) [virtual] 
  17379.  
  17380.       const MPoint *   Location of the mouse 
  17381.  
  17382.       int   Keyboard control flags 
  17383.  
  17384.       int &   Has it been handled? 1 for yes, 0 for no. 
  17385.  
  17386.  This method is called if the message handler does not handle 
  17387.  MWindow::winButton2DoubleClick(). By default, it does nothing; any class that 
  17388.  inherits from MWindow may override this method to handle the event (and should 
  17389.  set the handled flag to 1, if so). 
  17390.  
  17391.  void 
  17392.  
  17393.  
  17394. ΓòÉΓòÉΓòÉ 2.23.2.58. MWindow::mouse2Down() ΓòÉΓòÉΓòÉ
  17395.  
  17396. mouse2Down(const MPoint *, int, int &) [virtual] 
  17397.  
  17398.       const MPoint *   Location of the mouse 
  17399.  
  17400.       int   Keyboard control flags 
  17401.  
  17402.       int &   Has it been handled? 1 for yes, 0 for no. 
  17403.  
  17404.  This method is called if the message handler does not handle 
  17405.  MWindow::winButton2(). By default, it does nothing; any class that inherits 
  17406.  from MWindow may override this method to handle the event (and should set the 
  17407.  handled flag to 1, if so). 
  17408.  
  17409.  void 
  17410.  
  17411.  
  17412. ΓòÉΓòÉΓòÉ 2.23.2.59. MWindow::mouse2MotionEnd() ΓòÉΓòÉΓòÉ
  17413.  
  17414. mouse2MotionEnd(int &) [virtual] 
  17415.  
  17416.       int &   Has it been handled? 1 for yes, 0 for no. 
  17417.  
  17418.  This method is called if the message handler does not handle 
  17419.  MWindow::winButton2MotionEnd(). By default, it does nothing; any class that 
  17420.  inherits from MWindow may override this method to handle the event (and should 
  17421.  set the handled flag to 1, if so). 
  17422.  
  17423.  void 
  17424.  
  17425.  
  17426. ΓòÉΓòÉΓòÉ 2.23.2.60. MWindow::mouse2MotionStart() ΓòÉΓòÉΓòÉ
  17427.  
  17428. mouse2MotionStart(int &) [virtual] 
  17429.  
  17430.       int &   Has it been handled? 1 for yes, 0 for no. 
  17431.  
  17432.  This method is called if the message handler does not handle 
  17433.  MWindow::winButton2MotionStart(). By default, it does nothing; any class that 
  17434.  inherits from MWindow may override this method to handle the event (and should 
  17435.  set the handled flag to 1, if so). 
  17436.  
  17437.  void 
  17438.  
  17439.  
  17440. ΓòÉΓòÉΓòÉ 2.23.2.61. MWindow::mouse2Up() ΓòÉΓòÉΓòÉ
  17441.  
  17442. mouse2Up(const MPoint *, int, int &) [virtual] 
  17443.  
  17444.       const MPoint *   Location of the mouse 
  17445.  
  17446.       int   Keyboard control flags 
  17447.  
  17448.       int &   Has it been handled? 1 for yes, 0 for no. 
  17449.  
  17450.  This method is called if the message handler does not handle 
  17451.  MWindow::winButton2Up(). By default, it does nothing; any class that inherits 
  17452.  from MWindow may override this method to handle the event (and should set the 
  17453.  handled flag to 1, if so). 
  17454.  
  17455.  void 
  17456.  
  17457.  
  17458. ΓòÉΓòÉΓòÉ 2.23.2.62. MWindow::mouse3Click() ΓòÉΓòÉΓòÉ
  17459.  
  17460. mouse3Click(const MPoint *, int, int &) [virtual] 
  17461.  
  17462.       const MPoint *   Location of the mouse 
  17463.  
  17464.       int   Keyboard control flags 
  17465.  
  17466.       int &   Has it been handled? 1 for yes, 0 for no. 
  17467.  
  17468.  This method is called if the message handler does not handle 
  17469.  MWindow::winButton3Click(). By default, it does nothing; any class that 
  17470.  inherits from MWindow may override this method to handle the event (and should 
  17471.  set the handled flag to 1, if so). 
  17472.  
  17473.  void 
  17474.  
  17475.  
  17476. ΓòÉΓòÉΓòÉ 2.23.2.63. MWindow::mouse3DblClick() ΓòÉΓòÉΓòÉ
  17477.  
  17478. mouse3DblClick(const MPoint *, int, int &) [virtual] 
  17479.  
  17480.       const MPoint *   Location of the mouse 
  17481.  
  17482.       int   Keyboard control flags 
  17483.  
  17484.       int &   Has it been handled? 1 for yes, 0 for no. 
  17485.  
  17486.  This method is called if the message handler does not handle 
  17487.  MWindow::winButton3DoubleClick(). By default, it does nothing; any class that 
  17488.  inherits from MWindow may override this method to handle the event (and should 
  17489.  set the handled flag to 1, if so). 
  17490.  
  17491.  void 
  17492.  
  17493.  
  17494. ΓòÉΓòÉΓòÉ 2.23.2.64. MWindow::mouse3Down() ΓòÉΓòÉΓòÉ
  17495.  
  17496. mouse3Down(const MPoint *, int, int &) [virtual] 
  17497.  
  17498.       const MPoint *   Location of the mouse 
  17499.  
  17500.       int   Keyboard control flags 
  17501.  
  17502.       int &   Has it been handled? 1 for yes, 0 for no. 
  17503.  
  17504.  This method is called if the message handler does not handle 
  17505.  MWindow::winButton3(). By default, it does nothing; any class that inherits 
  17506.  from MWindow may override this method to handle the event (and should set the 
  17507.  handled flag to 1, if so). 
  17508.  
  17509.  void 
  17510.  
  17511.  
  17512. ΓòÉΓòÉΓòÉ 2.23.2.65. MWindow::mouse3MotionEnd() ΓòÉΓòÉΓòÉ
  17513.  
  17514. mouse3MotionEnd(int &) [virtual] 
  17515.  
  17516.       int &   Has it been handled? 1 for yes, 0 for no. 
  17517.  
  17518.  This method is called if the message handler does not handle 
  17519.  MWindow::winButton3MotionEnd(). By default, it does nothing; any class that 
  17520.  inherits from MWindow may override this method to handle the event (and should 
  17521.  set the handled flag to 1, if so). 
  17522.  
  17523.  void 
  17524.  
  17525.  
  17526. ΓòÉΓòÉΓòÉ 2.23.2.66. MWindow::mouse3MotionStart() ΓòÉΓòÉΓòÉ
  17527.  
  17528. mouse3MotionStart(int &) [virtual] 
  17529.  
  17530.       int &   Has it been handled? 1 for yes, 0 for no. 
  17531.  
  17532.  This method is called if the message handler does not handle 
  17533.  MWindow::winButton3MotionStart(). By default, it does nothing; any class that 
  17534.  inherits from MWindow may override this method to handle the event (and should 
  17535.  set the handled flag to 1, if so). 
  17536.  
  17537.  void 
  17538.  
  17539.  
  17540. ΓòÉΓòÉΓòÉ 2.23.2.67. MWindow::mouse3Up() ΓòÉΓòÉΓòÉ
  17541.  
  17542. mouse3Up(const MPoint *, int, int &) [virtual] 
  17543.  
  17544.       const MPoint *   Location of the mouse 
  17545.  
  17546.       int   Keyboard control flags 
  17547.  
  17548.       int &   Has it been handled? 1 for yes, 0 for no. 
  17549.  
  17550.  This method is called if the message handler does not handle 
  17551.  MWindow::winButton3Up(). By default, it does nothing; any class that inherits 
  17552.  from MWindow may override this method to handle the event (and should set the 
  17553.  handled flag to 1, if so). 
  17554.  
  17555.  void 
  17556.  
  17557.  
  17558. ΓòÉΓòÉΓòÉ 2.23.2.68. MWindow::percentChanged() ΓòÉΓòÉΓòÉ
  17559.  
  17560. percentChanged(int) [virtual] 
  17561.  
  17562.       int   New percent-changed value 
  17563.  
  17564.  By default, this method does nothing; any class that inherits from MWindow may 
  17565.  override this method to indicate the progress of a long procedure 
  17566.  
  17567.  void 
  17568.  
  17569.  
  17570. ΓòÉΓòÉΓòÉ 2.23.2.69. MWindow::resetView() ΓòÉΓòÉΓòÉ
  17571.  
  17572. resetView(MChange *) [virtual] 
  17573.  
  17574.       MChange *   Cells that have changed 
  17575.  
  17576.  By default, this method returns 0 and does nothing; any class that inherits 
  17577.  from MWindow may override this method to handle rearranging itself and return 
  17578.  an appropriate result (usually 1 for success, 0 for failure). 
  17579.  
  17580.  MRESULT 
  17581.  
  17582.  
  17583. ΓòÉΓòÉΓòÉ 2.23.2.70. MWindow::setButtonValue() ΓòÉΓòÉΓòÉ
  17584.  
  17585. setButtonValue(int, int) [virtual] 
  17586.  
  17587.       int   Item identifier 
  17588.  
  17589.       int   New value 
  17590.  
  17591.  Sets the value of the given item to the given value. Item must be a radio 
  17592.  button, checkbox, or 3-state checkbox. 
  17593.  
  17594.  void 
  17595.  
  17596.  
  17597. ΓòÉΓòÉΓòÉ 2.23.2.71. MWindow::setClientWindow() ΓòÉΓòÉΓòÉ
  17598.  
  17599. setClientWindow(HWND) [virtual] 
  17600.  
  17601.       HWND   New value for client window 
  17602.  
  17603.  Sets the client window value to the given window handle. 
  17604.  
  17605.  void 
  17606.  
  17607.  
  17608. ΓòÉΓòÉΓòÉ 2.23.2.72. MWindow::setFocus() ΓòÉΓòÉΓòÉ
  17609.  
  17610. setFocus() [virtual] 
  17611.  
  17612. Passes the client window through to WinSetFocus(). 
  17613.  
  17614. void 
  17615.  
  17616.  
  17617. ΓòÉΓòÉΓòÉ 2.23.2.73. MWindow::setFont() ΓòÉΓòÉΓòÉ
  17618.  
  17619. setFont(const MFont *newFont) [virtual] 
  17620.  
  17621.       const MFont *newFont   New font 
  17622.  
  17623.  Sets the window default font to the given font. 
  17624.  
  17625.  void 
  17626.  
  17627.  
  17628. ΓòÉΓòÉΓòÉ 2.23.2.74. MWindow::setFormat() ΓòÉΓòÉΓòÉ
  17629.  
  17630. setFormat(const MFormat *newFormat) [virtual] 
  17631.  
  17632.       const MFormat *newFormat 
  17633.  
  17634.  Sets the window default format to the given format. 
  17635.  
  17636.  void 
  17637.  
  17638.  
  17639. ΓòÉΓòÉΓòÉ 2.23.2.75. MWindow::setFrameWindow() ΓòÉΓòÉΓòÉ
  17640.  
  17641. setFrameWindow(HWND) [virtual] 
  17642.  
  17643.       HWND   New value for frame window 
  17644.  
  17645.  Sets the frame window value to the given window handle. 
  17646.  
  17647.  void 
  17648.  
  17649.  
  17650. ΓòÉΓòÉΓòÉ 2.23.2.76. MWindow::setItemText() ΓòÉΓòÉΓòÉ
  17651.  
  17652. setItemText(int, const char *) [virtual] 
  17653.  
  17654.       int   Item identifier 
  17655.  
  17656.       const char *   New text value 
  17657.  
  17658.  Sets the text for the given item to the given string. 
  17659.  
  17660.  void 
  17661.  
  17662.  
  17663. ΓòÉΓòÉΓòÉ 2.23.2.77. MWindow::setItemValue() ΓòÉΓòÉΓòÉ
  17664.  
  17665. setItemValue(int, double) [virtual] 
  17666.  
  17667.       int   Item identifier 
  17668.  
  17669.       double   Number to store in the item 
  17670.  
  17671.  Sets the text of the given item to the string equivalent of the given number. 
  17672.  
  17673.  void 
  17674.  
  17675.  
  17676. ΓòÉΓòÉΓòÉ 2.23.2.78. MWindow::setRadioValue() ΓòÉΓòÉΓòÉ
  17677.  
  17678. setRadioValue(int, int, const int *) [virtual] 
  17679.  
  17680.       int   Which item (in list) to set? 
  17681.  
  17682.       int   Number of items in the list 
  17683.  
  17684.       const int *   List of items 
  17685.  
  17686.  Sets the value of the given item (referenced by an index into the item list) 
  17687.  to 1, and sets the other item values to 0. 
  17688.  
  17689.  void 
  17690.  
  17691.  
  17692. ΓòÉΓòÉΓòÉ 2.23.2.79. MWindow::setSelectValue() ΓòÉΓòÉΓòÉ
  17693.  
  17694. setSelectValue(int, int) [virtual] 
  17695.  
  17696.       int   Listbox identifier 
  17697.  
  17698.       int   New item to select 
  17699.  
  17700.  Selects the given item within the given listbox. 
  17701.  
  17702.  void 
  17703.  
  17704.  
  17705. ΓòÉΓòÉΓòÉ 2.23.2.80. MWindow::setSpinValue() ΓòÉΓòÉΓòÉ
  17706.  
  17707. setSpinValue(int, int) [virtual] 
  17708.  
  17709.       int   Spinbutton identifier 
  17710.  
  17711.       int   New value to set 
  17712.  
  17713.  Sets the given value within the given spin button. 
  17714.  
  17715.  void 
  17716.  
  17717.  
  17718. ΓòÉΓòÉΓòÉ 2.23.2.81. MWindow::setUp() ΓòÉΓòÉΓòÉ
  17719.  
  17720. setUp(const MRect *, int=0) [virtual] 
  17721.  
  17722.       const MRect *   Rectangle parameter 
  17723.  
  17724.       int   Default is 0 
  17725.  
  17726.  By default, this method returns 0 and does nothing; any class that inherits 
  17727.  from MWindow may override this method to handle setup. 
  17728.  
  17729.  void 
  17730.  
  17731.  
  17732. ΓòÉΓòÉΓòÉ 2.23.2.82. MWindow::setWinProc() ΓòÉΓòÉΓòÉ
  17733.  
  17734. setWinProc(PFNWP) [virtual] 
  17735.  
  17736.       PFNWP   New window procedure 
  17737.  
  17738.  Sets the window procedure to the given function. 
  17739.  
  17740.  void 
  17741.  
  17742.  
  17743. ΓòÉΓòÉΓòÉ 2.23.2.83. MWindow::threadRexxFuncs() ΓòÉΓòÉΓòÉ
  17744.  
  17745. threadRexxFuncs() [virtual] 
  17746.  
  17747. By default, this method does nothing; any class that inherits from MWindow may 
  17748. override this method to execute a REXX function (for example, the next function 
  17749. on a controller-wide REXX function queue). 
  17750.  
  17751. void 
  17752.  
  17753.  
  17754. ΓòÉΓòÉΓòÉ 2.23.2.84. MWindow::update() ΓòÉΓòÉΓòÉ
  17755.  
  17756. update() [virtual] 
  17757.  
  17758. Invalidates the entire frame window, thereby forcing a redraw. 
  17759.  
  17760. void 
  17761.  
  17762.  
  17763. ΓòÉΓòÉΓòÉ 2.23.2.85. MWindow::updateLayerNumber() ΓòÉΓòÉΓòÉ
  17764.  
  17765. updateLayerNumber(int) [virtual] 
  17766.  
  17767.       int   Layer number to update 
  17768.  
  17769.  By default, this method returns 0 and does nothing; any class that inherits 
  17770.  from MWindow may override this method to handle a change in the layer being 
  17771.  displayed. 
  17772.  
  17773.  void 
  17774.  
  17775.  
  17776. ΓòÉΓòÉΓòÉ 2.23.2.86. MWindow::updateWindow() ΓòÉΓòÉΓòÉ
  17777.  
  17778. updateWindow() [virtual] 
  17779.  
  17780. Passes the client window to WinUpdateWindow(). 
  17781.  
  17782. void 
  17783.  
  17784.  
  17785. ΓòÉΓòÉΓòÉ 2.23.2.87. MWindow::winActivate() ΓòÉΓòÉΓòÉ
  17786.  
  17787. winActivate(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17788.  
  17789.       HWND   Window handle
  17790.  
  17791.       ULONG   Message 
  17792.  
  17793.       MPARAM   Parameter 1 
  17794.  
  17795.       MPARAM   Parameter 2 
  17796.  
  17797.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17798.       passed to default window handler.) 
  17799.  
  17800.  By default, this method returns 0 and does nothing; the parameters are passed 
  17801.  through to the default window handler, and trigger the behavior associated 
  17802.  with the WM_ACTIVATE message. 
  17803.  
  17804.  MRESULT 
  17805.  
  17806.  
  17807. ΓòÉΓòÉΓòÉ 2.23.2.88. MWindow::winAdjustWindowPos() ΓòÉΓòÉΓòÉ
  17808.  
  17809. winAdjustWindowPos(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17810.  
  17811.       HWND   Window handle
  17812.  
  17813.       ULONG   Message 
  17814.  
  17815.       MPARAM   Parameter 1 
  17816.  
  17817.       MPARAM   Parameter 2 
  17818.  
  17819.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17820.       passed to default window handler.) 
  17821.  
  17822.  By default, this method returns 0 and does nothing; the parameters are passed 
  17823.  through to the default window handler, and trigger the behavior associated 
  17824.  with the WM_ADJUSTWINDOWPOS message. 
  17825.  
  17826.  MRESULT 
  17827.  
  17828.  
  17829. ΓòÉΓòÉΓòÉ 2.23.2.89. MWindow::winAppTerminateNotify() ΓòÉΓòÉΓòÉ
  17830.  
  17831. winAppTerminateNotify(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17832.  
  17833.       HWND   Window handle
  17834.  
  17835.       ULONG   Message 
  17836.  
  17837.       MPARAM   Parameter 1 
  17838.  
  17839.       MPARAM   Parameter 2 
  17840.  
  17841.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17842.       passed to default window handler.) 
  17843.  
  17844.  By default, this method returns 0 and does nothing; the parameters are passed 
  17845.  through to the default window handler, and trigger the behavior associated 
  17846.  with the WM_APPTERMINATENOTIFY message. 
  17847.  
  17848.  MRESULT 
  17849.  
  17850.  
  17851. ΓòÉΓòÉΓòÉ 2.23.2.90. MWindow::winBeginDrag() ΓòÉΓòÉΓòÉ
  17852.  
  17853. winBeginDrag(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17854.  
  17855.       HWND   Window handle
  17856.  
  17857.       ULONG   Message 
  17858.  
  17859.       MPARAM   Parameter 1 
  17860.  
  17861.       MPARAM   Parameter 2 
  17862.  
  17863.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17864.       passed to default window handler.) 
  17865.  
  17866.  By default, this method returns 0 and does nothing; the parameters are passed 
  17867.  through to the default window handler, and trigger the behavior associated 
  17868.  with the WM_BEGINDRAG message. 
  17869.  
  17870.  MRESULT 
  17871.  
  17872.  
  17873. ΓòÉΓòÉΓòÉ 2.23.2.91. MWindow::winBeginSelect() ΓòÉΓòÉΓòÉ
  17874.  
  17875. winBeginSelect(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17876.  
  17877.       HWND   Window handle
  17878.  
  17879.       ULONG   Message 
  17880.  
  17881.       MPARAM   Parameter 1 
  17882.  
  17883.       MPARAM   Parameter 2 
  17884.  
  17885.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17886.       passed to default window handler.) 
  17887.  
  17888.  By default, this method returns 0 and does nothing; the parameters are passed 
  17889.  through to the default window handler, and trigger the behavior associated 
  17890.  with the WM_BEGINSELECT message. 
  17891.  
  17892.  MRESULT 
  17893.  
  17894.  
  17895. ΓòÉΓòÉΓòÉ 2.23.2.92. MWindow::winButton1() ΓòÉΓòÉΓòÉ
  17896.  
  17897. winButton1(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17898.  
  17899.       HWND   Window handle
  17900.  
  17901.       ULONG   Message 
  17902.  
  17903.       MPARAM   Parameter 1 
  17904.  
  17905.       MPARAM   Parameter 2 
  17906.  
  17907.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17908.       passed to default window handler.) 
  17909.  
  17910.  By default, this method returns 0 and does nothing; the parameters are passed 
  17911.  through to the default window handler, and trigger the behavior associated 
  17912.  with the WM_BUTTON1DOWN message. 
  17913.  
  17914.  MRESULT 
  17915.  
  17916.  
  17917. ΓòÉΓòÉΓòÉ 2.23.2.93. MWindow::winButton1Click() ΓòÉΓòÉΓòÉ
  17918.  
  17919. winButton1Click(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17920.  
  17921.       HWND   Window handle
  17922.  
  17923.       ULONG   Message 
  17924.  
  17925.       MPARAM   Parameter 1 
  17926.  
  17927.       MPARAM   Parameter 2 
  17928.  
  17929.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17930.       passed to default window handler.) 
  17931.  
  17932.  By default, this method returns 0 and does nothing; the parameters are passed 
  17933.  through to the default window handler, and trigger the behavior associated 
  17934.  with the WM_BUTTON1CLICK message. 
  17935.  
  17936.  MRESULT 
  17937.  
  17938.  
  17939. ΓòÉΓòÉΓòÉ 2.23.2.94. MWindow::winButton1DoubleClick() ΓòÉΓòÉΓòÉ
  17940.  
  17941. winButton1DoubleClick(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17942.  
  17943.       HWND   Window handle
  17944.  
  17945.       ULONG   Message 
  17946.  
  17947.       MPARAM   Parameter 1 
  17948.  
  17949.       MPARAM   Parameter 2 
  17950.  
  17951.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17952.       passed to default window handler.) 
  17953.  
  17954.  By default, this method returns 0 and does nothing; the parameters are passed 
  17955.  through to the default window handler, and trigger the behavior associated 
  17956.  with the WM_BUTTON1DBLCLK message. 
  17957.  
  17958.  MRESULT 
  17959.  
  17960.  
  17961. ΓòÉΓòÉΓòÉ 2.23.2.95. MWindow::winButton1MotionEnd() ΓòÉΓòÉΓòÉ
  17962.  
  17963. winButton1MotionEnd(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17964.  
  17965.       HWND   Window handle
  17966.  
  17967.       ULONG   Message 
  17968.  
  17969.       MPARAM   Parameter 1 
  17970.  
  17971.       MPARAM   Parameter 2 
  17972.  
  17973.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17974.       passed to default window handler.) 
  17975.  
  17976.  By default, this method returns 0 and does nothing; the parameters are passed 
  17977.  through to the default window handler, and trigger the behavior associated 
  17978.  with the WM_BUTTON1MOTIONEND message. 
  17979.  
  17980.  MRESULT 
  17981.  
  17982.  
  17983. ΓòÉΓòÉΓòÉ 2.23.2.96. MWindow::winButton1MotionStart() ΓòÉΓòÉΓòÉ
  17984.  
  17985. winButton1MotionStart(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  17986.  
  17987.       HWND   Window handle
  17988.  
  17989.       ULONG   Message 
  17990.  
  17991.       MPARAM   Parameter 1 
  17992.  
  17993.       MPARAM   Parameter 2 
  17994.  
  17995.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  17996.       passed to default window handler.) 
  17997.  
  17998.  By default, this method returns 0 and does nothing; the parameters are passed 
  17999.  through to the default window handler, and trigger the behavior associated 
  18000.  with the WM_BUTTON1MOTIONSTART message. 
  18001.  
  18002.  MRESULT 
  18003.  
  18004.  
  18005. ΓòÉΓòÉΓòÉ 2.23.2.97. MWindow::winButton1Up() ΓòÉΓòÉΓòÉ
  18006.  
  18007. winButton1Up(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18008.  
  18009.       HWND   Window handle
  18010.  
  18011.       ULONG   Message 
  18012.  
  18013.       MPARAM   Parameter 1 
  18014.  
  18015.       MPARAM   Parameter 2 
  18016.  
  18017.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18018.       passed to default window handler.) 
  18019.  
  18020.  By default, this method returns 0 and does nothing; the parameters are passed 
  18021.  through to the default window handler, and trigger the behavior associated 
  18022.  with the WM_BUTTON1UP message. 
  18023.  
  18024.  MRESULT 
  18025.  
  18026.  
  18027. ΓòÉΓòÉΓòÉ 2.23.2.98. MWindow::winButton2() ΓòÉΓòÉΓòÉ
  18028.  
  18029. winButton2(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18030.  
  18031.       HWND   Window handle
  18032.  
  18033.       ULONG   Message 
  18034.  
  18035.       MPARAM   Parameter 1 
  18036.  
  18037.       MPARAM   Parameter 2 
  18038.  
  18039.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18040.       passed to default window handler.) 
  18041.  
  18042.  By default, this method returns 0 and does nothing; the parameters are passed 
  18043.  through to the default window handler, and trigger the behavior associated 
  18044.  with the WM_BUTTON2DOWN message. 
  18045.  
  18046.  MRESULT 
  18047.  
  18048.  
  18049. ΓòÉΓòÉΓòÉ 2.23.2.99. MWindow::winButton2Click() ΓòÉΓòÉΓòÉ
  18050.  
  18051. winButton2Click(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18052.  
  18053.       HWND   Window handle
  18054.  
  18055.       ULONG   Message 
  18056.  
  18057.       MPARAM   Parameter 1 
  18058.  
  18059.       MPARAM   Parameter 2 
  18060.  
  18061.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18062.       passed to default window handler.) 
  18063.  
  18064.  By default, this method returns 0 and does nothing; the parameters are passed 
  18065.  through to the default window handler, and trigger the behavior associated 
  18066.  with the WM_BUTTON2CLICK message. 
  18067.  
  18068.  MRESULT 
  18069.  
  18070.  
  18071. ΓòÉΓòÉΓòÉ 2.23.2.100. MWindow::winButton2DoubleClick() ΓòÉΓòÉΓòÉ
  18072.  
  18073. winButton2DoubleClick(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18074.  
  18075.       HWND   Window handle
  18076.  
  18077.       ULONG   Message 
  18078.  
  18079.       MPARAM   Parameter 1 
  18080.  
  18081.       MPARAM   Parameter 2 
  18082.  
  18083.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18084.       passed to default window handler.) 
  18085.  
  18086.  By default, this method returns 0 and does nothing; the parameters are passed 
  18087.  through to the default window handler, and trigger the behavior associated 
  18088.  with the WM_BUTTON2DBLCLK message. 
  18089.  
  18090.  MRESULT 
  18091.  
  18092.  
  18093. ΓòÉΓòÉΓòÉ 2.23.2.101. MWindow::winButton2MotionEnd() ΓòÉΓòÉΓòÉ
  18094.  
  18095. winButton2MotionEnd(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18096.  
  18097.       HWND   Window handle
  18098.  
  18099.       ULONG   Message 
  18100.  
  18101.       MPARAM   Parameter 1 
  18102.  
  18103.       MPARAM   Parameter 2 
  18104.  
  18105.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18106.       passed to default window handler.) 
  18107.  
  18108.  By default, this method returns 0 and does nothing; the parameters are passed 
  18109.  through to the default window handler, and trigger the behavior associated 
  18110.  with the WM_BUTTON2MOTIONEND message. 
  18111.  
  18112.  MRESULT 
  18113.  
  18114.  
  18115. ΓòÉΓòÉΓòÉ 2.23.2.102. MWindow::winButton2MotionStart() ΓòÉΓòÉΓòÉ
  18116.  
  18117. winButton2MotionStart(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18118.  
  18119.       HWND   Window handle
  18120.  
  18121.       ULONG   Message 
  18122.  
  18123.       MPARAM   Parameter 1 
  18124.  
  18125.       MPARAM   Parameter 2 
  18126.  
  18127.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18128.       passed to default window handler.) 
  18129.  
  18130.  By default, this method returns 0 and does nothing; the parameters are passed 
  18131.  through to the default window handler, and trigger the behavior associated 
  18132.  with the WM_BUTTON2MOTIONSTART message. 
  18133.  
  18134.  MRESULT 
  18135.  
  18136.  
  18137. ΓòÉΓòÉΓòÉ 2.23.2.103. MWindow::winButton2Up() ΓòÉΓòÉΓòÉ
  18138.  
  18139. winButton2Up(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18140.  
  18141.       HWND   Window handle
  18142.  
  18143.       ULONG   Message 
  18144.  
  18145.       MPARAM   Parameter 1 
  18146.  
  18147.       MPARAM   Parameter 2 
  18148.  
  18149.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18150.       passed to default window handler.) 
  18151.  
  18152.  By default, this method returns 0 and does nothing; the parameters are passed 
  18153.  through to the default window handler, and trigger the behavior associated 
  18154.  with the WM_BUTTON2UP message. 
  18155.  
  18156.  MRESULT 
  18157.  
  18158.  
  18159. ΓòÉΓòÉΓòÉ 2.23.2.104. MWindow::winButton3() ΓòÉΓòÉΓòÉ
  18160.  
  18161. winButton3(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18162.  
  18163.       HWND   Window handle
  18164.  
  18165.       ULONG   Message 
  18166.  
  18167.       MPARAM   Parameter 1 
  18168.  
  18169.       MPARAM   Parameter 2 
  18170.  
  18171.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18172.       passed to default window handler.) 
  18173.  
  18174.  By default, this method returns 0 and does nothing; the parameters are passed 
  18175.  through to the default window handler, and trigger the behavior associated 
  18176.  with the WM_BUTTON3DOWN message. 
  18177.  
  18178.  MRESULT 
  18179.  
  18180.  
  18181. ΓòÉΓòÉΓòÉ 2.23.2.105. MWindow::winButton3Click() ΓòÉΓòÉΓòÉ
  18182.  
  18183. winButton3Click(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18184.  
  18185.       HWND   Window handle
  18186.  
  18187.       ULONG   Message 
  18188.  
  18189.       MPARAM   Parameter 1 
  18190.  
  18191.       MPARAM   Parameter 2 
  18192.  
  18193.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18194.       passed to default window handler.) 
  18195.  
  18196.  By default, this method returns 0 and does nothing; the parameters are passed 
  18197.  through to the default window handler, and trigger the behavior associated 
  18198.  with the WM_BUTTON3CLICK message. 
  18199.  
  18200.  MRESULT 
  18201.  
  18202.  
  18203. ΓòÉΓòÉΓòÉ 2.23.2.106. MWindow::winButton3DoubleClick() ΓòÉΓòÉΓòÉ
  18204.  
  18205. winButton3DoubleClick(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18206.  
  18207.       HWND   Window handle
  18208.  
  18209.       ULONG   Message 
  18210.  
  18211.       MPARAM   Parameter 1 
  18212.  
  18213.       MPARAM   Parameter 2 
  18214.  
  18215.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18216.       passed to default window handler.) 
  18217.  
  18218.  By default, this method returns 0 and does nothing; the parameters are passed 
  18219.  through to the default window handler, and trigger the behavior associated 
  18220.  with the WM_BUTTON3DBLCLK message. 
  18221.  
  18222.  MRESULT 
  18223.  
  18224.  
  18225. ΓòÉΓòÉΓòÉ 2.23.2.107. MWindow::winButton3MotionEnd() ΓòÉΓòÉΓòÉ
  18226.  
  18227. winButton3MotionEnd(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18228.  
  18229.       HWND   Window handle
  18230.  
  18231.       ULONG   Message 
  18232.  
  18233.       MPARAM   Parameter 1 
  18234.  
  18235.       MPARAM   Parameter 2 
  18236.  
  18237.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18238.       passed to default window handler.) 
  18239.  
  18240.  By default, this method returns 0 and does nothing; the parameters are passed 
  18241.  through to the default window handler, and trigger the behavior associated 
  18242.  with the WM_BUTTON3MOTIONEND message. 
  18243.  
  18244.  MRESULT 
  18245.  
  18246.  
  18247. ΓòÉΓòÉΓòÉ 2.23.2.108. MWindow::winButton3MotionStart() ΓòÉΓòÉΓòÉ
  18248.  
  18249. winButton3MotionStart(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18250.  
  18251.       HWND   Window handle
  18252.  
  18253.       ULONG   Message 
  18254.  
  18255.       MPARAM   Parameter 1 
  18256.  
  18257.       MPARAM   Parameter 2 
  18258.  
  18259.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18260.       passed to default window handler.) 
  18261.  
  18262.  By default, this method returns 0 and does nothing; the parameters are passed 
  18263.  through to the default window handler, and trigger the behavior associated 
  18264.  with the WM_BUTTON3MOTIONSTART message. 
  18265.  
  18266.  MRESULT 
  18267.  
  18268.  
  18269. ΓòÉΓòÉΓòÉ 2.23.2.109. MWindow::winButton3Up() ΓòÉΓòÉΓòÉ
  18270.  
  18271. winButton3Up(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18272.  
  18273.       HWND   Window handle
  18274.  
  18275.       ULONG   Message 
  18276.  
  18277.       MPARAM   Parameter 1 
  18278.  
  18279.       MPARAM   Parameter 2 
  18280.  
  18281.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18282.       passed to default window handler.) 
  18283.  
  18284.  By default, this method returns 0 and does nothing; the parameters are passed 
  18285.  through to the default window handler, and trigger the behavior associated 
  18286.  with the WM_BUTTON3UP message. 
  18287.  
  18288.  MRESULT 
  18289.  
  18290.  
  18291. ΓòÉΓòÉΓòÉ 2.23.2.110. MWindow::winCalcFrameRect() ΓòÉΓòÉΓòÉ
  18292.  
  18293. winCalcFrameRect(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18294.  
  18295.       HWND   Window handle
  18296.  
  18297.       ULONG   Message 
  18298.  
  18299.       MPARAM   Parameter 1 
  18300.  
  18301.       MPARAM   Parameter 2 
  18302.  
  18303.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18304.       passed to default window handler.) 
  18305.  
  18306.  By default, this method returns 0 and does nothing; the parameters are passed 
  18307.  through to the default window handler, and trigger the behavior associated 
  18308.  with the WM_CALCFRAMERECT message. 
  18309.  
  18310.  MRESULT 
  18311.  
  18312.  
  18313. ΓòÉΓòÉΓòÉ 2.23.2.111. MWindow::winCalcValidRects() ΓòÉΓòÉΓòÉ
  18314.  
  18315. winCalcValidRects(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18316.  
  18317.       HWND   Window handle
  18318.  
  18319.       ULONG   Message 
  18320.  
  18321.       MPARAM   Parameter 1 
  18322.  
  18323.       MPARAM   Parameter 2 
  18324.  
  18325.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18326.       passed to default window handler.) 
  18327.  
  18328.  By default, this method returns 0 and does nothing; the parameters are passed 
  18329.  through to the default window handler, and trigger the behavior associated 
  18330.  with the WM_CALCVALIDRECTS message. 
  18331.  
  18332.  MRESULT 
  18333.  
  18334.  
  18335. ΓòÉΓòÉΓòÉ 2.23.2.112. MWindow::winChar() ΓòÉΓòÉΓòÉ
  18336.  
  18337. winChar(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18338.  
  18339.       HWND   Window handle
  18340.  
  18341.       ULONG   Message 
  18342.  
  18343.       MPARAM   Parameter 1 
  18344.  
  18345.       MPARAM   Parameter 2 
  18346.  
  18347.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18348.       passed to default window handler.) 
  18349.  
  18350.  By default, this method returns 0 and does nothing; the parameters are passed 
  18351.  through to the default window handler, and trigger the behavior associated 
  18352.  with the WM_CHAR message. 
  18353.  
  18354.  MRESULT 
  18355.  
  18356.  
  18357. ΓòÉΓòÉΓòÉ 2.23.2.113. MWindow::winChord() ΓòÉΓòÉΓòÉ
  18358.  
  18359. winChord(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18360.  
  18361.       HWND   Window handle
  18362.  
  18363.       ULONG   Message 
  18364.  
  18365.       MPARAM   Parameter 1 
  18366.  
  18367.       MPARAM   Parameter 2 
  18368.  
  18369.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18370.       passed to default window handler.) 
  18371.  
  18372.  By default, this method returns 0 and does nothing; the parameters are passed 
  18373.  through to the default window handler, and trigger the behavior associated 
  18374.  with the WM_CHORD message. 
  18375.  
  18376.  MRESULT 
  18377.  
  18378.  
  18379. ΓòÉΓòÉΓòÉ 2.23.2.114. MWindow::winClose() ΓòÉΓòÉΓòÉ
  18380.  
  18381. winClose(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18382.  
  18383.       HWND   Window handle
  18384.  
  18385.       ULONG   Message 
  18386.  
  18387.       MPARAM   Parameter 1 
  18388.  
  18389.       MPARAM   Parameter 2 
  18390.  
  18391.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18392.       passed to default window handler.) 
  18393.  
  18394.  By default, this method returns 0 and does nothing; the parameters are passed 
  18395.  through to the default window handler, and trigger the behavior associated 
  18396.  with the OS/2 WM_CLOSE message. 
  18397.  
  18398.  MRESULT 
  18399.  
  18400.  
  18401. ΓòÉΓòÉΓòÉ 2.23.2.115. MWindow::winCommand() ΓòÉΓòÉΓòÉ
  18402.  
  18403. winCommand(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18404.  
  18405.       HWND   Window handle
  18406.  
  18407.       ULONG   Message 
  18408.  
  18409.       MPARAM   Parameter 1 
  18410.  
  18411.       MPARAM   Parameter 2 
  18412.  
  18413.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18414.       passed to default window handler.) 
  18415.  
  18416.  By default, this method returns 0 and does nothing; the parameters are passed 
  18417.  through to the default window handler, and trigger the behavior associated 
  18418.  with the OS/2 WM_COMMAND message. 
  18419.  
  18420.  MRESULT 
  18421.  
  18422.  
  18423. ΓòÉΓòÉΓòÉ 2.23.2.116. MWindow::winContextHelp() ΓòÉΓòÉΓòÉ
  18424.  
  18425. winContextHelp(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18426.  
  18427.       HWND   Window handle
  18428.  
  18429.       ULONG   Message 
  18430.  
  18431.       MPARAM   Parameter 1 
  18432.  
  18433.       MPARAM   Parameter 2 
  18434.  
  18435.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18436.       passed to default window handler.) 
  18437.  
  18438.  By default, this method returns 0 and does nothing; the parameters are passed 
  18439.  through to the default window handler, and trigger the behavior associated 
  18440.  with the OS/2 WM_CONTEXTHELP message. 
  18441.  
  18442.  MRESULT 
  18443.  
  18444.  
  18445. ΓòÉΓòÉΓòÉ 2.23.2.117. MWindow::winContextMenu() ΓòÉΓòÉΓòÉ
  18446.  
  18447. winContextMenu(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18448.  
  18449.       HWND   Window handle
  18450.  
  18451.       ULONG   Message 
  18452.  
  18453.       MPARAM   Parameter 1 
  18454.  
  18455.       MPARAM   Parameter 2 
  18456.  
  18457.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18458.       passed to default window handler.) 
  18459.  
  18460.  By default, this method returns 0 and does nothing; the parameters are passed 
  18461.  through to the default window handler, and trigger the behavior associated 
  18462.  with the OS/2 WM_CONTEXTMENU message. 
  18463.  
  18464.  MRESULT 
  18465.  
  18466.  
  18467. ΓòÉΓòÉΓòÉ 2.23.2.118. MWindow::winControl() ΓòÉΓòÉΓòÉ
  18468.  
  18469. winControl(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18470.  
  18471.       HWND   Window handle
  18472.  
  18473.       ULONG   Message 
  18474.  
  18475.       MPARAM   Parameter 1 
  18476.  
  18477.       MPARAM   Parameter 2 
  18478.  
  18479.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18480.       passed to default window handler.) 
  18481.  
  18482.  By default, this method returns 0 and does nothing; the parameters are passed 
  18483.  through to the default window handler, and trigger the behavior associated 
  18484.  with the WM_CONTROL message. 
  18485.  
  18486.  MRESULT 
  18487.  
  18488.  
  18489. ΓòÉΓòÉΓòÉ 2.23.2.119. MWindow::winControlPointer() ΓòÉΓòÉΓòÉ
  18490.  
  18491. winControlPointer(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18492.  
  18493.       HWND   Window handle
  18494.  
  18495.       ULONG   Message 
  18496.  
  18497.       MPARAM   Parameter 1 
  18498.  
  18499.       MPARAM   Parameter 2 
  18500.  
  18501.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18502.       passed to default window handler.) 
  18503.  
  18504.  By default, this method returns 0 and does nothing; the parameters are passed 
  18505.  through to the default window handler, and trigger the behavior associated 
  18506.  with the WM_CONTROLPOINTER message. 
  18507.  
  18508.  MRESULT 
  18509.  
  18510.  
  18511. ΓòÉΓòÉΓòÉ 2.23.2.120. MWindow::winCreate() ΓòÉΓòÉΓòÉ
  18512.  
  18513. winCreate(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18514.  
  18515.       HWND   Window handle
  18516.  
  18517.       ULONG   Message 
  18518.  
  18519.       MPARAM   Parameter 1 
  18520.  
  18521.       MPARAM   Parameter 2 
  18522.  
  18523.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18524.       passed to default window handler.) 
  18525.  
  18526.  By default, this method returns 0 and does nothing; the parameters are passed 
  18527.  through to the default window handler, and trigger the behavior associated 
  18528.  with the WM_CREATE message. 
  18529.  
  18530.  MRESULT 
  18531.  
  18532.  
  18533. ΓòÉΓòÉΓòÉ 2.23.2.121. MWindow::winDDEAck() ΓòÉΓòÉΓòÉ
  18534.  
  18535. winDDEAck(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18536.  
  18537.       HWND   Window handle
  18538.  
  18539.       ULONG   Message 
  18540.  
  18541.       MPARAM   Parameter 1 
  18542.  
  18543.       MPARAM   Parameter 2 
  18544.  
  18545.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18546.       passed to default window handler.) 
  18547.  
  18548.  By default, this method returns 0 and does nothing; the parameters are passed 
  18549.  through to the default window handler, and trigger the behavior associated 
  18550.  with the WM_DDE_ACK message. 
  18551.  
  18552.  MRESULT 
  18553.  
  18554.  
  18555. ΓòÉΓòÉΓòÉ 2.23.2.122. MWindow::winDDEAdvise() ΓòÉΓòÉΓòÉ
  18556.  
  18557. winDDEAdvise(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18558.  
  18559.       HWND   Window handle
  18560.  
  18561.       ULONG   Message 
  18562.  
  18563.       MPARAM   Parameter 1 
  18564.  
  18565.       MPARAM   Parameter 2 
  18566.  
  18567.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18568.       passed to default window handler.) 
  18569.  
  18570.  By default, this method returns 0 and does nothing; the parameters are passed 
  18571.  through to the default window handler, and trigger the behavior associated 
  18572.  with the WM_DDE_ADVISE message. 
  18573.  
  18574.  MRESULT 
  18575.  
  18576.  
  18577. ΓòÉΓòÉΓòÉ 2.23.2.123. MWindow::winDDEData() ΓòÉΓòÉΓòÉ
  18578.  
  18579. winDDEData(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18580.  
  18581.       HWND   Window handle
  18582.  
  18583.       ULONG   Message 
  18584.  
  18585.       MPARAM   Parameter 1 
  18586.  
  18587.       MPARAM   Parameter 2 
  18588.  
  18589.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18590.       passed to default window handler.) 
  18591.  
  18592.  By default, this method returns 0 and does nothing; the parameters are passed 
  18593.  through to the default window handler, and trigger the behavior associated 
  18594.  with the WM_DDE_DATA message. 
  18595.  
  18596.  MRESULT 
  18597.  
  18598.  
  18599. ΓòÉΓòÉΓòÉ 2.23.2.124. MWindow::winDDEExecute() ΓòÉΓòÉΓòÉ
  18600.  
  18601. winDDEExecute(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18602.  
  18603.       HWND   Window handle
  18604.  
  18605.       ULONG   Message 
  18606.  
  18607.       MPARAM   Parameter 1 
  18608.  
  18609.       MPARAM   Parameter 2 
  18610.  
  18611.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18612.       passed to default window handler.) 
  18613.  
  18614.  By default, this method returns 0 and does nothing; the parameters are passed 
  18615.  through to the default window handler, and trigger the behavior associated 
  18616.  with the WM_DDE_EXECUTE message. 
  18617.  
  18618.  MRESULT 
  18619.  
  18620.  
  18621. ΓòÉΓòÉΓòÉ 2.23.2.125. MWindow::winDDEInitiate() ΓòÉΓòÉΓòÉ
  18622.  
  18623. winDDEInitiate(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18624.  
  18625.       HWND   Window handle
  18626.  
  18627.       ULONG   Message 
  18628.  
  18629.       MPARAM   Parameter 1 
  18630.  
  18631.       MPARAM   Parameter 2 
  18632.  
  18633.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18634.       passed to default window handler.) 
  18635.  
  18636.  By default, this method returns 0 and does nothing; the parameters are passed 
  18637.  through to the default window handler, and trigger the behavior associated 
  18638.  with the WM_DDE_INITIATE message. 
  18639.  
  18640.  MRESULT 
  18641.  
  18642.  
  18643. ΓòÉΓòÉΓòÉ 2.23.2.126. MWindow::winDDEInitiateAck() ΓòÉΓòÉΓòÉ
  18644.  
  18645. winDDEInitiateAck(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18646.  
  18647.       HWND   Window handle
  18648.  
  18649.       ULONG   Message 
  18650.  
  18651.       MPARAM   Parameter 1 
  18652.  
  18653.       MPARAM   Parameter 2 
  18654.  
  18655.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18656.       passed to default window handler.) 
  18657.  
  18658.  By default, this method returns 0 and does nothing; the parameters are passed 
  18659.  through to the default window handler, and trigger the behavior associated 
  18660.  with the WM_DDE_INITIATEACK message. 
  18661.  
  18662.  MRESULT 
  18663.  
  18664.  
  18665. ΓòÉΓòÉΓòÉ 2.23.2.127. MWindow::winDDEPoke() ΓòÉΓòÉΓòÉ
  18666.  
  18667. winDDEPoke(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18668.  
  18669.       HWND   Window handle
  18670.  
  18671.       ULONG   Message 
  18672.  
  18673.       MPARAM   Parameter 1 
  18674.  
  18675.       MPARAM   Parameter 2 
  18676.  
  18677.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18678.       passed to default window handler.) 
  18679.  
  18680.  By default, this method returns 0 and does nothing; the parameters are passed 
  18681.  through to the default window handler, and trigger the behavior associated 
  18682.  with the WM_DDE_POKE message. 
  18683.  
  18684.  MRESULT 
  18685.  
  18686.  
  18687. ΓòÉΓòÉΓòÉ 2.23.2.128. MWindow::winDDERequest() ΓòÉΓòÉΓòÉ
  18688.  
  18689. winDDERequest(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18690.  
  18691.       HWND   Window handle
  18692.  
  18693.       ULONG   Message 
  18694.  
  18695.       MPARAM   Parameter 1 
  18696.  
  18697.       MPARAM   Parameter 2 
  18698.  
  18699.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18700.       passed to default window handler.) 
  18701.  
  18702.  By default, this method returns 0 and does nothing; the parameters are passed 
  18703.  through to the default window handler, and trigger the behavior associated 
  18704.  with the WM_DDE_REQUEST message. 
  18705.  
  18706.  MRESULT 
  18707.  
  18708.  
  18709. ΓòÉΓòÉΓòÉ 2.23.2.129. MWindow::winDDETerminate() ΓòÉΓòÉΓòÉ
  18710.  
  18711. winDDETerminate(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18712.  
  18713.       HWND   Window handle
  18714.  
  18715.       ULONG   Message 
  18716.  
  18717.       MPARAM   Parameter 1 
  18718.  
  18719.       MPARAM   Parameter 2 
  18720.  
  18721.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18722.       passed to default window handler.) 
  18723.  
  18724.  By default, this method returns 0 and does nothing; the parameters are passed 
  18725.  through to the default window handler, and trigger the behavior associated 
  18726.  with the WM_DDE_TERMINATE message. 
  18727.  
  18728.  MRESULT 
  18729.  
  18730.  
  18731. ΓòÉΓòÉΓòÉ 2.23.2.130. MWindow::winDDEUnadvise() ΓòÉΓòÉΓòÉ
  18732.  
  18733. winDDEUnadvise(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18734.  
  18735.       HWND   Window handle
  18736.  
  18737.       ULONG   Message 
  18738.  
  18739.       MPARAM   Parameter 1 
  18740.  
  18741.       MPARAM   Parameter 2 
  18742.  
  18743.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18744.       passed to default window handler.) 
  18745.  
  18746.  By default, this method returns 0 and does nothing; the parameters are passed 
  18747.  through to the default window handler, and trigger the behavior associated 
  18748.  with the WM_DDE_UNADVISE message. 
  18749.  
  18750.  MRESULT 
  18751.  
  18752.  
  18753. ΓòÉΓòÉΓòÉ 2.23.2.131. MWindow::winDefault() ΓòÉΓòÉΓòÉ
  18754.  
  18755. winDefault(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18756.  
  18757.       HWND   Window handle
  18758.  
  18759.       ULONG   Message 
  18760.  
  18761.       MPARAM   Parameter 1 
  18762.  
  18763.       MPARAM   Parameter 2 
  18764.  
  18765.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18766.       passed to default window handler.) 
  18767.  
  18768.  By default, this method returns 0 and does nothing; the parameters are passed 
  18769.  through to the default window handler, and trigger the default window 
  18770.  procedure. 
  18771.  
  18772.  MRESULT 
  18773.  
  18774.  
  18775. ΓòÉΓòÉΓòÉ 2.23.2.132. MWindow::winDestroy() ΓòÉΓòÉΓòÉ
  18776.  
  18777. winDestroy(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18778.  
  18779.       HWND   Window handle
  18780.  
  18781.       ULONG   Message 
  18782.  
  18783.       MPARAM   Parameter 1 
  18784.  
  18785.       MPARAM   Parameter 2 
  18786.  
  18787.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18788.       passed to default window handler.) 
  18789.  
  18790.  By default, this method returns 0 and does nothing; the parameters are passed 
  18791.  through to the default window handler, and trigger the behavior associated 
  18792.  with the WM_DESTROY message. 
  18793.  
  18794.  MRESULT 
  18795.  
  18796.  
  18797. ΓòÉΓòÉΓòÉ 2.23.2.133. MWindow::winDestroyClipboard() ΓòÉΓòÉΓòÉ
  18798.  
  18799. winDestroyClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18800.  
  18801.       HWND   Window handle
  18802.  
  18803.       ULONG   Message 
  18804.  
  18805.       MPARAM   Parameter 1 
  18806.  
  18807.       MPARAM   Parameter 2 
  18808.  
  18809.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18810.       passed to default window handler.) 
  18811.  
  18812.  By default, this method returns 0 and does nothing; the parameters are passed 
  18813.  through to the default window handler, and trigger the behavior associated 
  18814.  with the WM_DESTROYCLIPBOARD message. 
  18815.  
  18816.  MRESULT 
  18817.  
  18818.  
  18819. ΓòÉΓòÉΓòÉ 2.23.2.134. MWindow::winDrawClipboard() ΓòÉΓòÉΓòÉ
  18820.  
  18821. winDrawClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18822.  
  18823.       HWND   Window handle
  18824.  
  18825.       ULONG   Message 
  18826.  
  18827.       MPARAM   Parameter 1 
  18828.  
  18829.       MPARAM   Parameter 2 
  18830.  
  18831.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18832.       passed to default window handler.) 
  18833.  
  18834.  By default, this method returns 0 and does nothing; the parameters are passed 
  18835.  through to the default window handler, and trigger the behavior associated 
  18836.  with the WM_DRAWCLIPBOARD message. 
  18837.  
  18838.  MRESULT 
  18839.  
  18840.  
  18841. ΓòÉΓòÉΓòÉ 2.23.2.135. MWindow::winDrawItem() ΓòÉΓòÉΓòÉ
  18842.  
  18843. winDrawItem(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18844.  
  18845.       HWND   Window handle
  18846.  
  18847.       ULONG   Message 
  18848.  
  18849.       MPARAM   Parameter 1 
  18850.  
  18851.       MPARAM   Parameter 2 
  18852.  
  18853.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18854.       passed to default window handler.) 
  18855.  
  18856.  By default, this method returns 0 and does nothing; the parameters are passed 
  18857.  through to the default window handler, and trigger the behavior associated 
  18858.  with the WM_DRAWITEM message. 
  18859.  
  18860.  MRESULT 
  18861.  
  18862.  
  18863. ΓòÉΓòÉΓòÉ 2.23.2.136. MWindow::winEnable() ΓòÉΓòÉΓòÉ
  18864.  
  18865. winEnable(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18866.  
  18867.       HWND   Window handle
  18868.  
  18869.       ULONG   Message 
  18870.  
  18871.       MPARAM   Parameter 1 
  18872.  
  18873.       MPARAM   Parameter 2 
  18874.  
  18875.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18876.       passed to default window handler.) 
  18877.  
  18878.  By default, this method returns 0 and does nothing; the parameters are passed 
  18879.  through to the default window handler, and trigger the behavior associated 
  18880.  with the WM_ENABLE message. 
  18881.  
  18882.  MRESULT 
  18883.  
  18884.  
  18885. ΓòÉΓòÉΓòÉ 2.23.2.137. MWindow::winEndDrag() ΓòÉΓòÉΓòÉ
  18886.  
  18887. winEndDrag(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18888.  
  18889.       HWND   Window handle
  18890.  
  18891.       ULONG   Message 
  18892.  
  18893.       MPARAM   Parameter 1 
  18894.  
  18895.       MPARAM   Parameter 2 
  18896.  
  18897.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18898.       passed to default window handler.) 
  18899.  
  18900.  By default, this method returns 0 and does nothing; the parameters are passed 
  18901.  through to the default window handler, and trigger the behavior associated 
  18902.  with the WM_ENDDRAG message. 
  18903.  
  18904.  MRESULT 
  18905.  
  18906.  
  18907. ΓòÉΓòÉΓòÉ 2.23.2.138. MWindow::winEndSelect() ΓòÉΓòÉΓòÉ
  18908.  
  18909. winEndSelect(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18910.  
  18911.       HWND   Window handle
  18912.  
  18913.       ULONG   Message 
  18914.  
  18915.       MPARAM   Parameter 1 
  18916.  
  18917.       MPARAM   Parameter 2 
  18918.  
  18919.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18920.       passed to default window handler.) 
  18921.  
  18922.  By default, this method returns 0 and does nothing; the parameters are passed 
  18923.  through to the default window handler, and trigger the behavior associated 
  18924.  with the WM_ENDSELECT message. 
  18925.  
  18926.  MRESULT 
  18927.  
  18928.  
  18929. ΓòÉΓòÉΓòÉ 2.23.2.139. MWindow::winEraseBackground() ΓòÉΓòÉΓòÉ
  18930.  
  18931. winEraseBackground(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18932.  
  18933.       HWND   Window handle
  18934.  
  18935.       ULONG   Message 
  18936.  
  18937.       MPARAM   Parameter 1 
  18938.  
  18939.       MPARAM   Parameter 2 
  18940.  
  18941.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18942.       passed to default window handler.) 
  18943.  
  18944.  By default, this method returns 0 and does nothing; the parameters are passed 
  18945.  through to the default window handler, and trigger the behavior associated 
  18946.  with the WM_ERASEBACKGROUND message. 
  18947.  
  18948.  MRESULT 
  18949.  
  18950.  
  18951. ΓòÉΓòÉΓòÉ 2.23.2.140. MWindow::winExtMouseFirst() ΓòÉΓòÉΓòÉ
  18952.  
  18953. winExtMouseFirst(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18954.  
  18955.       HWND   Window handle
  18956.  
  18957.       ULONG   Message 
  18958.  
  18959.       MPARAM   Parameter 1 
  18960.  
  18961.       MPARAM   Parameter 2 
  18962.  
  18963.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18964.       passed to default window handler.) 
  18965.  
  18966.  By default, this method returns 0 and does nothing; the parameters are passed 
  18967.  through to the default window handler. 
  18968.  
  18969.  MRESULT 
  18970.  
  18971.  
  18972. ΓòÉΓòÉΓòÉ 2.23.2.141. MWindow::winExtMouseLast() ΓòÉΓòÉΓòÉ
  18973.  
  18974. winExtMouseLast(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18975.  
  18976.       HWND   Window handle
  18977.  
  18978.       ULONG   Message 
  18979.  
  18980.       MPARAM   Parameter 1 
  18981.  
  18982.       MPARAM   Parameter 2 
  18983.  
  18984.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  18985.       passed to default window handler.) 
  18986.  
  18987.  By default, this method returns 0 and does nothing; the parameters are passed 
  18988.  through to the default window handler. 
  18989.  
  18990.  MRESULT 
  18991.  
  18992.  
  18993. ΓòÉΓòÉΓòÉ 2.23.2.142. MWindow::winFlashWindow() ΓòÉΓòÉΓòÉ
  18994.  
  18995. winFlashWindow(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  18996.  
  18997.       HWND   Window handle
  18998.  
  18999.       ULONG   Message 
  19000.  
  19001.       MPARAM   Parameter 1 
  19002.  
  19003.       MPARAM   Parameter 2 
  19004.  
  19005.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19006.       passed to default window handler.) 
  19007.  
  19008.  By default, this method returns 0 and does nothing; the parameters are passed 
  19009.  through to the default window handler, and trigger the behavior associated 
  19010.  with the WM_FLASHWINDOW message. 
  19011.  
  19012.  MRESULT 
  19013.  
  19014.  
  19015. ΓòÉΓòÉΓòÉ 2.23.2.143. MWindow::winFocusChanged() ΓòÉΓòÉΓòÉ
  19016.  
  19017. winFocusChanged(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19018.  
  19019.       HWND   Window handle
  19020.  
  19021.       ULONG   Message 
  19022.  
  19023.       MPARAM   Parameter 1 
  19024.  
  19025.       MPARAM   Parameter 2 
  19026.  
  19027.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19028.       passed to default window handler.) 
  19029.  
  19030.  By default, this method returns 0 and does nothing; the parameters are passed 
  19031.  through to the default window handler, and trigger the behavior associated 
  19032.  with the WM_FOCUSCHANGE message. 
  19033.  
  19034.  MRESULT 
  19035.  
  19036.  
  19037. ΓòÉΓòÉΓòÉ 2.23.2.144. MWindow::winFormatFrame() ΓòÉΓòÉΓòÉ
  19038.  
  19039. winFormatFrame(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19040.  
  19041.       HWND   Window handle
  19042.  
  19043.       ULONG   Message 
  19044.  
  19045.       MPARAM   Parameter 1 
  19046.  
  19047.       MPARAM   Parameter 2 
  19048.  
  19049.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19050.       passed to default window handler.) 
  19051.  
  19052.  By default, this method returns 0 and does nothing; the parameters are passed 
  19053.  through to the default window handler, and trigger the behavior associated 
  19054.  with the WM_FORMATFRAME message. 
  19055.  
  19056.  MRESULT 
  19057.  
  19058.  
  19059. ΓòÉΓòÉΓòÉ 2.23.2.145. MWindow::winHScroll() ΓòÉΓòÉΓòÉ
  19060.  
  19061. winHScroll(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19062.  
  19063.       HWND   Window handle
  19064.  
  19065.       ULONG   Message 
  19066.  
  19067.       MPARAM   Parameter 1 
  19068.  
  19069.       MPARAM   Parameter 2 
  19070.  
  19071.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19072.       passed to default window handler.) 
  19073.  
  19074.  By default, this method returns 0 and does nothing; the parameters are passed 
  19075.  through to the default window handler, and trigger the behavior associated 
  19076.  with the WM_HSCROLL message. 
  19077.  
  19078.  MRESULT 
  19079.  
  19080.  
  19081. ΓòÉΓòÉΓòÉ 2.23.2.146. MWindow::winHScrollClipboard() ΓòÉΓòÉΓòÉ
  19082.  
  19083. winHScrollClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19084.  
  19085.       HWND   Window handle
  19086.  
  19087.       ULONG   Message 
  19088.  
  19089.       MPARAM   Parameter 1 
  19090.  
  19091.       MPARAM   Parameter 2 
  19092.  
  19093.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19094.       passed to default window handler.) 
  19095.  
  19096.  By default, this method returns 0 and does nothing; the parameters are passed 
  19097.  through to the default window handler, and trigger the behavior associated 
  19098.  with the WM_HSCROLLCLIPBOARD message. 
  19099.  
  19100.  MRESULT 
  19101.  
  19102.  
  19103. ΓòÉΓòÉΓòÉ 2.23.2.147. MWindow::winHelp() ΓòÉΓòÉΓòÉ
  19104.  
  19105. winHelp(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19106.  
  19107.       HWND   Window handle
  19108.  
  19109.       ULONG   Message 
  19110.  
  19111.       MPARAM   Parameter 1 
  19112.  
  19113.       MPARAM   Parameter 2 
  19114.  
  19115.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19116.       passed to default window handler.) 
  19117.  
  19118.  By default, this method returns 0 and does nothing; the parameters are passed 
  19119.  through to the default window handler, and trigger the behavior associated 
  19120.  with the WM_HELP message. 
  19121.  
  19122.  MRESULT 
  19123.  
  19124.  
  19125. ΓòÉΓòÉΓòÉ 2.23.2.148. MWindow::winHitTest() ΓòÉΓòÉΓòÉ
  19126.  
  19127. winHitTest(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19128.  
  19129.       HWND   Window handle
  19130.  
  19131.       ULONG   Message 
  19132.  
  19133.       MPARAM   Parameter 1 
  19134.  
  19135.       MPARAM   Parameter 2 
  19136.  
  19137.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19138.       passed to default window handler.) 
  19139.  
  19140.  By default, this method returns 0 and does nothing; the parameters are passed 
  19141.  through to the default window handler, and trigger the behavior associated 
  19142.  with the WM_HITTEST message. 
  19143.  
  19144.  MRESULT 
  19145.  
  19146.  
  19147. ΓòÉΓòÉΓòÉ 2.23.2.149. MWindow::winInitDlg() ΓòÉΓòÉΓòÉ
  19148.  
  19149. winInitDlg(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19150.  
  19151.       HWND   Window handle
  19152.  
  19153.       ULONG   Message 
  19154.  
  19155.       MPARAM   Parameter 1 
  19156.  
  19157.       MPARAM   Parameter 2 
  19158.  
  19159.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19160.       passed to default window handler.) 
  19161.  
  19162.  By default, this method returns 0 and does nothing; the parameters are passed 
  19163.  through to the default window handler, and trigger the behavior associated 
  19164.  with the WM_INITDLG message. 
  19165.  
  19166.  MRESULT 
  19167.  
  19168.  
  19169. ΓòÉΓòÉΓòÉ 2.23.2.150. MWindow::winInitMenu() ΓòÉΓòÉΓòÉ
  19170.  
  19171. winInitMenu(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19172.  
  19173.       HWND   Window handle
  19174.  
  19175.       ULONG   Message 
  19176.  
  19177.       MPARAM   Parameter 1 
  19178.  
  19179.       MPARAM   Parameter 2 
  19180.  
  19181.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19182.       passed to default window handler.) 
  19183.  
  19184.  By default, this method returns 0 and does nothing; the parameters are passed 
  19185.  through to the default window handler, and trigger the behavior associated 
  19186.  with the WM_INITMENU message. 
  19187.  
  19188.  MRESULT 
  19189.  
  19190.  
  19191. ΓòÉΓòÉΓòÉ 2.23.2.151. MWindow::winJournalNotify() ΓòÉΓòÉΓòÉ
  19192.  
  19193. winJournalNotify(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19194.  
  19195.       HWND 
  19196.  
  19197.       ULONG 
  19198.  
  19199.       MPARAM 
  19200.  
  19201.       MPARAM,int & 
  19202.  
  19203.  By default, this method returns 0 and does nothing; the parameters are passed 
  19204.  through to the default window handler, and trigger the behavior associated 
  19205.  with the WM_JOURNALNOTIFY message. 
  19206.  
  19207.  MRESULT 
  19208.  
  19209.  
  19210. ΓòÉΓòÉΓòÉ 2.23.2.152. MWindow::winMatchMnemonic() ΓòÉΓòÉΓòÉ
  19211.  
  19212. winMatchMnemonic(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19213.  
  19214.       HWND   Window handle
  19215.  
  19216.       ULONG   Message 
  19217.  
  19218.       MPARAM   Parameter 1 
  19219.  
  19220.       MPARAM   Parameter 2 
  19221.  
  19222.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19223.       passed to default window handler.) 
  19224.  
  19225.  By default, this method returns 0 and does nothing; the parameters are passed 
  19226.  through to the default window handler, and trigger the behavior associated 
  19227.  with the WM_MATCHMNEMONIC message. 
  19228.  
  19229.  MRESULT 
  19230.  
  19231.  
  19232. ΓòÉΓòÉΓòÉ 2.23.2.153. MWindow::winMeasureItem() ΓòÉΓòÉΓòÉ
  19233.  
  19234. winMeasureItem(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19235.  
  19236.       HWND   Window handle
  19237.  
  19238.       ULONG   Message 
  19239.  
  19240.       MPARAM   Parameter 1 
  19241.  
  19242.       MPARAM   Parameter 2 
  19243.  
  19244.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19245.       passed to default window handler.) 
  19246.  
  19247.  By default, this method returns 0 and does nothing; the parameters are passed 
  19248.  through to the default window handler, and trigger the behavior associated 
  19249.  with the WM_MEASUREITEM message. 
  19250.  
  19251.  MRESULT 
  19252.  
  19253.  
  19254. ΓòÉΓòÉΓòÉ 2.23.2.154. MWindow::winMenuEnd() ΓòÉΓòÉΓòÉ
  19255.  
  19256. winMenuEnd(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19257.  
  19258.       HWND   Window handle
  19259.  
  19260.       ULONG   Message 
  19261.  
  19262.       MPARAM   Parameter 1 
  19263.  
  19264.       MPARAM   Parameter 2 
  19265.  
  19266.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19267.       passed to default window handler.) 
  19268.  
  19269.  By default, this method returns 0 and does nothing; the parameters are passed 
  19270.  through to the default window handler, and trigger the behavior associated 
  19271.  with the WM_MENUEND message. 
  19272.  
  19273.  MRESULT 
  19274.  
  19275.  
  19276. ΓòÉΓòÉΓòÉ 2.23.2.155. MWindow::winMenuSelect() ΓòÉΓòÉΓòÉ
  19277.  
  19278. winMenuSelect(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19279.  
  19280.       HWND   Window handle
  19281.  
  19282.       ULONG   Message 
  19283.  
  19284.       MPARAM   Parameter 1 
  19285.  
  19286.       MPARAM   Parameter 2 
  19287.  
  19288.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19289.       passed to default window handler.) 
  19290.  
  19291.  By default, this method returns 0 and does nothing; the parameters are passed 
  19292.  through to the default window handler, and trigger the behavior associated 
  19293.  with the WM_MENUSELECT message. 
  19294.  
  19295.  MRESULT 
  19296.  
  19297.  
  19298. ΓòÉΓòÉΓòÉ 2.23.2.156. MWindow::winMinMaxFrame() ΓòÉΓòÉΓòÉ
  19299.  
  19300. winMinMaxFrame(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19301.  
  19302.       HWND   Window handle
  19303.  
  19304.       ULONG   Message 
  19305.  
  19306.       MPARAM   Parameter 1 
  19307.  
  19308.       MPARAM   Parameter 2 
  19309.  
  19310.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19311.       passed to default window handler.) 
  19312.  
  19313.  By default, this method returns 0 and does nothing; the parameters are passed 
  19314.  through to the default window handler, and trigger the behavior associated 
  19315.  with the WM_MINMAXFRAME message. 
  19316.  
  19317.  MRESULT 
  19318.  
  19319.  
  19320. ΓòÉΓòÉΓòÉ 2.23.2.157. MWindow::winMouseLasr() ΓòÉΓòÉΓòÉ
  19321.  
  19322. winMouseLasr(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19323.  
  19324.       HWND   Window handle
  19325.  
  19326.       ULONG   Message 
  19327.  
  19328.       MPARAM   Parameter 1 
  19329.  
  19330.       MPARAM   Parameter 2 
  19331.  
  19332.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19333.       passed to default window handler.) 
  19334.  
  19335.  By default, this method returns 0 and does nothing; the parameters are passed 
  19336.  through to the default window handler. 
  19337.  
  19338.  MRESULT 
  19339.  
  19340.  
  19341. ΓòÉΓòÉΓòÉ 2.23.2.158. MWindow::winMouseLast() ΓòÉΓòÉΓòÉ
  19342.  
  19343. winMouseLast(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19344.  
  19345.       HWND   Window handle
  19346.  
  19347.       ULONG   Message 
  19348.  
  19349.       MPARAM   Parameter 1 
  19350.  
  19351.       MPARAM   Parameter 2 
  19352.  
  19353.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19354.       passed to default window handler.) 
  19355.  
  19356.  By default, this method returns 0 and does nothing; the parameters are passed 
  19357.  through to the default window handler. 
  19358.  
  19359.  MRESULT 
  19360.  
  19361.  
  19362. ΓòÉΓòÉΓòÉ 2.23.2.159. MWindow::winMouseMove() ΓòÉΓòÉΓòÉ
  19363.  
  19364. winMouseMove(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19365.  
  19366.       HWND   Window handle
  19367.  
  19368.       ULONG   Message 
  19369.  
  19370.       MPARAM   Parameter 1 
  19371.  
  19372.       MPARAM   Parameter 2 
  19373.  
  19374.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19375.       passed to default window handler.) 
  19376.  
  19377.  By default, this method returns 0 and does nothing; the parameters are passed 
  19378.  through to the default window handler, and trigger the behavior associated 
  19379.  with the WM_MOUSEMOVE message. 
  19380.  
  19381.  MRESULT 
  19382.  
  19383.  
  19384. ΓòÉΓòÉΓòÉ 2.23.2.160. MWindow::winMouseTranslateFirst() ΓòÉΓòÉΓòÉ
  19385.  
  19386. winMouseTranslateFirst(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19387.  
  19388.       HWND   Window handle
  19389.  
  19390.       ULONG   Message 
  19391.  
  19392.       MPARAM   Parameter 1 
  19393.  
  19394.       MPARAM   Parameter 2 
  19395.  
  19396.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19397.       passed to default window handler.) 
  19398.  
  19399.  By default, this method returns 0 and does nothing; the parameters are passed 
  19400.  through to the default window handler. 
  19401.  
  19402.  MRESULT 
  19403.  
  19404.  
  19405. ΓòÉΓòÉΓòÉ 2.23.2.161. MWindow::winMouseTranslateLast() ΓòÉΓòÉΓòÉ
  19406.  
  19407. winMouseTranslateLast(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19408.  
  19409.       HWND   Window handle
  19410.  
  19411.       ULONG   Message 
  19412.  
  19413.       MPARAM   Parameter 1 
  19414.  
  19415.       MPARAM   Parameter 2 
  19416.  
  19417.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19418.       passed to default window handler.) 
  19419.  
  19420.  By default, this method returns 0 and does nothing; the parameters are passed 
  19421.  through to the default window handler. 
  19422.  
  19423.  MRESULT 
  19424.  
  19425.  
  19426. ΓòÉΓòÉΓòÉ 2.23.2.162. MWindow::winMove() ΓòÉΓòÉΓòÉ
  19427.  
  19428. winMove(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19429.  
  19430.       HWND   Window handle
  19431.  
  19432.       ULONG   Message 
  19433.  
  19434.       MPARAM   Parameter 1 
  19435.  
  19436.       MPARAM   Parameter 2 
  19437.  
  19438.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19439.       passed to default window handler.) 
  19440.  
  19441.  By default, this method returns 0 and does nothing; the parameters are passed 
  19442.  through to the default window handler, and trigger the behavior associated 
  19443.  with the WM_MOVE message. 
  19444.  
  19445.  MRESULT 
  19446.  
  19447.  
  19448. ΓòÉΓòÉΓòÉ 2.23.2.163. MWindow::winNextMenu() ΓòÉΓòÉΓòÉ
  19449.  
  19450. winNextMenu(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19451.  
  19452.       HWND   Window handle
  19453.  
  19454.       ULONG   Message 
  19455.  
  19456.       MPARAM   Parameter 1 
  19457.  
  19458.       MPARAM   Parameter 2 
  19459.  
  19460.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19461.       passed to default window handler.) 
  19462.  
  19463.  By default, this method returns 0 and does nothing; the parameters are passed 
  19464.  through to the default window handler, and trigger the behavior associated 
  19465.  with the WM_NEXTMENU message. 
  19466.  
  19467.  MRESULT 
  19468.  
  19469.  
  19470. ΓòÉΓòÉΓòÉ 2.23.2.164. MWindow::winNull() ΓòÉΓòÉΓòÉ
  19471.  
  19472. winNull(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19473.  
  19474.       HWND   Window handle
  19475.  
  19476.       ULONG   Message 
  19477.  
  19478.       MPARAM   Parameter 1 
  19479.  
  19480.       MPARAM   Parameter 2 
  19481.  
  19482.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19483.       passed to default window handler.) 
  19484.  
  19485.  By default, this method returns 0 and does nothing; the parameters are passed 
  19486.  through to the default window handler, and trigger the behavior associated 
  19487.  with the WM_NULL message. 
  19488.  
  19489.  MRESULT 
  19490.  
  19491.  
  19492. ΓòÉΓòÉΓòÉ 2.23.2.165. MWindow::winOpen() ΓòÉΓòÉΓòÉ
  19493.  
  19494. winOpen(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19495.  
  19496.       HWND   Window handle
  19497.  
  19498.       ULONG   Message 
  19499.  
  19500.       MPARAM   Parameter 1 
  19501.  
  19502.       MPARAM   Parameter 2 
  19503.  
  19504.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19505.       passed to default window handler.) 
  19506.  
  19507.  By default, this method returns 0 and does nothing; the parameters are passed 
  19508.  through to the default window handler, and trigger the behavior associated 
  19509.  with the WM_OPEN message. 
  19510.  
  19511.  MRESULT 
  19512.  
  19513.  
  19514. ΓòÉΓòÉΓòÉ 2.23.2.166. MWindow::winPActivate() ΓòÉΓòÉΓòÉ
  19515.  
  19516. winPActivate(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19517.  
  19518.       HWND   Window handle
  19519.  
  19520.       ULONG   Message 
  19521.  
  19522.       MPARAM   Parameter 1 
  19523.  
  19524.       MPARAM   Parameter 2 
  19525.  
  19526.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19527.       passed to default window handler.) 
  19528.  
  19529.  By default, this method returns 0 and does nothing; the parameters are passed 
  19530.  through to the default window handler, and trigger the behavior associated 
  19531.  with the WM_PACTIVATE message. 
  19532.  
  19533.  MRESULT 
  19534.  
  19535.  
  19536. ΓòÉΓòÉΓòÉ 2.23.2.167. MWindow::winPControl() ΓòÉΓòÉΓòÉ
  19537.  
  19538. winPControl(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19539.  
  19540.       HWND   Window handle
  19541.  
  19542.       ULONG   Message 
  19543.  
  19544.       MPARAM   Parameter 1 
  19545.  
  19546.       MPARAM   Parameter 2 
  19547.  
  19548.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19549.       passed to default window handler.) 
  19550.  
  19551.  By default, this method returns 0 and does nothing; the parameters are passed 
  19552.  through to the default window handler, and trigger the behavior associated 
  19553.  with the WM_PCONTROL message. 
  19554.  
  19555.  MRESULT 
  19556.  
  19557.  
  19558. ΓòÉΓòÉΓòÉ 2.23.2.168. MWindow::winPPaint() ΓòÉΓòÉΓòÉ
  19559.  
  19560. winPPaint(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19561.  
  19562.       HWND   Window handle
  19563.  
  19564.       ULONG   Message 
  19565.  
  19566.       MPARAM   Parameter 1 
  19567.  
  19568.       MPARAM   Parameter 2 
  19569.  
  19570.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19571.       passed to default window handler.) 
  19572.  
  19573.  By default, this method returns 0 and does nothing; the parameters are passed 
  19574.  through to the default window handler, and trigger the behavior associated 
  19575.  with the WM_PPAINT message. 
  19576.  
  19577.  MRESULT 
  19578.  
  19579.  
  19580. ΓòÉΓòÉΓòÉ 2.23.2.169. MWindow::winPSetFocus() ΓòÉΓòÉΓòÉ
  19581.  
  19582. winPSetFocus(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19583.  
  19584.       HWND   Window handle
  19585.  
  19586.       ULONG   Message 
  19587.  
  19588.       MPARAM   Parameter 1 
  19589.  
  19590.       MPARAM   Parameter 2 
  19591.  
  19592.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19593.       passed to default window handler.) 
  19594.  
  19595.  By default, this method returns 0 and does nothing; the parameters are passed 
  19596.  through to the default window handler, and trigger the behavior associated 
  19597.  with the WM_PSETFOCUS message. 
  19598.  
  19599.  MRESULT 
  19600.  
  19601.  
  19602. ΓòÉΓòÉΓòÉ 2.23.2.170. MWindow::winPSize() ΓòÉΓòÉΓòÉ
  19603.  
  19604. winPSize(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19605.  
  19606.       HWND   Window handle
  19607.  
  19608.       ULONG   Message 
  19609.  
  19610.       MPARAM   Parameter 1 
  19611.  
  19612.       MPARAM   Parameter 2 
  19613.  
  19614.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19615.       passed to default window handler.) 
  19616.  
  19617.  By default, this method returns 0 and does nothing; the parameters are passed 
  19618.  through to the default window handler, and trigger the behavior associated 
  19619.  with the WM_PSIZE message. 
  19620.  
  19621.  MRESULT 
  19622.  
  19623.  
  19624. ΓòÉΓòÉΓòÉ 2.23.2.171. MWindow::winPSysColorChange() ΓòÉΓòÉΓòÉ
  19625.  
  19626. winPSysColorChange(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19627.  
  19628.       HWND   Window handle
  19629.  
  19630.       ULONG   Message 
  19631.  
  19632.       MPARAM   Parameter 1 
  19633.  
  19634.       MPARAM   Parameter 2 
  19635.  
  19636.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19637.       passed to default window handler.) 
  19638.  
  19639.  By default, this method returns 0 and does nothing; the parameters are passed 
  19640.  through to the default window handler, and trigger the behavior associated 
  19641.  with the WM_PSYSCOLORCHANGE message. 
  19642.  
  19643.  MRESULT 
  19644.  
  19645.  
  19646. ΓòÉΓòÉΓòÉ 2.23.2.172. MWindow::winPaint() ΓòÉΓòÉΓòÉ
  19647.  
  19648. winPaint(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19649.  
  19650.       HWND   Window handle
  19651.  
  19652.       ULONG   Message 
  19653.  
  19654.       MPARAM   Parameter 1 
  19655.  
  19656.       MPARAM   Parameter 2 
  19657.  
  19658.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19659.       passed to default window handler.) 
  19660.  
  19661.  By default, this method returns 0 and does nothing; the parameters are passed 
  19662.  through to the default window handler, and trigger the behavior associated 
  19663.  with the WM_PAINT message. 
  19664.  
  19665.  MRESULT 
  19666.  
  19667.  
  19668. ΓòÉΓòÉΓòÉ 2.23.2.173. MWindow::winPaintClipboard() ΓòÉΓòÉΓòÉ
  19669.  
  19670. winPaintClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19671.  
  19672.       HWND   Window handle
  19673.  
  19674.       ULONG   Message 
  19675.  
  19676.       MPARAM   Parameter 1 
  19677.  
  19678.       MPARAM   Parameter 2 
  19679.  
  19680.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19681.       passed to default window handler.) 
  19682.  
  19683.  By default, this method returns 0 and does nothing; the parameters are passed 
  19684.  through to the default window handler, and trigger the behavior associated 
  19685.  with the WM_PAINTCLIPBOARD message. 
  19686.  
  19687.  MRESULT 
  19688.  
  19689.  
  19690. ΓòÉΓòÉΓòÉ 2.23.2.174. MWindow::winPing() ΓòÉΓòÉΓòÉ
  19691.  
  19692. winPing(HWND, MPARAM, MPARAM) [virtual] 
  19693.  
  19694.       HWND   Window handle
  19695.  
  19696.       MPARAM   Parameter 1 
  19697.  
  19698.       MPARAM   Parameter 2 
  19699.  
  19700.  By default, this method returns 0 and does nothing; the parameters are passed 
  19701.  through to the default window handler, and trigger the behavior associated 
  19702.  with the MEM_PING message. 
  19703.  
  19704.  MRESULT 
  19705.  
  19706.  
  19707. ΓòÉΓòÉΓòÉ 2.23.2.175. MWindow::winPositionChanged() ΓòÉΓòÉΓòÉ
  19708.  
  19709. winPositionChanged(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19710.  
  19711.       HWND   Window handle
  19712.  
  19713.       ULONG   Message 
  19714.  
  19715.       MPARAM   Parameter 1 
  19716.  
  19717.       MPARAM   Parameter 2 
  19718.  
  19719.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19720.       passed to default window handler.) 
  19721.  
  19722.  By default, this method returns 0 and does nothing; the parameters are passed 
  19723.  through to the default window handler, and trigger the behavior associated 
  19724.  with the WM_WINDOWPOSCHANGED message. 
  19725.  
  19726.  MRESULT 
  19727.  
  19728.  
  19729. ΓòÉΓòÉΓòÉ 2.23.2.176. MWindow::winPresParamChanged() ΓòÉΓòÉΓòÉ
  19730.  
  19731. winPresParamChanged(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19732.  
  19733.       HWND   Window handle
  19734.  
  19735.       ULONG   Message 
  19736.  
  19737.       MPARAM   Parameter 1 
  19738.  
  19739.       MPARAM   Parameter 2 
  19740.  
  19741.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19742.       passed to default window handler.) 
  19743.  
  19744.  By default, this method returns 0 and does nothing; the parameters are passed 
  19745.  through to the default window handler, and trigger the behavior associated 
  19746.  with the WM_PRESPARAMCHANGED message. 
  19747.  
  19748.  MRESULT 
  19749.  
  19750.  
  19751. ΓòÉΓòÉΓòÉ 2.23.2.177. MWindow::winQueryAccelTable() ΓòÉΓòÉΓòÉ
  19752.  
  19753. winQueryAccelTable(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19754.  
  19755.       HWND   Window handle
  19756.  
  19757.       ULONG   Message 
  19758.  
  19759.       MPARAM   Parameter 1 
  19760.  
  19761.       MPARAM   Parameter 2 
  19762.  
  19763.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19764.       passed to default window handler.) 
  19765.  
  19766.  By default, this method returns 0 and does nothing; the parameters are passed 
  19767.  through to the default window handler, and trigger the behavior associated 
  19768.  with the WM_QUERYACCELTABLE message. 
  19769.  
  19770.  MRESULT 
  19771.  
  19772.  
  19773. ΓòÉΓòÉΓòÉ 2.23.2.178. MWindow::winQueryConvertPos() ΓòÉΓòÉΓòÉ
  19774.  
  19775. winQueryConvertPos(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19776.  
  19777.       HWND   Window handle
  19778.  
  19779.       ULONG   Message 
  19780.  
  19781.       MPARAM   Parameter 1 
  19782.  
  19783.       MPARAM   Parameter 2 
  19784.  
  19785.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19786.       passed to default window handler.) 
  19787.  
  19788.  By default, this method returns 0 and does nothing; the parameters are passed 
  19789.  through to the default window handler, and trigger the behavior associated 
  19790.  with the WM_QUERYCONVERTPOS message. 
  19791.  
  19792.  MRESULT 
  19793.  
  19794.  
  19795. ΓòÉΓòÉΓòÉ 2.23.2.179. MWindow::winQueryDlgCode() ΓòÉΓòÉΓòÉ
  19796.  
  19797. winQueryDlgCode(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19798.  
  19799.       HWND   Window handle
  19800.  
  19801.       ULONG   Message 
  19802.  
  19803.       MPARAM   Parameter 1 
  19804.  
  19805.       MPARAM   Parameter 2 
  19806.  
  19807.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19808.       passed to default window handler.) 
  19809.  
  19810.  By default, this method returns 0 and does nothing; the parameters are passed 
  19811.  through to the default window handler, and trigger the behavior associated 
  19812.  with the WM_QUERYDLGCODE message. 
  19813.  
  19814.  MRESULT 
  19815.  
  19816.  
  19817. ΓòÉΓòÉΓòÉ 2.23.2.180. MWindow::winQueryFocusChain() ΓòÉΓòÉΓòÉ
  19818.  
  19819. winQueryFocusChain(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19820.  
  19821.       HWND   Window handle
  19822.  
  19823.       ULONG   Message 
  19824.  
  19825.       MPARAM   Parameter 1 
  19826.  
  19827.       MPARAM   Parameter 2 
  19828.  
  19829.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19830.       passed to default window handler.) 
  19831.  
  19832.  By default, this method returns 0 and does nothing; the parameters are passed 
  19833.  through to the default window handler, and trigger the behavior associated 
  19834.  with the WM_QUERYFOCUSCHAIN message. 
  19835.  
  19836.  MRESULT 
  19837.  
  19838.  
  19839. ΓòÉΓòÉΓòÉ 2.23.2.181. MWindow::winQueryFocusPos() ΓòÉΓòÉΓòÉ
  19840.  
  19841. winQueryFocusPos(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19842.  
  19843.       HWND   Window handle
  19844.  
  19845.       ULONG   Message 
  19846.  
  19847.       MPARAM   Parameter 1 
  19848.  
  19849.       MPARAM   Parameter 2 
  19850.  
  19851.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19852.       passed to default window handler.) 
  19853.  
  19854.  By default, this method returns 0 and does nothing; the parameters are passed 
  19855.  through to the default window handler. 
  19856.  
  19857.  MRESULT 
  19858.  
  19859.  
  19860. ΓòÉΓòÉΓòÉ 2.23.2.182. MWindow::winQueryFrameCount() ΓòÉΓòÉΓòÉ
  19861.  
  19862. winQueryFrameCount(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19863.  
  19864.       HWND   Window handle
  19865.  
  19866.       ULONG   Message 
  19867.  
  19868.       MPARAM   Parameter 1 
  19869.  
  19870.       MPARAM   Parameter 2 
  19871.  
  19872.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19873.       passed to default window handler.) 
  19874.  
  19875.  By default, this method returns 0 and does nothing; the parameters are passed 
  19876.  through to the default window handler, and trigger the behavior associated 
  19877.  with the WM_QUERYFRAMECTLCOUNT message. 
  19878.  
  19879.  MRESULT 
  19880.  
  19881.  
  19882. ΓòÉΓòÉΓòÉ 2.23.2.183. MWindow::winQueryFrameInfo() ΓòÉΓòÉΓòÉ
  19883.  
  19884. winQueryFrameInfo(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19885.  
  19886.       HWND   Window handle
  19887.  
  19888.       ULONG   Message 
  19889.  
  19890.       MPARAM   Parameter 1 
  19891.  
  19892.       MPARAM   Parameter 2 
  19893.  
  19894.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19895.       passed to default window handler.) 
  19896.  
  19897.  By default, this method returns 0 and does nothing; the parameters are passed 
  19898.  through to the default window handler, and trigger the behavior associated 
  19899.  with the WM_QUERYFRAMEINFO message. 
  19900.  
  19901.  MRESULT 
  19902.  
  19903.  
  19904. ΓòÉΓòÉΓòÉ 2.23.2.184. MWindow::winQueryIcon() ΓòÉΓòÉΓòÉ
  19905.  
  19906. winQueryIcon(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19907.  
  19908.       HWND   Window handle
  19909.  
  19910.       ULONG   Message 
  19911.  
  19912.       MPARAM   Parameter 1 
  19913.  
  19914.       MPARAM   Parameter 2 
  19915.  
  19916.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19917.       passed to default window handler.) 
  19918.  
  19919.  By default, this method returns 0 and does nothing; the parameters are passed 
  19920.  through to the default window handler, and trigger the behavior associated 
  19921.  with the WM_QUERYICON message. 
  19922.  
  19923.  MRESULT 
  19924.  
  19925.  
  19926. ΓòÉΓòÉΓòÉ 2.23.2.185. MWindow::winQueryTrackInfo() ΓòÉΓòÉΓòÉ
  19927.  
  19928. winQueryTrackInfo(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19929.  
  19930.       HWND   Window handle
  19931.  
  19932.       ULONG   Message 
  19933.  
  19934.       MPARAM   Parameter 1 
  19935.  
  19936.       MPARAM   Parameter 2 
  19937.  
  19938.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19939.       passed to default window handler.) 
  19940.  
  19941.  By default, this method returns 0 and does nothing; the parameters are passed 
  19942.  through to the default window handler, and trigger the behavior associated 
  19943.  with the WM_QUERYTRACKINFO message. 
  19944.  
  19945.  MRESULT 
  19946.  
  19947.  
  19948. ΓòÉΓòÉΓòÉ 2.23.2.186. MWindow::winQueryWindowParams() ΓòÉΓòÉΓòÉ
  19949.  
  19950. winQueryWindowParams(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19951.  
  19952.       HWND   Window handle
  19953.  
  19954.       ULONG   Message 
  19955.  
  19956.       MPARAM   Parameter 1 
  19957.  
  19958.       MPARAM   Parameter 2 
  19959.  
  19960.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19961.       passed to default window handler.) 
  19962.  
  19963.  By default, this method returns 0 and does nothing; the parameters are passed 
  19964.  through to the default window handler, and trigger the behavior associated 
  19965.  with the WM_QUERYWINDOWPARAMS message. 
  19966.  
  19967.  MRESULT 
  19968.  
  19969.  
  19970. ΓòÉΓòÉΓòÉ 2.23.2.187. MWindow::winQuit() ΓòÉΓòÉΓòÉ
  19971.  
  19972. winQuit(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19973.  
  19974.       HWND   Window handle
  19975.  
  19976.       ULONG   Message 
  19977.  
  19978.       MPARAM   Parameter 1 
  19979.  
  19980.       MPARAM   Parameter 2 
  19981.  
  19982.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  19983.       passed to default window handler.) 
  19984.  
  19985.  By default, this method returns 0 and does nothing; the parameters are passed 
  19986.  through to the default window handler, and trigger the behavior associated 
  19987.  with the WM_QUIT message. 
  19988.  
  19989.  MRESULT 
  19990.  
  19991.  
  19992. ΓòÉΓòÉΓòÉ 2.23.2.188. MWindow::winRenderAllFmts() ΓòÉΓòÉΓòÉ
  19993.  
  19994. winRenderAllFmts(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  19995.  
  19996.       HWND   Window handle
  19997.  
  19998.       ULONG   Message 
  19999.  
  20000.       MPARAM   Parameter 1 
  20001.  
  20002.       MPARAM   Parameter 2 
  20003.  
  20004.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20005.       passed to default window handler.) 
  20006.  
  20007.  By default, this method returns 0 and does nothing; the parameters are passed 
  20008.  through to the default window handler, and trigger the behavior associated 
  20009.  with the WM_RENDERALLFMTS message. 
  20010.  
  20011.  MRESULT 
  20012.  
  20013.  
  20014. ΓòÉΓòÉΓòÉ 2.23.2.189. MWindow::winRenderFmt() ΓòÉΓòÉΓòÉ
  20015.  
  20016. winRenderFmt(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20017.  
  20018.       HWND   Window handle
  20019.  
  20020.       ULONG   Message 
  20021.  
  20022.       MPARAM   Parameter 1 
  20023.  
  20024.       MPARAM   Parameter 2 
  20025.  
  20026.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20027.       passed to default window handler.) 
  20028.  
  20029.  By default, this method returns 0 and does nothing; the parameters are passed 
  20030.  through to the default window handler, and trigger the behavior associated 
  20031.  with the WM_RENDERFMT message. 
  20032.  
  20033.  MRESULT 
  20034.  
  20035.  
  20036. ΓòÉΓòÉΓòÉ 2.23.2.190. MWindow::winSaveApplication() ΓòÉΓòÉΓòÉ
  20037.  
  20038. winSaveApplication(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20039.  
  20040.       HWND   Window handle
  20041.  
  20042.       ULONG   Message 
  20043.  
  20044.       MPARAM   Parameter 1 
  20045.  
  20046.       MPARAM   Parameter 2 
  20047.  
  20048.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20049.       passed to default window handler.) 
  20050.  
  20051.  By default, this method returns 0 and does nothing; the parameters are passed 
  20052.  through to the default window handler, and trigger the behavior associated 
  20053.  with the WM_SAVEAPPLICATION message. 
  20054.  
  20055.  MRESULT 
  20056.  
  20057.  
  20058. ΓòÉΓòÉΓòÉ 2.23.2.191. MWindow::winSem1() ΓòÉΓòÉΓòÉ
  20059.  
  20060. winSem1(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20061.  
  20062.       HWND   Window handle
  20063.  
  20064.       ULONG   Message 
  20065.  
  20066.       MPARAM   Parameter 1 
  20067.  
  20068.       MPARAM   Parameter 2 
  20069.  
  20070.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20071.       passed to default window handler.) 
  20072.  
  20073.  By default, this method returns 0 and does nothing; the parameters are passed 
  20074.  through to the default window handler, and trigger the behavior associated 
  20075.  with the WM_SEM1 message. 
  20076.  
  20077.  MRESULT 
  20078.  
  20079.  
  20080. ΓòÉΓòÉΓòÉ 2.23.2.192. MWindow::winSem2() ΓòÉΓòÉΓòÉ
  20081.  
  20082. winSem2(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20083.  
  20084.       HWND   Window handle
  20085.  
  20086.       ULONG   Message 
  20087.  
  20088.       MPARAM   Parameter 1 
  20089.  
  20090.       MPARAM   Parameter 2 
  20091.  
  20092.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20093.       passed to default window handler.) 
  20094.  
  20095.  By default, this method returns 0 and does nothing; the parameters are passed 
  20096.  through to the default window handler, and trigger the behavior associated 
  20097.  with the WM_SEM2 message. 
  20098.  
  20099.  MRESULT 
  20100.  
  20101.  
  20102. ΓòÉΓòÉΓòÉ 2.23.2.193. MWindow::winSem3() ΓòÉΓòÉΓòÉ
  20103.  
  20104. winSem3(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20105.  
  20106.       HWND   Window handle
  20107.  
  20108.       ULONG   Message 
  20109.  
  20110.       MPARAM   Parameter 1 
  20111.  
  20112.       MPARAM   Parameter 2 
  20113.  
  20114.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20115.       passed to default window handler.) 
  20116.  
  20117.  By default, this method returns 0 and does nothing; the parameters are passed 
  20118.  through to the default window handler, and trigger the behavior associated 
  20119.  with the WM_SEM3 message. 
  20120.  
  20121.  MRESULT 
  20122.  
  20123.  
  20124. ΓòÉΓòÉΓòÉ 2.23.2.194. MWindow::winSem4() ΓòÉΓòÉΓòÉ
  20125.  
  20126. winSem4(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20127.  
  20128.       HWND   Window handle
  20129.  
  20130.       ULONG   Message 
  20131.  
  20132.       MPARAM   Parameter 1 
  20133.  
  20134.       MPARAM   Parameter 2 
  20135.  
  20136.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20137.       passed to default window handler.) 
  20138.  
  20139.  By default, this method returns 0 and does nothing; the parameters are passed 
  20140.  through to the default window handler, and trigger the behavior associated 
  20141.  with the WM_SEM4 message. 
  20142.  
  20143.  MRESULT 
  20144.  
  20145.  
  20146. ΓòÉΓòÉΓòÉ 2.23.2.195. MWindow::winSetAccelTable() ΓòÉΓòÉΓòÉ
  20147.  
  20148. winSetAccelTable(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20149.  
  20150.       HWND   Window handle
  20151.  
  20152.       ULONG   Message 
  20153.  
  20154.       MPARAM   Parameter 1 
  20155.  
  20156.       MPARAM   Parameter 2 
  20157.  
  20158.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20159.       passed to default window handler.) 
  20160.  
  20161.  By default, this method returns 0 and does nothing; the parameters are passed 
  20162.  through to the default window handler, and trigger the behavior associated 
  20163.  with the WM_SETACCELTABLE message. 
  20164.  
  20165.  MRESULT 
  20166.  
  20167.  
  20168. ΓòÉΓòÉΓòÉ 2.23.2.196. MWindow::winSetBorderSize() ΓòÉΓòÉΓòÉ
  20169.  
  20170. winSetBorderSize(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20171.  
  20172.       HWND   Window handle
  20173.  
  20174.       ULONG   Message 
  20175.  
  20176.       MPARAM   Parameter 1 
  20177.  
  20178.       MPARAM   Parameter 2 
  20179.  
  20180.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20181.       passed to default window handler.) 
  20182.  
  20183.  By default, this method returns 0 and does nothing; the parameters are passed 
  20184.  through to the default window handler, and trigger the behavior associated 
  20185.  with the WM_SETBORDERSIZE message. 
  20186.  
  20187.  MRESULT 
  20188.  
  20189.  
  20190. ΓòÉΓòÉΓòÉ 2.23.2.197. MWindow::winSetFocus() ΓòÉΓòÉΓòÉ
  20191.  
  20192. winSetFocus(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20193.  
  20194.       HWND   Window handle
  20195.  
  20196.       ULONG   Message 
  20197.  
  20198.       MPARAM   Parameter 1 
  20199.  
  20200.       MPARAM   Parameter 2 
  20201.  
  20202.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20203.       passed to default window handler.) 
  20204.  
  20205.  By default, this method returns 0 and does nothing; the parameters are passed 
  20206.  through to the default window handler, and trigger the behavior associated 
  20207.  with the WM_SETFOCUS message. 
  20208.  
  20209.  MRESULT 
  20210.  
  20211.  
  20212. ΓòÉΓòÉΓòÉ 2.23.2.198. MWindow::winSetIcon() ΓòÉΓòÉΓòÉ
  20213.  
  20214. winSetIcon(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20215.  
  20216.       HWND   Window handle
  20217.  
  20218.       ULONG   Message 
  20219.  
  20220.       MPARAM   Parameter 1 
  20221.  
  20222.       MPARAM   Parameter 2 
  20223.  
  20224.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20225.       passed to default window handler.) 
  20226.  
  20227.  By default, this method returns 0 and does nothing; the parameters are passed 
  20228.  through to the default window handler, and trigger the behavior associated 
  20229.  with the WM_SETICON message. 
  20230.  
  20231.  MRESULT 
  20232.  
  20233.  
  20234. ΓòÉΓòÉΓòÉ 2.23.2.199. MWindow::winSetSelection() ΓòÉΓòÉΓòÉ
  20235.  
  20236. winSetSelection(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20237.  
  20238.       HWND   Window handle
  20239.  
  20240.       ULONG   Message 
  20241.  
  20242.       MPARAM   Parameter 1 
  20243.  
  20244.       MPARAM   Parameter 2 
  20245.  
  20246.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20247.       passed to default window handler.) 
  20248.  
  20249.  By default, this method returns 0 and does nothing; the parameters are passed 
  20250.  through to the default window handler, and trigger the behavior associated 
  20251.  with the WM_SETSELECTION message. 
  20252.  
  20253.  MRESULT 
  20254.  
  20255.  
  20256. ΓòÉΓòÉΓòÉ 2.23.2.200. MWindow::winSetWindowParams() ΓòÉΓòÉΓòÉ
  20257.  
  20258. winSetWindowParams(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20259.  
  20260.       HWND   Window handle
  20261.  
  20262.       ULONG   Message 
  20263.  
  20264.       MPARAM   Parameter 1 
  20265.  
  20266.       MPARAM   Parameter 2 
  20267.  
  20268.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20269.       passed to default window handler.) 
  20270.  
  20271.  By default, this method returns 0 and does nothing; the parameters are passed 
  20272.  through to the default window handler, and trigger the behavior associated 
  20273.  with the WM_SETWINDOWPARAMS message. 
  20274.  
  20275.  MRESULT 
  20276.  
  20277.  
  20278. ΓòÉΓòÉΓòÉ 2.23.2.201. MWindow::winShow() ΓòÉΓòÉΓòÉ
  20279.  
  20280. winShow(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20281.  
  20282.       HWND   Window handle
  20283.  
  20284.       ULONG   Message 
  20285.  
  20286.       MPARAM   Parameter 1 
  20287.  
  20288.       MPARAM   Parameter 2 
  20289.  
  20290.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20291.       passed to default window handler.) 
  20292.  
  20293.  By default, this method returns 0 and does nothing; the parameters are passed 
  20294.  through to the default window handler, and trigger the behavior associated 
  20295.  with the WM_SHOW message. 
  20296.  
  20297.  MRESULT 
  20298.  
  20299.  
  20300. ΓòÉΓòÉΓòÉ 2.23.2.202. MWindow::winSingleSelect() ΓòÉΓòÉΓòÉ
  20301.  
  20302. winSingleSelect(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20303.  
  20304.       HWND   Window handle
  20305.  
  20306.       ULONG   Message 
  20307.  
  20308.       MPARAM   Parameter 1 
  20309.  
  20310.       MPARAM   Parameter 2 
  20311.  
  20312.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20313.       passed to default window handler.) 
  20314.  
  20315.  By default, this method returns 0 and does nothing; the parameters are passed 
  20316.  through to the default window handler, and trigger the behavior associated 
  20317.  with the WM_SINGLESELECT message. 
  20318.  
  20319.  MRESULT 
  20320.  
  20321.  
  20322. ΓòÉΓòÉΓòÉ 2.23.2.203. MWindow::winSize() ΓòÉΓòÉΓòÉ
  20323.  
  20324. winSize(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20325.  
  20326.       HWND   Window handle
  20327.  
  20328.       ULONG   Message 
  20329.  
  20330.       MPARAM   Parameter 1 
  20331.  
  20332.       MPARAM   Parameter 2 
  20333.  
  20334.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20335.       passed to default window handler.) 
  20336.  
  20337.  By default, this method returns 0 and does nothing; the parameters are passed 
  20338.  through to the default window handler, and trigger the behavior associated 
  20339.  with the WM_SIZE message. 
  20340.  
  20341.  MRESULT 
  20342.  
  20343.  
  20344. ΓòÉΓòÉΓòÉ 2.23.2.204. MWindow::winSizeClipboard() ΓòÉΓòÉΓòÉ
  20345.  
  20346. winSizeClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20347.  
  20348.       HWND   Window handle
  20349.  
  20350.       ULONG   Message 
  20351.  
  20352.       MPARAM   Parameter 1 
  20353.  
  20354.       MPARAM   Parameter 2 
  20355.  
  20356.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20357.       passed to default window handler.) 
  20358.  
  20359.  By default, this method returns 0 and does nothing; the parameters are passed 
  20360.  through to the default window handler, and trigger the behavior associated 
  20361.  with the WM_SIZECLIPBOARD message. 
  20362.  
  20363.  MRESULT 
  20364.  
  20365.  
  20366. ΓòÉΓòÉΓòÉ 2.23.2.205. MWindow::winSubstituteString() ΓòÉΓòÉΓòÉ
  20367.  
  20368. winSubstituteString(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20369.  
  20370.       HWND   Window handle
  20371.  
  20372.       ULONG   Message 
  20373.  
  20374.       MPARAM   Parameter 1 
  20375.  
  20376.       MPARAM   Parameter 2 
  20377.  
  20378.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20379.       passed to default window handler.) 
  20380.  
  20381.  By default, this method returns 0 and does nothing; the parameters are passed 
  20382.  through to the default window handler, and trigger the behavior associated 
  20383.  with the WM_SUBSTITUTESTRING message. 
  20384.  
  20385.  MRESULT 
  20386.  
  20387.  
  20388. ΓòÉΓòÉΓòÉ 2.23.2.206. MWindow::winSysColorChange() ΓòÉΓòÉΓòÉ
  20389.  
  20390. winSysColorChange(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20391.  
  20392.       HWND   Window handle
  20393.  
  20394.       ULONG   Message 
  20395.  
  20396.       MPARAM   Parameter 1 
  20397.  
  20398.       MPARAM   Parameter 2 
  20399.  
  20400.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20401.       passed to default window handler.) 
  20402.  
  20403.  By default, this method returns 0 and does nothing; the parameters are passed 
  20404.  through to the default window handler, and trigger the behavior associated 
  20405.  with the WM_SYSCOLORCHANGE message. 
  20406.  
  20407.  MRESULT 
  20408.  
  20409.  
  20410. ΓòÉΓòÉΓòÉ 2.23.2.207. MWindow::winSysCommand() ΓòÉΓòÉΓòÉ
  20411.  
  20412. winSysCommand(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20413.  
  20414.       HWND   Window handle
  20415.  
  20416.       ULONG   Message 
  20417.  
  20418.       MPARAM   Parameter 1 
  20419.  
  20420.       MPARAM   Parameter 2 
  20421.  
  20422.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20423.       passed to default window handler.) 
  20424.  
  20425.  By default, this method returns 0 and does nothing; the parameters are passed 
  20426.  through to the default window handler, and trigger the behavior associated 
  20427.  with the WM_SYSCOMMAND message. 
  20428.  
  20429.  MRESULT 
  20430.  
  20431.  
  20432. ΓòÉΓòÉΓòÉ 2.23.2.208. MWindow::winSysValueChanged() ΓòÉΓòÉΓòÉ
  20433.  
  20434. winSysValueChanged(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20435.  
  20436.       HWND   Window handle
  20437.  
  20438.       ULONG   Message 
  20439.  
  20440.       MPARAM   Parameter 1 
  20441.  
  20442.       MPARAM   Parameter 2 
  20443.  
  20444.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20445.       passed to default window handler.) 
  20446.  
  20447.  By default, this method returns 0 and does nothing; the parameters are passed 
  20448.  through to the default window handler, and trigger the behavior associated 
  20449.  with the WM_SYSVALUECHANGED message. 
  20450.  
  20451.  MRESULT 
  20452.  
  20453.  
  20454. ΓòÉΓòÉΓòÉ 2.23.2.209. MWindow::winTextEdit() ΓòÉΓòÉΓòÉ
  20455.  
  20456. winTextEdit(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20457.  
  20458.       HWND   Window handle
  20459.  
  20460.       ULONG   Message 
  20461.  
  20462.       MPARAM   Parameter 1 
  20463.  
  20464.       MPARAM   Parameter 2 
  20465.  
  20466.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20467.       passed to default window handler.) 
  20468.  
  20469.  By default, this method returns 0 and does nothing; the parameters are passed 
  20470.  through to the default window handler, and trigger the behavior associated 
  20471.  with the WM_TEXTEDIT message. 
  20472.  
  20473.  MRESULT 
  20474.  
  20475.  
  20476. ΓòÉΓòÉΓòÉ 2.23.2.210. MWindow::winTimer() ΓòÉΓòÉΓòÉ
  20477.  
  20478. winTimer(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20479.  
  20480.       HWND   Window handle
  20481.  
  20482.       ULONG   Message 
  20483.  
  20484.       MPARAM   Parameter 1 
  20485.  
  20486.       MPARAM   Parameter 2 
  20487.  
  20488.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20489.       passed to default window handler.) 
  20490.  
  20491.  By default, this method returns 0 and does nothing; the parameters are passed 
  20492.  through to the default window handler, and trigger the behavior associated 
  20493.  with the WM_TIMER message. 
  20494.  
  20495.  MRESULT 
  20496.  
  20497.  
  20498. ΓòÉΓòÉΓòÉ 2.23.2.211. MWindow::winTrackFrame() ΓòÉΓòÉΓòÉ
  20499.  
  20500. winTrackFrame(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20501.  
  20502.       HWND   Window handle
  20503.  
  20504.       ULONG   Message 
  20505.  
  20506.       MPARAM   Parameter 1 
  20507.  
  20508.       MPARAM   Parameter 2 
  20509.  
  20510.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20511.       passed to default window handler.) 
  20512.  
  20513.  By default, this method returns 0 and does nothing; the parameters are passed 
  20514.  through to the default window handler, and trigger the behavior associated 
  20515.  with the WM_TRACKFRAME message. 
  20516.  
  20517.  MRESULT 
  20518.  
  20519.  
  20520. ΓòÉΓòÉΓòÉ 2.23.2.212. MWindow::winTranslateAccel() ΓòÉΓòÉΓòÉ
  20521.  
  20522. winTranslateAccel(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20523.  
  20524.       HWND   Window handle
  20525.  
  20526.       ULONG   Message 
  20527.  
  20528.       MPARAM   MParam 1 
  20529.  
  20530.       MPARAM   MParam 2 
  20531.  
  20532.       int &   Was this handled? 1 for yes, 0 for no. 
  20533.  
  20534.  By default, this method returns 0 and does nothing; the parameters are passed 
  20535.  through to the default window handler, and trigger the behavior associated 
  20536.  with the WM_TRANSLATEACCEL message. 
  20537.  
  20538.  0 if not handled, 1 if handled. 
  20539.  
  20540.  MRESULT 
  20541.  
  20542.  
  20543. ΓòÉΓòÉΓòÉ 2.23.2.213. MWindow::winUpdateFrame() ΓòÉΓòÉΓòÉ
  20544.  
  20545. winUpdateFrame(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20546.  
  20547.       HWND   Window handle
  20548.  
  20549.       ULONG   Message 
  20550.  
  20551.       MPARAM   Parameter 1 
  20552.  
  20553.       MPARAM   Parameter 2 
  20554.  
  20555.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20556.       passed to default window handler.) 
  20557.  
  20558.  By default, this method returns 0 and does nothing; the parameters are passed 
  20559.  through to the default window handler, and trigger the behavior associated 
  20560.  with the WM_UPDATEFRAME message. 
  20561.  
  20562.  MRESULT 
  20563.  
  20564.  
  20565. ΓòÉΓòÉΓòÉ 2.23.2.214. MWindow::winUpdateSheet() ΓòÉΓòÉΓòÉ
  20566.  
  20567. winUpdateSheet(MChange *) [virtual] 
  20568.  
  20569.       MChange *   List of cells to update 
  20570.  
  20571.  By default, this method returns 0 and does nothing; any class that inherits 
  20572.  from MWindow may override this method to trigger an update. 
  20573.  
  20574.  MRESULT 
  20575.  
  20576.  
  20577. ΓòÉΓòÉΓòÉ 2.23.2.215. MWindow::winVScroll() ΓòÉΓòÉΓòÉ
  20578.  
  20579. winVScroll(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20580.  
  20581.       HWND   Window handle
  20582.  
  20583.       ULONG   Message 
  20584.  
  20585.       MPARAM   Parameter 1 
  20586.  
  20587.       MPARAM   Parameter 2 
  20588.  
  20589.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20590.       passed to default window handler.) 
  20591.  
  20592.  By default, this method returns 0 and does nothing; the parameters are passed 
  20593.  through to the default window handler, and trigger the behavior associated 
  20594.  with the WM_VSCROLL message. 
  20595.  
  20596.  MRESULT 
  20597.  
  20598.  
  20599. ΓòÉΓòÉΓòÉ 2.23.2.216. MWindow::winVScrollClipboard() ΓòÉΓòÉΓòÉ
  20600.  
  20601. winVScrollClipboard(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20602.  
  20603.       HWND   Window handle
  20604.  
  20605.       ULONG   Message 
  20606.  
  20607.       MPARAM   Parameter 1 
  20608.  
  20609.       MPARAM   Parameter 2 
  20610.  
  20611.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20612.       passed to default window handler.) 
  20613.  
  20614.  By default, this method returns 0 and does nothing; the parameters are passed 
  20615.  through to the default window handler, and trigger the behavior associated 
  20616.  with the WM_VSCROLLCLIPBOARD message. 
  20617.  
  20618.  MRESULT 
  20619.  
  20620.  
  20621. ΓòÉΓòÉΓòÉ 2.23.2.217. MWindow::winVioChar() ΓòÉΓòÉΓòÉ
  20622.  
  20623. winVioChar(HWND, ULONG, MPARAM, MPARAM, int &) [virtual] 
  20624.  
  20625.       HWND   Window handle
  20626.  
  20627.       ULONG   Message 
  20628.  
  20629.       MPARAM   Parameter 1 
  20630.  
  20631.       MPARAM   Parameter 2 
  20632.  
  20633.       int &   Was it processed? 1 for yes, 0 for no. (If no, then it will be 
  20634.       passed to default window handler.) 
  20635.  
  20636.  By default, this method returns 0 and does nothing; the parameters are passed 
  20637.  through to the default window handler, and trigger the behavior associated 
  20638.  with the WM_VIOCHAR message. 
  20639.  
  20640.  MRESULT 
  20641.  
  20642.  
  20643. ΓòÉΓòÉΓòÉ 2.24. Other Mesa-specific classes ΓòÉΓòÉΓòÉ
  20644.  
  20645.      MChange 
  20646.  
  20647.      MFrame 
  20648.  
  20649.      MPrintInfo 
  20650.  
  20651.      MDraw 
  20652.  
  20653.      MDDEClientItem 
  20654.  
  20655.      MPassword 
  20656.  
  20657.      MPosition 
  20658.  
  20659.      MImage 
  20660.  
  20661.      MGraphElement 
  20662.  
  20663.  These classes are not directly available through Mesa DOK; however, methods 
  20664.  defined on several DOK classes either return them as values or accept them as 
  20665.  parameters. They are therefore described here briefly, to give you an idea of 
  20666.  what they reprsent and why they are used where they are. 
  20667.  
  20668.  
  20669. ΓòÉΓòÉΓòÉ 2.24.1. MChange ΓòÉΓòÉΓòÉ
  20670.  
  20671. An MChange instance represents a list of cells. It is primarily used to 
  20672. indicate which cells have been changed during a recalculation, reformating, or 
  20673. resizing operation. 
  20674.  
  20675. Each MChange instance keeps track of the addresses of the cells it represents, 
  20676. and also notes how severe the changes are, so other classes can determine how 
  20677. best to handle the change. Note that unlike an MRange instance (see MRange), an 
  20678. MChange instance actually maintains a separate MAddress for each individual 
  20679. cell it represents. 
  20680.  
  20681.  
  20682. ΓòÉΓòÉΓòÉ 2.24.2. MFrame ΓòÉΓòÉΓòÉ
  20683.  
  20684. An MFrame instance represents a graphic object. There are many different types 
  20685. of MFrame within Mesa, falling into three major categories: shapes (such as 
  20686. rectangles and arrows), graphs (such as bar graphs and column graphs), and 
  20687. imported graphics files (such as BMP or MET files). While each type stores 
  20688. different kinds of information (see "Contents of a frame"), they are basically 
  20689. treated identically: each model maintains a list of frames it contains, and 
  20690. each sheet view determines which of those frames is currently being displayed 
  20691. within it. 
  20692.  
  20693. An MFrame instance can be queried and altered via an MFrameXfer instance. For 
  20694. more information, see "MFrameXfer". 
  20695.  
  20696.  
  20697. ΓòÉΓòÉΓòÉ 2.24.3. MGraphElement ΓòÉΓòÉΓòÉ
  20698.  
  20699. An MGraphElement instance represents a displayed object which is contained 
  20700. within a graph frame. For example, titles, subtitles, and legends are all 
  20701. implemented as MGraphElement instances. 
  20702.  
  20703. Each MGraphElement instance keeps track of color, font, border color and 
  20704. thickness. It can also maintain additional attributes related to particular 
  20705. kinds of elements, although it does not do so within Mesa DOK. 
  20706.  
  20707.  
  20708. ΓòÉΓòÉΓòÉ 2.24.4. MPrintInfo ΓòÉΓòÉΓòÉ
  20709.  
  20710. An MPrintInfo instance represents a specific print job. It includes a pointer 
  20711. to a print job header (see MPrintHead) and a variety of other printing-related 
  20712. information (the time and date, how many pages, etc.). 
  20713.  
  20714.  
  20715. ΓòÉΓòÉΓòÉ 2.24.5. MDraw ΓòÉΓòÉΓòÉ
  20716.  
  20717. MDraw implements the drawing primitives within Mesa. It is designed to provide 
  20718. a layer of abstraction between drawing commands within the application and the 
  20719. actual drawing commands executed by the operating system or other host 
  20720. environment. 
  20721.  
  20722.  
  20723. ΓòÉΓòÉΓòÉ 2.24.6. MDDEClientItem ΓòÉΓòÉΓòÉ
  20724.  
  20725. An MDDEClientItem instance represents a DDE link to another DDE-enabled 
  20726. application. It keeps track of the program, the file, the item, the link name, 
  20727. and other information related to a DDE link. 
  20728.  
  20729.  
  20730. ΓòÉΓòÉΓòÉ 2.24.7. MPassword ΓòÉΓòÉΓòÉ
  20731.  
  20732. An MPassword instance represents a file password stored with a given model. If 
  20733. a password is stored with a model and is being used, then the user will be 
  20734. prompted for that password whenever an attempt is made to open the file. 
  20735.  
  20736.  
  20737. ΓòÉΓòÉΓòÉ 2.24.8. MPosition ΓòÉΓòÉΓòÉ
  20738.  
  20739. An MPosition instance represents the positions of one or more windows, 
  20740. generally associated with a single model. It keeps track of the number of 
  20741. windows and a rectangle for each one. Within the Mesa application, it keeps 
  20742. track of the application window's size and state, as well. 
  20743.  
  20744.  
  20745. ΓòÉΓòÉΓòÉ 2.24.9. MImage ΓòÉΓòÉΓòÉ
  20746.  
  20747. MImage is an abstract base class for image processing, and is used to handle 
  20748. the display of bitmaps and metafiles within a sheet view.