From 91268e6b0c52b6bf821bada9d0bb2da02a6f4f2b Mon Sep 17 00:00:00 2001 From: Phil Rosenberg Date: Tue, 22 Dec 2015 22:32:59 +0000 Subject: [PATCH] Added documentation for PLGraphicsIn::state and moved PLTranslateCursor documentation to the C-api. --- doc/docbook/src/api-c.xml | 57 ++++++++++++++++++++++++++++++++++++++++++++++- doc/docbook/src/api.xml | 53 +------------------------------------------ 2 files changed, 57 insertions(+), 53 deletions(-) diff --git a/doc/docbook/src/api-c.xml b/doc/docbook/src/api-c.xml index 2132ec1..e3a5083 100644 --- a/doc/docbook/src/api-c.xml +++ b/doc/docbook/src/api-c.xml @@ -1149,6 +1149,57 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + + <function>plTranslateCursor</function>: Convert device to world coordinates + + + + + + + plTranslateCursor + + + gin + + + + + + + Convert from device to world coordinates. The variable gin must have + members dX and dY set before the call.These represent the coordinates + of the point as a fraction of the total drawing area. If the point passed in is + on a window then the function returns 1, members wX and wY will be filled with + the world coordinates of that point and the subwindow member will be + filled with the index of the window on which the point falls. If the point + falls on more than one window (because they overlap) then the window + with the lowest index is used. If the point does not fall on a window then + the function returns 0, wX and wY are set to 0 and subwindow remains + unchanged. + + + + + + gin + (PLGraphicsIn *, input/output) + + + + Pointer to a graphics in structure to hold the input and output coordinates. + + + + + + + Redacted form: plTranslateCursor(gin) + + + <structname>PLGraphicsIn</structname>: PLplot Graphics Input structure @@ -1179,7 +1230,11 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - Key or button mask. + Key or button mask. Consists of a combination of the following masks: PL_MASK_SHIFT, + PL_MASK_CAPS, PL_MASK_CONTROL, PL_MASK_ALT, PL_MASK_NUM PL_MASK_ALTGR, + PL_MASK_WIN, PL_MASK_SCROLL, PL_MASK_BUTTON1, PL_MASK_BUTTON2, + PL_MASK_BUTTON3, PL_MASK_BUTTON4, PL_MASK_BUTTON5. The button values indicate + mouse buttons. Caps, num and scroll indicate that the appropriate lock is on. diff --git a/doc/docbook/src/api.xml b/doc/docbook/src/api.xml index fd48e68..9caefcb 100644 --- a/doc/docbook/src/api.xml +++ b/doc/docbook/src/api.xml @@ -16920,7 +16920,7 @@ device support!) xleng - (PLINT, input) + (PLINT , input) @@ -20067,57 +20067,6 @@ device support!) - - - <function>plTranslateCursor</function>: Convert device to world coordinates - - - - - - - plTranslateCursor - - - gin - - - - - - - Convert from device to world coordinates. The variable gin must have - members dX and dY set before the call.These represent the coordinates - of the point as a fraction of the total drawing area. If the point passed in is - on a window then the function returns 1, members wX and wY will be filled with - the world coordinates of that point and the subwindow member will be - filled with the index of the window on which the point falls. If the point - falls on more than one window (because they overlap) then the window - with the lowest index is used. If the point does not fall on a window then - the function returns 0, wX and wY are set to 0 and subwindow remains - unchanged. - - - - - - gin - (PLGraphicsIn *, input/output) - - - - Pointer to a graphics in structure to hold the input and output coordinates. - - - - - - - Redacted form: plTranslateCursor(gin) - - - - <function>plvasp</function>: Specify viewport using aspect ratio only -- 2.5.3