Laxkit  0.0.7.1
Public Member Functions | Protected Member Functions | Protected Attributes
Laxkit::ImageDialog Class Reference

Class to allow viewing and changing info related to an image. More...

Inheritance diagram for Laxkit::ImageDialog:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ImageDialog (anXWindow *parnt, const char *nname, const char *ntitle, unsigned long nstyle, int xx, int yy, int ww, int hh, int brder, anXWindow *prev, unsigned long nowner, const char *nsend, unsigned long ndstyle, ImageInfo *inf)
 Constructor.
virtual ~ImageDialog ()
virtual const charwhattype ()
virtual int preinit ()
 Set win_w and win_h to sane values if necessary.
virtual int init ()
virtual int send ()
 Send an event to owner.
virtual int Event (const EventData *data, const char *mes)
 Respond to the various controls.
virtual int CharInput (unsigned int ch, const char *buffer, int len, unsigned int state, const LaxKeyboard *d)
 Cancel if ESC.
virtual void closeWindow ()
- Public Member Functions inherited from Laxkit::RowFrame
 RowFrame (anXWindow *parnt, const char *nname, const char *ntitle, unsigned long nstyle, int xx, int yy, int ww, int hh, int brder, anXWindow *prev, unsigned long owner, const char *mes, int npad=0)
 RowFrame constructor.
virtual int Sync (int add=0)
 Sync the boxes to win_w/win_h, which are assumed set already.
virtual int MoveResize (int nx, int ny, int nw, int nh)
 Calls anXWindow::MoveResize, then Sync(0).
virtual int Resize (int nw, int nh)
 Calls anXWindow::Resize, then Sync(0).
virtual int findWindowIndex (const char *name)
 Return the index in RowColBox::wholelist containing a window with name as the title.
virtual anXWindowfindWindow (const char *name)
 Return the window in RowColBox::wholelist that has name as its win_name or win_title.
virtual int AddNull (int where=-1)
 Call this to insert a line break into the window stack.
virtual int AddHSpacer (int npw, int nws, int nwg, int nhalign, int where=-1)
virtual int AddVSpacer (int npw, int nws, int nwg, int nhalign, int where=-1)
virtual int AddSpacer (int npw, int nws, int nwg, int nhalign, int nph, int nhs, int nhg, int nvalign, int where=-1)
virtual int AddWin (WinFrameBox *box, char islocal=1, int where=-1)
 Add an already made WinFrameBox.
virtual int AddWin (anXWindow *win, int absorbcount, int where)
 Add a window using the window's width and height with no squishability.
virtual int AddWin (anXWindow *win, int absorbcount, int npw, int nws, int nwg, int nhalign, int nhgap, int nph, int nhs, int nhg, int nvalign, int nvgap, int where)
 Add a window with squish values.
virtual void Refresh ()
 Call Sync(0) if arrangedstate!=1.
- Public Member Functions inherited from Laxkit::anXWindow
 anXWindow (anXWindow *parnt, const char *nname, const char *ntitle, unsigned long nstyle, int xx, int yy, int ww, int hh, int brder, anXWindow *prev, unsigned long nowner, const char *nsend)
 Constructor.
virtual ~anXWindow ()
 anXWindow destructor. Its X window should have been XDestroy'd before here.
virtual const charWindowTitle (int which=0)
 Return basically the name of the window.
virtual void WindowTitle (const char *newtitle)
 Change the title of the window. This text would usually be displayed in the bar provided by a window manager.
virtual const chartooltip (int mouseid=0)
 By default, return win_tooltip.
virtual const chartooltip (const char *newtooltip)
 Replace the current tooltip, return the current tooltip (after replacing).
virtual anXWindowfindChildWindowByTitle (const char *title)
 Find the first immediate child window that has win_title==title.
virtual anXWindowfindChildWindowByName (const char *name)
 Find the first immediate child window that has win_name==name.
virtual int Grayed ()
 Return whether this window is grayed.
virtual int Grayed (int g)
 Set the gray state of this window. Returns Grayed(void).
virtual int close ()
 Called by anXApp from anXApp::destroywindow() when a window is to be destroyed.
virtual int Idle (int tid=0)
 anXWindow::Idle() is an empty placeholeder. Just returns 1.
virtual DisplayerMakeCurrent ()
virtual int Needtodraw ()
 Default is to return needtodraw.
virtual void Needtodraw (int nntd)
 If 0, then the window does not need refreshing. Otherwise it does.
virtual int deletenow ()
 Return whether the window is allowed to be deleted.
virtual int setWinStyle (unsigned int stylebit, int newvalue)
 Control various window related basic styling of win_style.
