ui.h

Go to the documentation of this file.

/*
 * XetPan: a libEtPan! based Mail User Agent
 * Copyright (C) 2002 Melvin Hadasht
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef UI_H
#define UI_H

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <clist.h>

#include "ui-types.h"
#include "xetpan.h"

#ifdef USE_GTKUI
#include "gtk-ui.h"
#include "gtk-messageview.h" /* XePGTKMessageView */
#include "gtk-composewindow.h" /* XePGTKComposeWindow */
#endif
#ifdef USE_TTYUI
#include "tty-ui.h"
#endif

#include "message-types.h"
#include "mta.h"

/* Message View */

typedef struct XePUIMessageViewAny_s XePUIMessageViewAny;

struct XePUIMessageViewAny_s
{
  XePUIType type;      
  XePUID uid;          
  int editable;        
  XetPan *xetpan;      
  XePUIMain *uimain;   
  XePFolder *folder;   
  XePMessage *message; 
  uint32_t muid;       
  clist *inlined_list; 
  char *body_text;  
  char *default_charset; 
};

union XePUIMessageView_u
{
  XePUIMessageViewAny any;
#ifdef USE_GTKUI
  XePGTKMessageView gtk_mview;
#endif
#ifdef USE_TTYUI
  XePTTYMessageView tty_mview;
#endif
};

/* Compose Window */

typedef struct XePUIComposeWindowAny_s XePUIComposeWindowAny;

struct XePUIComposeWindowAny_s
{
  XePUIType type;      
  XetPan *xetpan;      
  XePUIMain *uimain;   
  XePMTA *mta;         
  XePUIMessageView *messageview; 
  char *sent_folder;   
  /* The rest of the union is private to the UI */
};

union XePUIComposeWindow_u
{
  XePUIComposeWindowAny any;
#ifdef USE_GTKUI
  XePGTKComposeWindow gtk;
#endif
#ifdef USE_TTYUI
  XePTTYComposeWindow tty;
#endif
};

extern const char *A_UI_ABOUT_AUTHORS;
extern const char *A_UI_ABOUT_LICENSE;
extern const char *A_UI_ABOUT_HOME_PAGE;
extern const char *A_UI_ABOUT_COPYRIGHT;

XePUI *
a_UI_new(void);

void
a_UI_free(XePUI *ui);

int
a_UI_id_editor_is_locked(void);

int
a_UI_id_editor_lock(void);

void
a_UI_id_editor_unlock(void);

int
a_UI_init(XetPan *xetpan, int *argc, char ***argv);

void
a_UI_main(XetPan *xetpan);

void
a_UI_main_quit(XetPan *xetpan);

int
a_UI_main_switch(XetPan *xetpan, const char *terminal, int uitype);

int
a_UI_events_pending(XetPan *xetpan);

void
a_UI_main_iteration(XetPan *xetpan);

void
a_UI_wait_until(XetPan *xetpan, int *semaphore, int value);

void
a_UI_first_launch(XetPan *xetpan);

void
a_UI_compose_pending_requests(XetPan *xetpan);

XePUIMain *
a_UI_mainview_new(void);

XePUIComposeWindow *
a_UI_composewindow_new(void);

XePUIMessageView *
a_UI_messageview_new(void);

XePUIMain *
a_UI_mainview_create(XetPan *xetpan, char *terminal, int type);

int
a_UI_close_all(XetPan *xetpan, int uitype);

int
a_UI_mainview_close(XePUIMain *uimain);

int
a_UI_mainview_close_all(XetPan *xetpan, int uitype);

void
a_UI_foldersview_list_updated(void);

void
a_UI_foldersview_list_refresh(void);

void
a_UI_expunge_folder(const char *ref);

void
a_UI_update_folder(const char *ref);

void
a_UI_folder_updated(void *anull, void *afolder);

void
a_UI_refresh_folder(const char *ref);

void
a_UI_message_updated(XePMessage* message);

XePUIComposeWindow *
a_UI_composewindow_create(XetPan *xetpan, char *terminal, int type);

XePUIComposeWindow *
a_UI_composewindow_compose(XetPan *xetpan, char *terminal, int type, 
                           const char *mailto);


XePUIComposeWindow *
a_UI_composewindow_reply(XetPan *xetpan, 
                         char *terminal, 
                         int uitype,
                         XePMessage *message,
                         const char *reply_text,
                         const char *reply_charset);

XePUIComposeWindow *
a_UI_composewindow_forward(XetPan *xetpan, 
                           char *terminal, 
                           int uitype,
                           XePMessage *message);

XePUIComposeWindow *
a_UI_composewindow_redirect(XetPan *xetpan, 
                            char *terminal, 
                            int uitype,
                            XePMessage *message);
void
a_UI_composewindow_set_message(XePUIComposeWindow *uicompose,
                               XePMessage *message);

void
a_UI_composewindow_set_mailto(XePUIComposeWindow *uicompose, 
                              const char *mailto);

void
a_UI_composewindow_set_body_text(XePUIComposeWindow *uicompose, 
                                 const char *text, 
                                 size_t text_size,
                                 const char *text_charset);

void
a_UI_composewindow_add_header(XePUIComposeWindow *uicompose, 
                              XePMessageHeaderType header_type,
                              const char *header_name,
                              const char *header_value);

int
a_UI_composewindow_close(XePUIComposeWindow *uicompose);

int
a_UI_composewindow_close_all(XetPan *xetpan, int uitype);


XePUIMessageView *
a_UI_messageview_create(XetPan *xetpan, 
                        char *terminal, 
                        int  uitype);

int
a_UI_messageview_close(XePUIMessageView *viewer);

int
a_UI_messageview_close_all(XetPan *xetpan, int uitype);

void
a_UI_messageview_view_file(XePUIMessageView *mview, char *filename);


void
a_UI_notify_error(XetPan *xetpan);

void
a_UI_notify_error_reset(XetPan *xetpan);

void
a_UI_folder_messages_change_flags(XePFolder *folder, carray *messages);

void
a_UI_messageview_show_message(XePUIMessageView *mview,
                              XePMessage *message);

void
a_UI_messageview_fetch_show_async(XePUIMessageView *mview,
                                  XePMessage *message);

void
a_UI_messageview_finalize(XePUIMessageView *mview, XePMessage *message);

void
a_UI_messageview_flags_change_async(XePUIMessageView *mview,
                                    XePMessage *message);


void
a_UI_messageview_mime_view_show(XetPan *xetpan, 
                                XePMessage *message);


void
a_UI_messageview_mime_view_block(XetPan *xetpan,
                                 XePMessage *message);


void
a_UI_messageview_mime_view_unblock(XetPan *xetpan, 
                                   XePMessage *message);


void
a_UI_messageview_mime_fetch_show_selected_async(XePUIMessageView *mview,
                                                XePMessage *message);


void
a_UI_messageview_mime_show_selected(XePUIMessageView *mview,
                                    XePMessage *message);


void
a_UI_send_cmd_result(XetPan *xetpan);


unsigned int
a_UI_add_io_watch(XetPan *xetpan,
                  int fd,
                  short int condition,
                  void (*callback)(int afd, short int acondition, void *adata),
                  void *data);

int
a_UI_remove_io_watch(XetPan *xetpan, unsigned int watch_id);

#endif

---