Laxkit  0.0.7.1
Public Member Functions | Public Attributes | Protected Attributes
LaxInterfaces::CaptionInterface Class Reference

Interface for manipulating CaptionData objects. More...

Inheritance diagram for LaxInterfaces::CaptionInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CaptionInterface (int nid, Laxkit::Displayer *ndp, const char *newtext)
virtual anInterfaceduplicate (anInterface *dup)
 Return new CaptionInterface.
virtual const charIconId ()
virtual const charName ()
virtual const charwhattype ()
virtual const charwhatdatatype ()
virtual void deletedata ()
 Sets data=NULL.
virtual ObjectContextContext ()
virtual int LBDown (int x, int y, unsigned int state, int count, const Laxkit::LaxMouse *d)
 If !data on LBDown, then make a new one...
virtual int LBUp (int x, int y, unsigned int state, const Laxkit::LaxMouse *d)
 If data, then call viewport->ObjectMoved(data).
virtual int MouseMove (int x, int y, unsigned int state, const Laxkit::LaxMouse *d)
virtual int CharInput (unsigned int ch, const char *buffer, int len, unsigned int state, const Laxkit::LaxKeyboard *d)
virtual int KeyUp (unsigned int ch, unsigned int state, const Laxkit::LaxKeyboard *d)
virtual int Refresh ()
virtual int DrawData (Laxkit::anObject *ndata, Laxkit::anObject *a1=NULL, Laxkit::anObject *a2=NULL, int info=0)
 Draw ndata, but remember that data should still be the resident data afterward.
virtual int UseThis (Laxkit::anObject *nobj, unsigned int mask=0)
 Check out nobj and use it as the data if possible.
virtual CaptionDatanewData ()
 Create and return new data, also calls viewport->newData(newdata,0).
virtual int InterfaceOn ()
 Sets showdecs=3, and needtodraw=1.
virtual int InterfaceOff ()
 Calls Clear(), sets showdecs=0, and needtodraw=1.
virtual void Clear (SomeData *d)
- Public Member Functions inherited from LaxInterfaces::anInterface
 anInterface ()
 This constructor assigns id=getUniqueNumber().
 anInterface (int nid)
 Constructor to assign just the id, set other stuff to 0.
 anInterface (int nid, Laxkit::Displayer *ndp)
 anInterface (anInterface *nowner, int nid)
 Constructor to assign owner and id.
 anInterface (anInterface *nowner, int nid, Laxkit::Displayer *ndp)
virtual Laxkit::ShortcutHandlerGetShortcuts ()
 Return a ShortcutHandler that contains stacks of bound shortcuts and possible actions.
virtual int PerformAction (int actionnumber)
virtual int draws (const char *atype)
 Returns !strcmp(whatdatatype(),atype).
virtual void Clear ()
 Default just calls Clear(NULL).
virtual int RemoveChild ()
 If there is a child, do something to remove it.
virtual int AddChild (LaxInterfaces::anInterface *ch, int absorbcount, int addbefore)
virtual int Needtodraw ()
 Must return nonzero if the data needs to be drawn, that is to say Refresh must be called.
virtual int Needtodraw (int n)
virtual int MBDown (int x, int y, unsigned int state, int count, const Laxkit::LaxMouse *d)
virtual int RBDown (int x, int y, unsigned int state, int count, const Laxkit::LaxMouse *d)
virtual int MBUp (int x, int y, unsigned int state, const Laxkit::LaxMouse *d)
virtual int RBUp (int x, int y, unsigned int state, const Laxkit::LaxMouse *d)
virtual int WheelUp (int x, int y, unsigned int state, int count, const Laxkit::LaxMouse *d)
virtual int WheelDown (int x, int y, unsigned int state, int count, const Laxkit::LaxMouse *d)
virtual int DeviceChange (const Laxkit::DeviceEventData *e)
virtual int Event (const Laxkit::EventData *e, const char *mes)
 Respond to events, particularly menu events from a menu created from ContextMenu().
virtual void ExposeChange (Laxkit::ScreenEventData *e)
virtual void ViewportResized ()
 Called after the parent viewport gets resized.
virtual void Mapped ()
 Called after the parent viewport gets mapped (made visible).
virtual void Unmapped ()
 Called after the parent viewport gets mapped (made invisible, such as offscreen, not merely obscured).
virtual void PostMessage (const char *message)
 If viewport, use that, else app->postmessage().
virtual Laxkit::MenuInfoContextMenu (int x, int y, int deviceid)
 Return a context sensitive menu for screen position (x,y).
virtual int UseThis (int id, int ndata)
 Return 1 if the id/ndata is used, otherwise zero.
virtual int UseThisObject (ObjectContext *oc)
virtual Laxkit::anXWindowCurrentWindow (Laxkit::anXWindow *ncur)
 Set the window the interface works on to ncur. Returns ncur. If ncur==NULL, then just return current viewport.