virtual int getWinStyle (unsigned int stylebit)
 Currently, simply return win_style&stylebit.
virtual void installColors (WindowColors *newcolors)
 Dec_count old and inc_count new.
virtual ShortcutHandlerGetShortcuts ()
 Return a ShortcutHandler that contains stacks of bound shortcuts and possible window actions.
virtual int PerformAction (int action_number)
virtual int ExposeChange (ScreenEventData *e)
 Default behavior on Expose events is to call Needtodraw(1).
virtual int DeviceChange (const DeviceEventData *e)
virtual int KeyUp (unsigned int ch, unsigned int state, const LaxKeyboard *kb)
 Called when a key is released.
virtual int MouseMove (int x, int y, unsigned int state, const LaxMouse *m)
 Empty placeholder, just returns 1.
virtual int ButtonDown (int button, int x, int y, unsigned int state, int count, const LaxMouse *m)
virtual int ButtonUp (int button, int x, int y, unsigned int state, const LaxMouse *m)
virtual int LBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
 Default is just to return 1.
virtual int LBUp (int x, int y, unsigned int state, const LaxMouse *d)
 Default is just to return 1.
virtual int MBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
 Default is just to return 1.
virtual int MBUp (int x, int y, unsigned int state, const LaxMouse *d)
 Default is just to return 1.
virtual int RBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
 Default is just to return 1.
virtual int RBUp (int x, int y, unsigned int state, const LaxMouse *d)
 Default is just to return 1.
virtual int WheelUp (int x, int y, unsigned int state, int count, const LaxMouse *d)
 The wheel mouse rolling up. Default is just to return 1.
virtual int WheelDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
 The wheel mouse rolling down. Default is just to return 1.
virtual int FocusOn (const FocusChangeData *e)
 Increment win_active, and highlights the window's border, if the event refers to this window.
virtual int FocusOff (const FocusChangeData *e)
 Decrements win_active, and de-highlights the window's border if win_active==0, if event is a real focus off.
virtual void contentChanged ()
 Windows may call this when their contents change.
virtual void selectionChanged ()
 Windows may call this when their selections change.
virtual anXWindowGetController ()
 Return the window most relevant for tab control loops.
virtual int SelectNextControl (const LaxDevice *d)
 Transfer focus to nextcontrol.
virtual int SelectPrevControl (const LaxDevice *d)
 Transfer the focus to prevcontrol.
virtual void ControlActivation (int on)
 Do special activation or not when controls are activated by tabbing.
virtual int AddPrevControl (anXWindow *prev)
virtual int AddNextControl (anXWindow *next)
virtual int ConnectControl (anXWindow *towhat, int after=1)
 Connect towhat to this. Used for tab loops.
virtual int CloseControlLoop ()
 Close a tab loop.
virtual void SetOwner (anXWindow *nowner, const char *mes=NULL, unsigned int send_mask=0)
 Set the new owner and control message.
virtual void SetOwner (unsigned long nowner_id, const char *mes=NULL, unsigned int send_mask=0)
virtual void dump_out (FILE *f, int indent, int what, anObject *context)
 Simple dumping function.
virtual LaxFiles::Attributedump_out_atts (LaxFiles::Attribute *att, int what, anObject *context)
virtual void dump_in_atts (LaxFiles::Attribute *att, int flag, anObject *context)
- Public Member Functions inherited from Laxkit::Tagged
virtual int HasTag (const char *tag, int casematters)
 Return whether the tag exists.
virtual int NumberOfTags ()
 Return the number of tags, strangely enough.
virtual const charGetTag (int i)
 Return const pointer to the tag text for tag number i, where i==0 is the first tag.
virtual charGetAllTags ()
 Return a new char[] with a space separated list of all the tags.
virtual int InsertTags (const char *tags, int casematters)
 Insert tags from a string such as 'tag1 tag2 tag3 "tag with spaces" tag4'.
virtual int InsertTag (const char *tag, int casematters)
 Insert tag if it doesn't exist already.
virtual int RemoveTag (const char *tag)
 The tag must be an exact match.
virtual int RemoveTag (int i)
 Remove tag number i. i must be in range [0..NumberOfTags()-1].
virtual void FlushTags ()
- Public Member Functions inherited from LaxFiles::DumpUtility
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 Member Functions inherited from Laxkit::aDrawable
 aDrawable (Drawable d=0)
virtual int DrawableType ()
virtual int ValidDrawable ()
- Public Member Functions inherited from Laxkit::RowColBox
 RowColBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
 Main RowColBox constructor.
