+
+enum wxMailcapStyle
+{
+ wxMAILCAP_STANDARD = 1,
+ wxMAILCAP_NETSCAPE = 2,
+ wxMAILCAP_KDE = 4,
+ wxMAILCAP_GNOME = 8,
+
+ wxMAILCAP_ALL = 15
+};
+
+
+
+class wxFileTypeInfo
+{
+public:
+ // ctors
+ // a normal item
+ wxFileTypeInfo(const wxString& mimeType,
+ const wxString& openCmd,
+ const wxString& printCmd,
+ const wxString& desc);
+
+
+ // the array elements correspond to the parameters of the ctor above in
+ // the same order
+ %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
+
+ // invalid item - use this to terminate the array passed to
+ // wxMimeTypesManager::AddFallbacks
+ %name(wxNullFileTypeInfo)wxFileTypeInfo();
+
+
+ // test if this object can be used
+ bool IsValid() const;
+
+ // setters
+ // set the icon info
+ void SetIcon(const wxString& iconFile, int iconIndex = 0);
+
+ // set the short desc
+ void SetShortDesc(const wxString& shortDesc);
+
+ // accessors
+ // get the MIME type
+ const wxString& GetMimeType() const;
+ // get the open command
+ const wxString& GetOpenCommand() const;
+ // get the print command
+ const wxString& GetPrintCommand() const;
+ // get the short description (only used under Win32 so far)
+ const wxString& GetShortDesc() const;
+ // get the long, user visible description
+ const wxString& GetDescription() const;
+
+
+ // get the array of all extensions
+ //const wxArrayString& GetExtensions() const;
+ %addmethods {
+ PyObject* GetExtensions() {
+ wxArrayString& arr = (wxArrayString&)self->GetExtensions();
+ return wxArrayString2PyList_helper(arr);
+ }
+ }
+
+ int GetExtensionsCount() const;
+
+ // get the icon info
+ const wxString& GetIconFile() const;
+ int GetIconIndex() const;
+};
+
+
+
+
+class wxFileType
+{
+public:
+
+ // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
+
+ // An object of this class must be passed to Get{Open|Print}Command. The
+ // default implementation is trivial and doesn't know anything at all about
+ // parameters, only filename and MIME type are used (so it's probably ok for
+ // Windows where %{param} is not used anyhow)
+ class MessageParameters
+ {
+ public:
+ // ctors
+ MessageParameters(const wxString& filename=wxPyEmptyString,
+ const wxString& mimetype=wxPyEmptyString);
+
+ // accessors (called by GetOpenCommand)
+ // filename
+ const wxString& GetFileName() const;
+ // mime type
+ const wxString& GetMimeType() const;;
+
+ // override this function in derived class
+ virtual wxString GetParamValue(const wxString& name) const;
+
+ // virtual dtor as in any base class
+ virtual ~MessageParameters();
+ };
+
+
+ // ctor from static data
+ wxFileType(const wxFileTypeInfo& ftInfo);
+
+ // return the MIME type for this file type
+ %addmethods {
+ PyObject* GetMimeType() {
+ wxString str;
+ if (self->GetMimeType(&str)) {
+#if wxUSE_UNICODE
+ return PyUnicode_FromWideChar(str.c_str(), str.Len());
+#else
+ return PyString_FromStringAndSize(str.c_str(), str.Len());
+#endif
+ }
+ else
+ RETURN_NONE();
+ }
+ PyObject* GetMimeTypes() {
+ wxArrayString arr;
+ if (self->GetMimeTypes(arr))
+ return wxArrayString2PyList_helper(arr);
+ else
+ RETURN_NONE();
+ }
+ }
+
+
+ // Get all extensions associated with this file type
+ %addmethods {
+ PyObject* GetExtensions() {
+ wxArrayString arr;
+ if (self->GetExtensions(arr))
+ return wxArrayString2PyList_helper(arr);
+ else
+ RETURN_NONE();
+ }
+ }
+
+
+ %addmethods {
+ // Get the icon corresponding to this file type
+ %new wxIcon* GetIcon() {
+ wxIcon icon;
+ if (self->GetIcon(&icon))
+ return new wxIcon(icon);
+ else
+ return NULL;
+ }
+
+ // Get the icon corresponding to this file type, the name of the file
+ // where this icon resides, and its index in this file if applicable.
+ PyObject* GetIconInfo() {
+ wxIcon icon;
+ wxString iconFile;
+ int iconIndex;
+ if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
+ wxPyBeginBlockThreads();
+ PyObject* tuple = PyTuple_New(3);
+ PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
+ wxT("wxIcon"), TRUE));
+#if wxUSE_UNICODE
+ PyTuple_SetItem(tuple, 1, PyUnicode_FromWideChar(iconFile.c_str(), iconFile.Len()));
+#else
+ PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
+#endif
+ PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
+ wxPyEndBlockThreads();
+ return tuple;
+ }
+ else
+ RETURN_NONE();
+ }
+ }
+
+ %addmethods {
+ // get a brief file type description ("*.txt" => "text document")
+ PyObject* GetDescription() {
+ wxString str;
+ if (self->GetDescription(&str)) {
+#if wxUSE_UNICODE
+ return PyUnicode_FromWideChar(str.c_str(), str.Len());
+#else
+ return PyString_FromStringAndSize(str.c_str(), str.Len());
+#endif
+ } else
+ RETURN_NONE();
+ }
+ }
+
+
+ // get the command to open/execute the file of given type
+ %addmethods {
+ PyObject* GetOpenCommand(const wxString& filename,
+ const wxString& mimetype=wxPyEmptyString) {
+ wxString str;
+ if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
+#if wxUSE_UNICODE
+ return PyUnicode_FromWideChar(str.c_str(), str.Len());
+#else
+ return PyString_FromStringAndSize(str.c_str(), str.Len());
+#endif
+ } else
+ RETURN_NONE();
+ }
+ }
+
+
+ // get the command to print the file of given type
+ %addmethods {
+ PyObject* GetPrintCommand(const wxString& filename,
+ const wxString& mimetype=wxPyEmptyString) {
+ wxString str;
+ if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
+#if wxUSE_UNICODE
+ return PyUnicode_FromWideChar(str.c_str(), str.Len());
+#else
+ return PyString_FromStringAndSize(str.c_str(), str.Len());
+#endif
+ } else
+ RETURN_NONE();
+ }
+ }
+
+
+ // Get all commands defined for this file type
+ %addmethods {
+ PyObject* GetAllCommands(const wxString& filename,
+ const wxString& mimetype=wxPyEmptyString) {
+ wxArrayString verbs;
+ wxArrayString commands;
+ if (self->GetAllCommands(&verbs, &commands,
+ wxFileType::MessageParameters(filename, mimetype))) {
+ wxPyBeginBlockThreads();
+ PyObject* tuple = PyTuple_New(2);
+ PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
+ PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
+ wxPyEndBlockThreads();
+ return tuple;
+ }
+ else
+ RETURN_NONE();
+ }
+ }
+
+
+ // set an arbitrary command, ask confirmation if it already exists and
+ // overwriteprompt is TRUE
+ bool SetCommand(const wxString& cmd, const wxString& verb,
+ bool overwriteprompt = TRUE);
+
+ bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
+
+
+ // remove the association for this filetype from the system MIME database:
+ // notice that it will only work if the association is defined in the user
+ // file/registry part, we will never modify the system-wide settings
+ bool Unassociate();
+
+ // operations
+ // expand a string in the format of GetOpenCommand (which may contain
+ // '%s' and '%t' format specificators for the file name and mime type
+ // and %{param} constructions).
+ static wxString ExpandCommand(const wxString& command,
+ const MessageParameters& params);
+
+ // dtor (not virtual, shouldn't be derived from)
+ ~wxFileType();
+
+};
+
+
+
+
+class wxMimeTypesManager
+{
+public:
+ // static helper functions
+ // -----------------------
+
+ // check if the given MIME type is the same as the other one: the
+ // second argument may contain wildcards ('*'), but not the first. If
+ // the types are equal or if the mimeType matches wildcard the function
+ // returns TRUE, otherwise it returns FALSE
+ static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
+
+ // ctor
+ wxMimeTypesManager();
+
+ // loads data from standard files according to the mailcap styles
+ // specified: this is a bitwise OR of wxMailcapStyle values
+ //
+ // use the extraDir parameter if you want to look for files in another
+ // directory
+ void Initialize(int mailcapStyle = wxMAILCAP_ALL,
+ const wxString& extraDir = wxPyEmptyString);
+
+ // and this function clears all the data from the manager
+ void ClearData();
+
+ // Database lookup: all functions return a pointer to wxFileType object
+ // whose methods may be used to query it for the information you're
+ // interested in. If the return value is !NULL, caller is responsible for
+ // deleting it.
+ // get file type from file extension
+ %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
+
+ // get file type from MIME type (in format <category>/<format>)
+ %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
+
+ // other operations: return TRUE if there were no errors or FALSE if there
+ // were some unreckognized entries (the good entries are always read anyhow)
+ //
+
+ // read in additional file (the standard ones are read automatically)
+ // in mailcap format (see mimetype.cpp for description)
+ //
+ // 'fallback' parameter may be set to TRUE to avoid overriding the
+ // settings from other, previously parsed, files by this one: normally,
+ // the files read most recently would override the older files, but with
+ // fallback == TRUE this won't happen
+ bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
+
+ // read in additional file in mime.types format
+ bool ReadMimeTypes(const wxString& filename);
+
+ // enumerate all known MIME types
+ %addmethods {
+ PyObject* EnumAllFileTypes() {
+ wxArrayString arr;
+ self->EnumAllFileTypes(arr);
+ return wxArrayString2PyList_helper(arr);
+ }
+ }
+
+ // these functions can be used to provide default values for some of the
+ // MIME types inside the program itself (you may also use
+ // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
+ // achieve the same goal, but this requires having this info in a file).
+ //
+ void AddFallback(const wxFileTypeInfo& ft);
+
+
+ // create or remove associations
+
+ // create a new association using the fields of wxFileTypeInfo (at least
+ // the MIME type and the extension should be set)
+ // if the other fields are empty, the existing values should be left alone
+ %new wxFileType *Associate(const wxFileTypeInfo& ftInfo);
+
+ // undo Associate()
+ bool Unassociate(wxFileType *ft) ;
+
+ // dtor (not virtual, shouldn't be derived from)
+ ~wxMimeTypesManager();
+};
+
+
+%readonly
+%{
+#if 0
+%}
+extern wxMimeTypesManager* wxTheMimeTypesManager;
+%{
+#endif
+%}
+%readwrite
+
+//----------------------------------------------------------------------
+
+%{
+#include <wx/artprov.h>
+
+ DECLARE_DEF_STRING(ART_OTHER);
+
+%}
+
+%pragma(python) code = "
+# Art clients
+wxART_TOOLBAR = 'wxART_TOOLBAR_C'
+wxART_MENU = 'wxART_MENU_C'
+wxART_FRAME_ICON = 'wxART_FRAME_ICON_C'
+wxART_CMN_DIALOG = 'wxART_CMN_DIALOG_C'
+wxART_HELP_BROWSER = 'wxART_HELP_BROWSER_C'
+wxART_MESSAGE_BOX = 'wxART_MESSAGE_BOX_C'
+wxART_OTHER = 'wxART_OTHER_C'
+
+# Art IDs
+wxART_ADD_BOOKMARK = 'wxART_ADD_BOOKMARK'
+wxART_DEL_BOOKMARK = 'wxART_DEL_BOOKMARK'
+wxART_HELP_SIDE_PANEL = 'wxART_HELP_SIDE_PANEL'
+wxART_HELP_SETTINGS = 'wxART_HELP_SETTINGS'
+wxART_HELP_BOOK = 'wxART_HELP_BOOK'
+wxART_HELP_FOLDER = 'wxART_HELP_FOLDER'
+wxART_HELP_PAGE = 'wxART_HELP_PAGE'
+wxART_GO_BACK = 'wxART_GO_BACK'
+wxART_GO_FORWARD = 'wxART_GO_FORWARD'
+wxART_GO_UP = 'wxART_GO_UP'
+wxART_GO_DOWN = 'wxART_GO_DOWN'
+wxART_GO_TO_PARENT = 'wxART_GO_TO_PARENT'
+wxART_GO_HOME = 'wxART_GO_HOME'
+wxART_FILE_OPEN = 'wxART_FILE_OPEN'
+wxART_PRINT = 'wxART_PRINT'
+wxART_HELP = 'wxART_HELP'
+wxART_TIP = 'wxART_TIP'
+wxART_REPORT_VIEW = 'wxART_REPORT_VIEW'
+wxART_LIST_VIEW = 'wxART_LIST_VIEW'
+wxART_NEW_DIR = 'wxART_NEW_DIR'
+wxART_FOLDER = 'wxART_FOLDER'
+wxART_GO_DIR_UP = 'wxART_GO_DIR_UP'
+wxART_EXECUTABLE_FILE = 'wxART_EXECUTABLE_FILE'
+wxART_NORMAL_FILE = 'wxART_NORMAL_FILE'
+wxART_TICK_MARK = 'wxART_TICK_MARK'
+wxART_CROSS_MARK = 'wxART_CROSS_MARK'
+wxART_ERROR = 'wxART_ERROR'
+wxART_QUESTION = 'wxART_QUESTION'
+wxART_WARNING = 'wxART_WARNING'
+wxART_INFORMATION = 'wxART_INFORMATION'
+wxART_MISSING_IMAGE = 'wxART_MISSING_IMAGE'
+"
+
+%{ // Python aware wxArtProvider
+class wxPyArtProvider : public wxArtProvider {
+public:
+
+ virtual wxBitmap CreateBitmap(const wxArtID& id,
+ const wxArtClient& client,
+ const wxSize& size) {
+ wxBitmap rval = wxNullBitmap;
+ wxPyBeginBlockThreads();
+ if ((wxPyCBH_findCallback(m_myInst, "CreateBitmap"))) {
+ PyObject* so = wxPyConstructObject((void*)&size, wxT("wxSize"), 0);
+ PyObject* ro;
+ wxBitmap* ptr;
+ PyObject* s1, *s2;
+ s1 = wx2PyString(id);
+ s2 = wx2PyString(client);
+ ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOO)", s1, s2, so));
+ Py_DECREF(so);
+ Py_DECREF(s1);
+ Py_DECREF(s2);
+ if (ro) {
+ if (!SWIG_GetPtrObj(ro, (void**)&ptr, "_wxBitmap_p"))
+ rval = *ptr;
+ Py_DECREF(ro);
+ }
+ }
+ wxPyEndBlockThreads();
+ return rval;
+ }
+
+ PYPRIVATE;
+};
+%}
+
+// The one for SWIG to see
+%name(wxArtProvider) class wxPyArtProvider : public wxObject
+{
+public:
+ wxPyArtProvider();
+
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
+ %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxArtProvider)"
+
+ // Add new provider to the top of providers stack.
+ static void PushProvider(wxPyArtProvider *provider);
+
+ // Remove latest added provider and delete it.
+ static bool PopProvider();
+
+ // Remove provider. The provider must have been added previously!
+ // The provider is _not_ deleted.
+ static bool RemoveProvider(wxPyArtProvider *provider);
+
+ // Query the providers for bitmap with given ID and return it. Return
+ // wxNullBitmap if no provider provides it.
+ static wxBitmap GetBitmap(const wxString& id,
+ const wxString& client = wxPyART_OTHER,
+ const wxSize& size = wxDefaultSize);
+
+ // Query the providers for icon with given ID and return it. Return
+ // wxNullIcon if no provider provides it.
+ static wxIcon GetIcon(const wxString& id,
+ const wxString& client = wxPyART_OTHER,
+ const wxSize& size = wxDefaultSize);
+
+};
+
+
+//----------------------------------------------------------------------
+
+%{
+#include <wx/docview.h>
+%}
+
+class wxFileHistory : public wxObject
+{
+public:
+ wxFileHistory(int maxFiles = 9);
+ ~wxFileHistory();
+
+ // Operations
+ void AddFileToHistory(const wxString& file);
+ void RemoveFileFromHistory(int i);
+ int GetMaxFiles() const;
+ void UseMenu(wxMenu *menu);
+
+ // Remove menu from the list (MDI child may be closing)
+ void RemoveMenu(wxMenu *menu);
+
+ void Load(wxConfigBase& config);
+ void Save(wxConfigBase& config);
+
+ void AddFilesToMenu();
+ %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
+
+ // Accessors
+ wxString GetHistoryFile(int i) const;
+
+ // A synonym for GetNoHistoryFiles
+ int GetCount() const;
+ int GetNoHistoryFiles() const;
+
+};
+
+//----------------------------------------------------------------------
+
+class wxEffects: public wxObject
+{
+public:
+ // Assume system colours
+ wxEffects();
+
+ wxColour GetHighlightColour() const;
+ wxColour GetLightShadow() const;
+ wxColour GetFaceColour() const;
+ wxColour GetMediumShadow() const;
+ wxColour GetDarkShadow() const;
+
+ void SetHighlightColour(const wxColour& c);
+ void SetLightShadow(const wxColour& c);
+ void SetFaceColour(const wxColour& c);
+ void SetMediumShadow(const wxColour& c);
+ void SetDarkShadow(const wxColour& c);
+
+ void Set(const wxColour& highlightColour, const wxColour& lightShadow,
+ const wxColour& faceColour, const wxColour& mediumShadow,
+ const wxColour& darkShadow);
+
+ // Draw a sunken edge
+ void DrawSunkenEdge(wxDC& dc, const wxRect& rect, int borderSize = 1);
+
+ // Tile a bitmap
+ bool TileBitmap(const wxRect& rect, wxDC& dc, wxBitmap& bitmap);
+
+};
+
+//----------------------------------------------------------------------
+
+class wxSingleInstanceChecker
+{
+public:
+ // like Create() but no error checking (dangerous!)
+ wxSingleInstanceChecker(const wxString& name,
+ const wxString& path = wxPyEmptyString);
+
+ // default ctor, use Create() after it
+ %name(wxPreSingleInstanceChecker) wxSingleInstanceChecker();
+
+ ~wxSingleInstanceChecker();
+
+
+ // name must be given and be as unique as possible, it is used as the mutex
+ // name under Win32 and the lock file name under Unix -
+ // wxTheApp->GetAppName() may be a good value for this parameter
+ //
+ // path is optional and is ignored under Win32 and used as the directory to
+ // create the lock file in under Unix (default is wxGetHomeDir())
+ //
+ // returns FALSE if initialization failed, it doesn't mean that another
+ // instance is running - use IsAnotherRunning() to check it
+ bool Create(const wxString& name, const wxString& path = wxPyEmptyString);
+
+ // is another copy of this program already running?
+ bool IsAnotherRunning() const;
+};
+
projects / wxWidgets.git / blobdiff