home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / programming / c / intuitionpp / doc / ipp_reference_guide.txt < prev    next >
Text File  |  1993-04-08  |  16KB  |  665 lines
  1.  
  2.  
  3.     Intuition++
  4.     Contact :
  5.  
  6.         Brulhart Dominique
  7.         12, rue Lissignol
  8.         1201 Geneva
  9.         Switzerland
  10.  
  11.         Phone : (41 22) 738 34 38
  12.  
  13.         E-Mail : brulhart@cuilima.unige.ch
  14.  
  15.  
  16.  
  17.     Intuition++ Reference Guide
  18.  
  19.  
  20.     The list of all public methods for all I++ classes. Those members are
  21.     for use just like the normal Intuition functions, without their first
  22.     argument (generaly), wich is here the calling instance/object/class.
  23.  
  24.     This list is the list for each class of all his own methods and those
  25.     of all class from wich it derives. This is very exhaustive...
  26.  
  27.     If you need to derive one of those classes, please see definitions of
  28.     protected members in header files, and be carefull of multiple inher-
  29.     itance for classes 'MGWindow', 'GfxWindow', 'WGSreen', 'GScreen' and
  30.     'WScreen'.
  31.  
  32.     Generaly, all methods have the same effect than standard Intuition
  33.     corresponding functions. Some have little difference relying the fact
  34.     that an object is "alive" even when it's closed.
  35.  
  36.     Please see tutorial for I++ specific functions that have no standard
  37.     Intuition equivalent (all event handling functions in 'MsgWindow', 
  38.     'Waiter', 'WScreen' and 'WGScreen', and all window linking to screen
  39.     in 'CScreen'.
  40.  
  41.     All those methods have been created in lowercase because I just prefer
  42.     like that, only 'I' has been typed in uppercase to manifest all my
  43.     respect for Intuition's creators.
  44.  
  45.  
  46.  
  47.  
  48. CFont
  49.  
  50.     CFont();
  51.     CFont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  52.     ~CFont();
  53.  
  54.     BOOL open(STRPTR name , UWORD size, UBYTE style, UBYTE flags);
  55.     void close();
  56.     BOOL isopen();
  57.  
  58.  
  59.  
  60.  
  61.  
  62. CRastPortHdl
  63.  
  64.     CRastPortHdl();
  65.     CRastPortHdl(struct RastPort *validraster);
  66.     ~CRastPortHdl();
  67.  
  68.     BOOL hdlison();
  69.  
  70.     void clear();
  71.     void setpenpos(int x, int y);
  72.     void setapen(int color);
  73.     void setbpen(int color);
  74.     void setdrmd(int mode);
  75.     void setdrpt(int pattern);
  76.     void setrast(int color);
  77.     ULONG setwritemask(ULONG mask);
  78.  
  79.     void setfont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  80.     void setfont(struct TextAttr *textattr);
  81.     struct TextAttr *askfont(struct TextAttr *textattr);
  82.     void writetext(char *string);
  83.     void writetext(int x, int y, char *string);
  84.     WORD textlength(STRPTR string, WORD stringlength);
  85.     ULONG asksoftstyle();
  86.     ULONG setsoftstyle(ULONG mask, ULONG enable);
  87.     void cleareol();
  88.     void printItext(struct IntuiText *itext, WORD x, WORD y);
  89.  
  90.     void writepixel(int x, int y);
  91.     int readpixel(int x, int y);
  92.     void drawline(int x1, int y1, int x2, int y2);
  93.     void drawlineto(int x, int y);
  94.     void drawrect(int x1, int y1, int x2, int y2);
  95.     void drawrectfill(int x1, int y1, int x2, int y2);
  96.     void drawcircle(int x, int y, int radius);
  97.     void drawellipse(int x, int y, int radiusx, int radiusy);
  98.     void drawimage(struct Image *image, int x, int y);
  99.     void flood(int x, int y);
  100.     void polydraw(WORD count, WORD *array);
  101.  
  102.     void scrollraster(WORD dx, WORD dy, WORD xmin, WORD ymin, WORD xmax, WORD ymax);
  103.  
  104.  
  105.  
  106.  
  107. CScreen
  108.  
  109.     CScreen();
  110.     CScreen(struct NewScreen *newscreen);
  111.     CScreen(struct ExtNewScreen *extnewscreen);
  112.     CScreen(struct NewScreen *newscreen, struct TagItem *tags);
  113.     ~CScreen();
  114.  
  115.     virtual BOOL open();
  116.     BOOL isopen();
  117.     virtual void close();
  118.     void resize(int sizex, int sizey);
  119.     void setpos(int x, int y);
  120.     void move(int x, int y);
  121.     void tofront();
  122.     void toback();
  123.  
  124.     void setviewmodes(UWORD modes);
  125.     void showtitle(BOOL yesorno);
  126.     void beep();
  127.  
  128.     int leftedge();
  129.     int topedge();
  130.     int width();
  131.     int height();
  132.     int mousex();
  133.     int mousey();
  134.  
  135.     virtual BOOL linkwindow(CWindow& window);
  136.     virtual CWindow *rmwindow(CWindow& window);
  137.     virtual void rmwindows();
  138.     void openallwindows();
  139.     void closeallwindows();
  140.  
  141.  
  142.  
  143.  
  144. CWindow
  145.  
  146.     CWindow();
  147.     CWindow(struct NewWindow *newwindow);
  148.     CWindow(struct ExtNewWindow *extnewwindow);
  149.     CWindow(struct NewWindow *newwindow, struct TagItem *tags);
  150.     ~CWindow();
  151.  
  152.     virtual BOOL open();
  153.     BOOL isopen();
  154.     virtual void close();
  155.     void resize(int sizex, int sizey);
  156.     void setpos(int x, int y);
  157.     void move(int x, int y);
  158.     void tofront();
  159.     void toback();
  160.     void activate();
  161.  
  162.     void settitle(char *string);
  163.     BOOL setlimit(int xmin, int ymin, int xmax, int ymax);
  164.     ULONG setflags(ULONG flags);
  165.     void setpointer(UWORD *pointerdata, int heigth, int width, int x0, int y0);
  166.     void clearpointer();
  167.     void refreshframe();
  168.  
  169.     int leftedge();
  170.     int topedge();
  171.     int width();
  172.     int height();
  173.     int minwidth();
  174.     int minheight();
  175.     int maxwidth();
  176.     int maxheight();
  177.     unsigned long flags();
  178.     int mousex();
  179.     int mousey();
  180.  
  181.  
  182.  
  183. GfxWindow
  184.  
  185.     GfxWindow();
  186.     GfxWindow(struct NewWindow *newwindow);
  187.     GfxWindow(struct ExtNewWindow *extnewwindow);
  188.     GfxWindow(struct NewWindow *newwindow, struct TagItem *tags);
  189.     ~GfxWindow();
  190.  
  191.     virtual BOOL open();
  192.     BOOL isopen();
  193.     virtual void close();
  194.     void resize(int sizex, int sizey);
  195.     void setpos(int x, int y);
  196.     void move(int x, int y);
  197.     void tofront();
  198.     void toback();
  199.     void activate();
  200.  
  201.     void settitle(char *string);
  202.     BOOL setlimit(int xmin, int ymin, int xmax, int ymax);
  203.     ULONG setflags(ULONG flags);
  204.     void setpointer(UWORD *pointerdata, int heigth, int width, int x0, int y0);
  205.     void clearpointer();
  206.     void refreshframe();
  207.  
  208.     int leftedge();
  209.     int topedge();
  210.     int width();
  211.     int height();
  212.     int minwidth();
  213.     int minheight();
  214.     int maxwidth();
  215.     int maxheight();
  216.     unsigned long flags();
  217.     int mousex();
  218.     int mousey();
  219.  
  220.     BOOL hdlison();
  221.  
  222.     void clear();
  223.     void setpenpos(int x, int y);
  224.     void setapen(int color);
  225.     void setbpen(int color);
  226.     void setdrmd(int mode);
  227.     void setdrpt(int pattern);
  228.     void setrast(int color);
  229.     ULONG setwritemask(ULONG mask);
  230.  
  231.     void setfont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  232.     void setfont(struct TextAttr *textattr);
  233.     struct TextAttr *askfont(struct TextAttr *textattr);
  234.     void writetext(char *string);
  235.     void writetext(int x, int y, char *string);
  236.     WORD textlength(STRPTR string, WORD stringlength);
  237.     ULONG asksoftstyle();
  238.     ULONG setsoftstyle(ULONG mask, ULONG enable);
  239.     void cleareol();
  240.     void printItext(struct IntuiText *itext, WORD x, WORD y);
  241.  
  242.     void writepixel(int x, int y);
  243.     int readpixel(int x, int y);
  244.     void drawline(int x1, int y1, int x2, int y2);
  245.     void drawlineto(int x, int y);
  246.     void drawrect(int x1, int y1, int x2, int y2);
  247.     void drawrectfill(int x1, int y1, int x2, int y2);
  248.     void drawcircle(int x, int y, int radius);
  249.     void drawellipse(int x, int y, int radiusx, int radiusy);
  250.     void drawimage(struct Image *image, int x, int y);
  251.     void flood(int x, int y);
  252.     void polydraw(WORD count, WORD *array);
  253.  
  254.     void scrollraster(WORD dx, WORD dy, WORD xmin, WORD ymin, WORD xmax, WORD ymax);
  255.  
  256.  
  257.  
  258.  
  259. GScreen
  260.  
  261.     GScreen();
  262.     GScreen(struct NewScreen *newscreen);
  263.     GScreen(struct ExtNewScreen *extnewscreen);
  264.     GScreen(struct NewScreen *newscreen, struct TagItem *tags);
  265.     ~GScreen();
  266.  
  267.     virtual BOOL open();
  268.     BOOL isopen();
  269.     virtual void close();
  270.     void resize(int sizex, int sizey);
  271.     void setpos(int x, int y);
  272.     void move(int x, int y);
  273.     void tofront();
  274.     void toback();
  275.  
  276.     void setviewmodes(UWORD modes);
  277.     void showtitle(BOOL yesorno);
  278.     void beep();
  279.  
  280.     int leftedge();
  281.     int topedge();
  282.     int width();
  283.     int height();
  284.     int mousex();
  285.     int mousey();
  286.  
  287.     virtual BOOL linkwindow(CWindow& window);
  288.     virtual CWindow *rmwindow(CWindow& window);
  289.     virtual void rmwindows();
  290.     void openallwindows();
  291.     void closeallwindows();
  292.  
  293.     BOOL hdlison();
  294.  
  295.     void clear();
  296.     void setpenpos(int x, int y);
  297.     void setapen(int color);
  298.     void setbpen(int color);
  299.     void setdrmd(int mode);
  300.     void setdrpt(int pattern);
  301.     void setrast(int color);
  302.     ULONG setwritemask(ULONG mask);
  303.  
  304.     void setfont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  305.     void setfont(struct TextAttr *textattr);
  306.     struct TextAttr *askfont(struct TextAttr *textattr);
  307.     void writetext(char *string);
  308.     void writetext(int x, int y, char *string);
  309.     WORD textlength(STRPTR string, WORD stringlength);
  310.     ULONG asksoftstyle();
  311.     ULONG setsoftstyle(ULONG mask, ULONG enable);
  312.     void cleareol();
  313.     void printItext(struct IntuiText *itext, WORD x, WORD y);
  314.  
  315.     void writepixel(int x, int y);
  316.     int readpixel(int x, int y);
  317.     void drawline(int x1, int y1, int x2, int y2);
  318.     void drawlineto(int x, int y);
  319.     void drawrect(int x1, int y1, int x2, int y2);
  320.     void drawrectfill(int x1, int y1, int x2, int y2);
  321.     void drawcircle(int x, int y, int radius);
  322.     void drawellipse(int x, int y, int radiusx, int radiusy);
  323.     void drawimage(struct Image *image, int x, int y);
  324.     void flood(int x, int y);
  325.     void polydraw(WORD count, WORD *array);
  326.  
  327.     void scrollraster(WORD dx, WORD dy, WORD xmin, WORD ymin, WORD xmax, WORD ymax);
  328.  
  329.  
  330.  
  331.  
  332. IEvent
  333.  
  334.     IEvent();
  335.     ~IEvent();
  336.  
  337.     void clear();
  338.     ULONG eclass;
  339.     ULONG ecode;
  340.     ULONG equalifier;
  341.     void *eitem;
  342.     void (*ecallback)(IMessage *);
  343.     IEvent *nextevent;
  344.  
  345.  
  346.  
  347.  
  348. IMessage
  349.  
  350.     IMessage();
  351.     ~IMessage();
  352.  
  353.     void clear();
  354.     ULONG iclass;
  355.     ULONG icode;
  356.     ULONG iqualifier;
  357.     void * iaddress;
  358.     int imousex;
  359.     int imousey;
  360.     ULONG iseconds;
  361.     ULONG imicros;
  362.  
  363.  
  364.  
  365.  
  366. MGWindow
  367.  
  368.     MGWindow();
  369.     MGWindow(struct NewWindow *newwindow);
  370.     MGWindow(struct ExtNewWindow *extnewwindow);
  371.     MGWindow(struct NewWindow *newwindow, struct TagItem *tags);
  372.     ~MGWindow();
  373.  
  374.     virtual BOOL open();
  375.     BOOL isopen();
  376.     virtual void close();
  377.     void resize(int sizex, int sizey);
  378.     void setpos(int x, int y);
  379.     void move(int x, int y);
  380.     void tofront();
  381.     void toback();
  382.     void activate();
  383.  
  384.     void settitle(char *string);
  385.     BOOL setlimit(int xmin, int ymin, int xmax, int ymax);
  386.     ULONG setflags(ULONG flags);
  387.     void setpointer(UWORD *pointerdata, int heigth, int width, int x0, int y0);
  388.     void clearpointer();
  389.     void refreshframe();
  390.  
  391.     int leftedge();
  392.     int topedge();
  393.     int width();
  394.     int height();
  395.     int minwidth();
  396.     int minheight();
  397.     int maxwidth();
  398.     int maxheight();
  399.     unsigned long flags();
  400.     int mousex();
  401.     int mousey();
  402.  
  403.     BOOL hdlison();
  404.  
  405.     void clear();
  406.     void setpenpos(int x, int y);
  407.     void setapen(int color);
  408.     void setbpen(int color);
  409.     void setdrmd(int mode);
  410.     void setdrpt(int pattern);
  411.     void setrast(int color);
  412.     ULONG setwritemask(ULONG mask);
  413.  
  414.     void setfont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  415.     void setfont(struct TextAttr *textattr);
  416.     struct TextAttr *askfont(struct TextAttr *textattr);
  417.     void writetext(char *string);
  418.     void writetext(int x, int y, char *string);
  419.     WORD textlength(STRPTR string, WORD stringlength);
  420.     ULONG asksoftstyle();
  421.     ULONG setsoftstyle(ULONG mask, ULONG enable);
  422.     void cleareol();
  423.     void printItext(struct IntuiText *itext, WORD x, WORD y);
  424.  
  425.     void writepixel(int x, int y);
  426.     int readpixel(int x, int y);
  427.     void drawline(int x1, int y1, int x2, int y2);
  428.     void drawlineto(int x, int y);
  429.     void drawrect(int x1, int y1, int x2, int y2);
  430.     void drawrectfill(int x1, int y1, int x2, int y2);
  431.     void drawcircle(int x, int y, int radius);
  432.     void drawellipse(int x, int y, int radiusx, int radiusy);
  433.     void drawimage(struct Image *image, int x, int y);
  434.     void flood(int x, int y);
  435.     void polydraw(WORD count, WORD *array);
  436.  
  437.     void scrollraster(WORD dx, WORD dy, WORD xmin, WORD ymin, WORD xmax, WORD ymax);
  438.  
  439.     ULONG setIDCMPflags(ULONG idcmpflags);
  440.     ULONG getIDCMPflags();
  441.  
  442.     struct Gadget * linkgadgets(struct Gadget *gadgetlist);
  443.     struct Gadget * rmgadgets();
  444.     void refreshgadgets(struct Gadget *gadgetlist);
  445.     void refreshglist(struct Gadget *gadgetlist, WORD count);
  446.     BOOL activategadget(struct Gadget *gadget);
  447.     void ongadget(struct Gadget *gadget);
  448.     void offgadget(struct Gadget *gadget);
  449.  
  450.     struct Menu * linkmenu(struct Menu *menu);
  451.     struct Menu * rmmenu();
  452.     void onmenu(UWORD menunumber);
  453.     void offmenu(UWORD menunumber);
  454.  
  455.     void reportmouse(BOOL yesorno);
  456.  
  457.     BOOL linkIevent(ULONG iclass, ULONG icode, ULONG iqualifier, void *object, void (*callback)(IMessage&));
  458.     void rmIevents();
  459.  
  460.     IMessage * getImsg(IMessage& imessage);
  461.     IMessage * waitImsg(IMessage& imessage);
  462.     void clearImsg();
  463.     IMessage * filterImsg(IMessage& imessage);
  464.     IMessage * softcontrol(IMessage& imessage);
  465.     void hardcontrol();
  466.  
  467.  
  468.  
  469. MsgWindow
  470.  
  471.     MsgWindow();
  472.     MsgWindow(struct NewWindow *newwindow);
  473.     MsgWindow(struct ExtNewWindow *extnewwindow);
  474.     MsgWindow(struct NewWindow *newwindow, struct TagItem *tags);
  475.     ~MsgWindow();
  476.  
  477.     virtual BOOL open();
  478.     BOOL isopen();
  479.     virtual void close();
  480.     void resize(int sizex, int sizey);
  481.     void setpos(int x, int y);
  482.     void move(int x, int y);
  483.     void tofront();
  484.     void toback();
  485.     void activate();
  486.  
  487.     void settitle(char *string);
  488.     BOOL setlimit(int xmin, int ymin, int xmax, int ymax);
  489.     ULONG setflags(ULONG flags);
  490.     void setpointer(UWORD *pointerdata, int heigth, int width, int x0, int y0);
  491.     void clearpointer();
  492.     void refreshframe();
  493.  
  494.     int leftedge();
  495.     int topedge();
  496.     int width();
  497.     int height();
  498.     int minwidth();
  499.     int minheight();
  500.     int maxwidth();
  501.     int maxheight();
  502.     unsigned long flags();
  503.     int mousex();
  504.     int mousey();
  505.  
  506.     ULONG setIDCMPflags(ULONG idcmpflags);
  507.     ULONG getIDCMPflags();
  508.  
  509.     struct Gadget * linkgadgets(struct Gadget *gadgetlist);
  510.     struct Gadget * rmgadgets();
  511.     void refreshgadgets(struct Gadget *gadgetlist);
  512.     void refreshglist(struct Gadget *gadgetlist, WORD count);
  513.     BOOL activategadget(struct Gadget *gadget);
  514.     void ongadget(struct Gadget *gadget);
  515.     void offgadget(struct Gadget *gadget);
  516.  
  517.     struct Menu * linkmenu(struct Menu *menu);
  518.     struct Menu * rmmenu();
  519.     void onmenu(UWORD menunumber);
  520.     void offmenu(UWORD menunumber);
  521.  
  522.     void reportmouse(BOOL yesorno);
  523.  
  524.     BOOL linkIevent(ULONG iclass, ULONG icode, ULONG iqualifier, void *object, void (*callback)(IMessage&));
  525.     void rmIevents();
  526.  
  527.     IMessage * getImsg(IMessage& imessage);
  528.     IMessage * waitImsg(IMessage& imessage);
  529.     void clearImsg();
  530.     IMessage * filterImsg(IMessage& imessage);
  531.     IMessage * softcontrol(IMessage& imessage);
  532.     void hardcontrol();
  533.  
  534.  
  535.  
  536.  
  537.  
  538. Waiter
  539.  
  540.     Waiter();
  541.     ~Waiter();
  542.     virtual BOOL linkwindow(MsgWindow& window);
  543.     virtual MsgWindow * rmwindow(MsgWindow& window);
  544.     virtual void rmwindows();
  545.     MsgWindow * softcontrol(IMessage& messagenothandled);
  546.     void hardcontrol();
  547.  
  548.  
  549.  
  550.  
  551. WGScreen
  552.  
  553.     WGScreen();
  554.     WGScreen(struct NewScreen *newscreen);
  555.     WGScreen(struct ExtNewScreen *extnewscreen);
  556.     WGScreen(struct NewScreen *newscreen, struct TagItem *tags);
  557.     ~WGScreen();
  558.  
  559.     virtual BOOL open();
  560.     BOOL isopen();
  561.     virtual void close();
  562.     void resize(int sizex, int sizey);
  563.     void setpos(int x, int y);
  564.     void move(int x, int y);
  565.     void tofront();
  566.     void toback();
  567.  
  568.     void setviewmodes(UWORD modes);
  569.     void showtitle(BOOL yesorno);
  570.     void beep();
  571.  
  572.     int leftedge();
  573.     int topedge();
  574.     int width();
  575.     int height();
  576.     int mousex();
  577.     int mousey();
  578.  
  579.     void openallwindows();
  580.     void closeallwindows();
  581.  
  582.     BOOL hdlison();
  583.  
  584.     void clear();
  585.     void setpenpos(int x, int y);
  586.     void setapen(int color);
  587.     void setbpen(int color);
  588.     void setdrmd(int mode);
  589.     void setdrpt(int pattern);
  590.     void setrast(int color);
  591.     ULONG setwritemask(ULONG mask);
  592.  
  593.     void setfont(STRPTR name, UWORD size, UBYTE style, UBYTE flags);
  594.     void setfont(struct TextAttr *textattr);
  595.     struct TextAttr *askfont(struct TextAttr *textattr);
  596.     void writetext(char *string);
  597.     void writetext(int x, int y, char *string);
  598.     WORD textlength(STRPTR string, WORD stringlength);
  599.     ULONG asksoftstyle();
  600.     ULONG setsoftstyle(ULONG mask, ULONG enable);
  601.     void cleareol();
  602.     void printItext(struct IntuiText *itext, WORD x, WORD y);
  603.  
  604.     void writepixel(int x, int y);
  605.     int readpixel(int x, int y);
  606.     void drawline(int x1, int y1, int x2, int y2);
  607.     void drawlineto(int x, int y);
  608.     void drawrect(int x1, int y1, int x2, int y2);
  609.     void drawrectfill(int x1, int y1, int x2, int y2);
  610.     void drawcircle(int x, int y, int radius);
  611.     void drawellipse(int x, int y, int radiusx, int radiusy);
  612.     void drawimage(struct Image *image, int x, int y);
  613.     void flood(int x, int y);
  614.     void polydraw(WORD count, WORD *array);
  615.  
  616.     void scrollraster(WORD dx, WORD dy, WORD xmin, WORD ymin, WORD xmax, WORD ymax);
  617.  
  618.     virtual BOOL linkwindow(MsgWindow& window);
  619.     virtual MsgWindow * rmwindow(MsgWindow& window);
  620.     virtual void rmwindows();
  621.  
  622.     MsgWindow * softcontrol(IMessage& messagenothandled);
  623.     void hardcontrol();
  624.  
  625.  
  626.  
  627.  
  628. WScreen
  629.  
  630.     WScreen();
  631.     WScreen(struct NewScreen *newscreen);
  632.     WScreen(struct ExtNewScreen *extnewscreen);
  633.     WScreen(struct NewScreen *newscreen, struct TagItem *tags);
  634.     ~WScreen();
  635.  
  636.     virtual BOOL open();
  637.     BOOL isopen();
  638.     virtual void close();
  639.     void resize(int sizex, int sizey);
  640.     void setpos(int x, int y);
  641.     void move(int x, int y);
  642.     void tofront();
  643.     void toback();
  644.  
  645.     void setviewmodes(UWORD modes);
  646.     void showtitle(BOOL yesorno);
  647.     void beep();
  648.  
  649.     int leftedge();
  650.     int topedge();
  651.     int width();
  652.     int height();
  653.     int mousex();
  654.     int mousey();
  655.  
  656.     void openallwindows();
  657.     void closeallwindows();
  658.  
  659.     virtual BOOL linkwindow(MsgWindow& window);
  660.     virtual MsgWindow * rmwindow(MsgWindow& window);
  661.     virtual void rmwindows();
  662.  
  663.     MsgWindow * softcontrol(IMessage& messagenothandled);
  664.     void hardcontrol();
  665.