virtual void Push (SquishyBox *box, char islocal=0, int where=-1)
 Push box onto wholelist with islocal.
virtual int Pop (int which=-1)
 Remove box with index which from wholelist.
virtual void Flush ()
 Flush list, and if list does not exist, then create a new list.
virtual int arrangeBoxes (int distributetoo=0)
 Set up SquishyBox::list to contain rows and columns based on boxes in wholelist.
virtual int distributeBoxes (int setmetrics=0)
 Assign the x,y,w,h of the child boxes.
- Public Member Functions inherited from Laxkit::ListBox
 ListBox (unsigned int flag=0)
 Create box as either BOX_VERTICAL or BOX_HORIZONTAL. Other flag values are ignored.
 ListBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
virtual int WrapToExtent ()
 Sets this->pw,s,g/ph,s,g to be the sum of the metrics of the boxes in list.
virtual void sync ()
 Sync the box to the already set values of x,y,w,h.
virtual int figureDimensions (ListBox *target, int *nextrow=NULL, SquishyBox **boxes=NULL, int n=0, double *squishx=NULL, double *squishy=NULL)
 Finds pw,s,g/ph,s,g based on the boxes in list.
- Public Member Functions inherited from Laxkit::SquishyBox
 SquishyBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
 SquishyBox Constructor.
virtual int hideBox (int yeshide)
 hideBox(0) makes the box visible, otherwise, make it hidden. Returns state after call.
virtual int hidden ()
 Return whether the box is hidden or not.
virtual void sync (int xx, int yy, int ww, int hh)
 Sync the box to x,y,w,h.
virtual int x ()
virtual int w ()
virtual int pw ()
virtual int ws ()
virtual int wg ()
virtual int halign ()
virtual int hgap ()
virtual int y ()
virtual int h ()
virtual int ph ()
virtual int hs ()
virtual int hg ()
virtual int valign ()
virtual int vgap ()
virtual int x (int val)
virtual int w (int val)
virtual int pw (int val)
virtual int ws (int val)
virtual int wg (int val)
virtual int halign (int val)
virtual int hgap (int val)
virtual int y (int val)
virtual int h (int val)
virtual int ph (int val)
virtual int hs (int val)
virtual int hg (int val)
virtual int valign (int val)
virtual int vgap (int val)
virtual int fpenalty ()
virtual int fpenalty (int val)
virtual int lpenalty ()
virtual int lpenalty (int val)

Protected Member Functions

virtual FilePreviewernewFilePreviewer ()
 Return a new FilePreviewer instance.
virtual charreallyGeneratePreview ()
 Really make the preview, return an error string if something went wrong.
virtual int RegeneratePreview (int force)
 Regenerate the preview. Ask to overwrite if force!=0 and imageinfo->previewfile exists already.
virtual void updateImageInfo ()
 Sync imageinfo to the window controls' contents.

Protected Attributes

MultiLineEditdesc
LineInputfile
LineInputpreview
LineInputtitlee
LineInputside
FilePreviewerpreviewer
ImageInfoimageinfo
unsigned int dialog_style

Additional Inherited Members

- Public Attributes inherited from Laxkit::RowFrame
unsigned long highlight
unsigned long shadow
unsigned long mobkcolor
unsigned long bkcolor
- Public Attributes inherited from Laxkit::anXWindow
WindowColorswin_colors
anXAppapp
charwin_name
 An arbitrary string to be used as an id.
charwin_title
 The title of the window.
anXWindowwin_parent
int win_screen
unsigned long win_style
int win_x
int win_y
int win_w
int win_h
unsigned int win_border
int win_pointer_shape
 Identifier for a stock mouse shape.
char win_on
 Nonzero if the window is mapped.
char win_active
 Should be positive when the window has a keyboard focus, 0 otherwise.
unsigned long win_owner
 Who gets control messages from this window.
unsigned int win_owner_send_mask
charwin_sendthis
 The type of message that gets sent to owner.
anXWindownextcontrol
anXWindowprevcontrol
- Public Attributes inherited from Laxkit::Tagged
int sorttags
- Public Attributes inherited from Laxkit::RowColBox
unsigned int elementflags
- Public Attributes inherited from Laxkit::ListBox
PtrStack< SquishyBoxlist
- Public Attributes inherited from Laxkit::SquishyBox
int m [14]
int pad
 Pad placed around a box, which can be where a bevel or window border would go.
int padinset
 Pad to inset the child boxes.
int fpen
 The penalty in the flow direction.
int lpen
 The penalty perpendicular to the flow direction.
unsigned long flags

Detailed Description

Class to allow viewing and changing info related to an image.