virtual void Dp (Laxkit::Displayer *ndp)
 Set the dp to ndp, and update curwindow/viewport.
virtual int DrawDataDp (Laxkit::Displayer *tdp, SomeData *tdata, Laxkit::anObject *a1=NULL, Laxkit::anObject *a2=NULL, int info=1)
 Use a different dp to draw data with.
virtual flatpoint realtoscreen (flatpoint r)
 Do a little extra checking to find what point r should correspond to.
virtual flatpoint screentoreal (int x, int y)
 Do a little extra checking to find what point (x,y) should correspond to.
virtual double Getmag (int c=0)
 Do a little extra checking to find what the magnification is.
virtual double GetVMag (int x, int y)
 Do a little extra checking to find what the magnification is.
virtual void dump_out (FILE *f, int indent, int what, Laxkit::anObject *savecontext)
 Default settings saving is to output nothing.
virtual void dump_in_atts (LaxFiles::Attribute *att, int flag, Laxkit::anObject *loadcontext)
 Placeholder for dumping in settings.
- Public Member Functions inherited from LaxFiles::DumpUtility
virtual Attributedump_out_atts (Attribute *att, int what, Laxkit::anObject *savecontext)
 Default is return NULL. what==0 means write out normal Attribute formatted things.
virtual void dump_in (FILE *f, int indent, int what, Laxkit::anObject *loadcontext, Attribute **att)
 Read in a file segment as an Attribute, and pass parsing duties to dump_in_atts.
virtual ~DumpUtility ()
 Empty virtual destructor.

Public Attributes

int showdecs
CaptionDatadata
ObjectContextcoc
- Public Attributes inherited from LaxInterfaces::anInterface
charname
 An instance name.. ***don't think this is used anywhere at the moment.
int id
 Must be positive, other values are reserved for internal use.
unsigned long style
 Style flags for the interface. Meaning depends on the interface.
int interface_type
 What sort of interface this is. Default is INTERFACE_Tool.
Laxkit::anXAppapp
 The application this interface works with.
Laxkit::anXWindowcurwindow
 The window the interface currently works on.
anInterfaceowner
 The interface that owns this one.
anInterfacechild
 The child of this interface. See anInterface::owner. This is dec_counted in destructor.
int primary
 Whether this is supposed to be a 'main' interface, or merely a helper.
int needtodraw
 Whether the interface thinks it has to refresh.

Protected Attributes

int mode
int mousedragged
flatpoint leftp
int mx
int my
int lx
int ly
int caretline
int caretpos
- Protected Attributes inherited from LaxInterfaces::anInterface
Laxkit::ButtonDownInfo buttondown
ViewportWindowviewport
 curwindow dynamically cast to ViewportWindow. Thus, it will be NULL if it is not a ViewportWindow.
Laxkit::Displayerdp
 The Displayer used by the controlling window.

Detailed Description

Interface for manipulating CaptionData objects.

Todo:
this could also be used for little sticky notes in the viewport, these would be text blocks that are not transformed with the viewport's matrix..

Member Function Documentation

void LaxInterfaces::CaptionInterface::deletedata ( )
virtual

Sets data=NULL.

That results in data->dec_count() being called somewhere along the line.

References Laxkit::anObject::dec_count().

anInterface * LaxInterfaces::CaptionInterface::duplicate ( anInterface dup)
virtual

Return new CaptionInterface.

If dup!=NULL and it cannot be cast to CaptionInterface, then return NULL.

Reimplemented from LaxInterfaces::anInterface.

int LaxInterfaces::CaptionInterface::LBDown ( int  x,
int  y,
unsigned int  state,
int  count,
const Laxkit::LaxMouse d 
)
virtual
CaptionData * LaxInterfaces::CaptionInterface::newData ( )
virtual

Create and return new data, also calls viewport->newData(newdata,0).

Please note that this function is not a redefinition of anything. It is used internally to get a new instance of CaptionData and also tell the viewport about it.

This function causes a new CaptionData to be created and to have a count of 2. Currently, new CaptionData makes the maxx/maxy be the image pixel width/height..

Todo:
need some flag somewhere to auto flip vertically (for +y is up rather than down)

References LaxInterfaces::ObjectContext::duplicate(), LaxInterfaces::ViewportWindow::NewData(), LaxInterfaces::SomeDataFactory::newObject(), LaxInterfaces::CaptionData::SetText(), LaxInterfaces::somedatafactory, and LaxInterfaces::anInterface::viewport.

Referenced by LBDown().

int LaxInterfaces::CaptionInterface::Refresh ( )
virtual

Member Data Documentation

int LaxInterfaces::CaptionInterface::mode
protected

If mode==0, then edit existing text normally. If mode==1, then we are working on a brand new object. If the interface is called off without actually writing any text, then do not install the object.

Referenced by InterfaceOn(), LBDown(), and LBUp().


The documentation for this class was generated from the following files:

Mon Feb 17 2014 11:52:58, Laxkit