1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.FileType.MessageParameters:
==========================================================================================================================================
|phoenix_title| **wx.FileType.MessageParameters**
==========================================================================================================================================
Class representing message parameters.
An object of this class may be passed to :meth:`wx.FileType.GetOpenCommand` and :meth:`~wx.FileType.MessageParameters.GetPrintCommand` if more than the file name needs to be specified.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>MessageParameters</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.FileType.MessageParameters_inheritance.png" alt="Inheritance diagram of MessageParameters" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.FileType.MessageParameters.html" title="wx.FileType.MessageParameters" alt="" coords="5,5,229,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileType.MessageParameters.__init__` Trivial default constructor.
:meth:`~wx.FileType.MessageParameters.GetFileName` Return the filename.
:meth:`~wx.FileType.MessageParameters.GetMimeType` Return the MIME type.
:meth:`~wx.FileType.MessageParameters.GetParamValue` Overridable method for derived classes. Returns empty string by default.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileType.MessageParameters.FileName` See :meth:`~wx.FileType.MessageParameters.GetFileName`
:attr:`~wx.FileType.MessageParameters.MimeType` See :meth:`~wx.FileType.MessageParameters.GetMimeType`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileType.MessageParameters(object)
**Possible constructors**::
MessageParameters()
MessageParameters(filename, mimetype=EmptyString)
Class representing message parameters.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Trivial default constructor.
**~~~**
**__init__** `(self, filename, mimetype=EmptyString)`
Constructor taking a filename and a mime type.
:param `filename`:
:type `filename`: string
:param `mimetype`:
:type `mimetype`: string
**~~~**
.. method:: GetFileName(self)
Return the filename.
:rtype: `string`
.. method:: GetMimeType(self)
Return the MIME type.
:rtype: `string`
.. method:: GetParamValue(self, name)
Overridable method for derived classes. Returns empty string by default.
:param `name`:
:type `name`: string
:rtype: `string`
.. attribute:: FileName
See :meth:`~wx.FileType.MessageParameters.GetFileName`
.. attribute:: MimeType
See :meth:`~wx.FileType.MessageParameters.GetMimeType`
|