This includes the actual file (which need not actually be an image file), a separate preview file for the main file, a description for the file, a title, and a button to generate or regenerate a smaller preview file.

#define IMGD_NO_FINAL_BUTTONS (1<<16)
#define IMGD_NO_TITLE (1<<17)
#define IMGD_NO_DESCRIPTION (1<<18)
#define IMGD_NO_DESTROY (1<<19) <-- no app->destroywindow() in closewindow()
#define IMGD_SEND_STRS (1<<20) <-- send StrsEventData, not RefCountedEventData
Todo:
implement tag editing, must switch ImageInfo to a Tagged subclass

Constructor & Destructor Documentation

Laxkit::ImageDialog::ImageDialog ( anXWindow parnt,
const char nname,
const char ntitle,
unsigned long  nstyle,
int  xx,
int  yy,
int  ww,
int  hh,
int  brder,
anXWindow prev,
unsigned long  nowner,
const char nsend,
unsigned long  ndstyle,
ImageInfo inf 
)

Constructor.

Todo:
*** need to work out styles, and passing to RowFrame..

Note that the previewer is not created, and the windows other than file, path and mask are not created until init(). All initial window layout is done in init().

The count of inf will be incremented if not NULL. If it is NULL, then imageinfo gets a new ImageInfo with a count of 1.

References Laxkit::anObject::inc_count().

Laxkit::ImageDialog::~ImageDialog ( )
virtual

Dec count of imageinfo.

References Laxkit::anObject::dec_count().


Member Function Documentation

void Laxkit::ImageDialog::closeWindow ( )
virtual

Empty placeholder for subclasses to do something special when the window is due to shut down.

References Laxkit::anXApp::destroywindow().

Referenced by CharInput(), and Event().

int Laxkit::ImageDialog::Event ( const EventData data,
const char mes 
)
virtual

Respond to the various controls.

Todo:
should probably make the imageinfo fields set to NULL if the corresponding edits return blank strings or strings with only whitespace.

Reimplemented from Laxkit::anXWindow.

References closeWindow(), Laxkit::LineInput::GetCText(), Laxkit::TextEditBaseUtf8::GetCText(), makestr(), Laxkit::FilePreviewer::Preview(), RegeneratePreview(), Laxkit::anXApp::rundialog(), send(), and Laxkit::LineInput::SetText().

int Laxkit::ImageDialog::init ( )
virtual
FilePreviewer * Laxkit::ImageDialog::newFilePreviewer ( )
protectedvirtual

Return a new FilePreviewer instance.

This is called in init(). Subclasses can redefine this to provide their own file previewer.

Referenced by init().

char * Laxkit::ImageDialog::reallyGeneratePreview ( )
protectedvirtual

Really make the preview, return an error string if something went wrong.

The returned string, if any, is a new char[] and must be delete[]'d.

Note that this will force an overwrite. For checking against that sort of thing, use RegeneratePreview().

Todo:
*** need check for fd thumb locations to enforce proper sizing

References Laxkit::generate_preview_image, Laxkit::LineInput::GetLineEdit(), Laxkit::LineEdit::GetLong(), newstr(), and Laxkit::FilePreviewer::Preview().

Referenced by RegeneratePreview().

int Laxkit::ImageDialog::RegeneratePreview ( int  force)
protectedvirtual

Regenerate the preview. Ask to overwrite if force!=0 and imageinfo->previewfile exists already.

This does checking to make sure it is ok to generate preview. Return 0 for preview regenerated, 1 for overwrite dialog initiated, and 2 for error in regeneration and pop up message box initiated.

If everything looks good, then call reallyGeneratePreview() to actually make the preview.

References appendstr(), LaxFiles::file_exists(), newstr(), Laxkit::FilePreviewer::Preview(), reallyGeneratePreview(), and Laxkit::anXApp::rundialog().

Referenced by Event().

int Laxkit::ImageDialog::send ( )
virtual

Send an event to owner.

If dialog_style&IMGD_SEND_STRS, sends a StrsEventData, with 4 strings: file, preview, title, and description. Even if any of those four are optioned out, there is still a placeholder. That is, file is still the first string, and description is always the fourth.

Otherwise, send a RefCountedEventData with imageinfo as the object.

Note that closeWindow() is not called from here. It is a separate action.

Returns 0 if nothing sent, else nonzero.

References Laxkit::anXApp::app, newstr(), Laxkit::anXApp::SendMessage(), updateImageInfo(), Laxkit::anXWindow::win_owner, and Laxkit::anXWindow::win_sendthis.

Referenced by Event().


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

Mon Feb 17 2014 11:52:59, Laxkit