~ubuntu-branches/ubuntu/karmic/libtinymail/karmic

<a href="libtinymail-tny-msg.html#TnyMsg">TnyMsg</a>* <a href="libtinymail-tny-msg-view.html#tny-msg-view-get-msg">tny_msg_view_get_msg</a> (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);

void <a href="libtinymail-tny-msg-view.html#tny-msg-view-set-msg">tny_msg_view_set_msg</a> (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self,

<a href="libtinymail-tny-msg.html#TnyMsg">TnyMsg</a> *msg);

void <a href="libtinymail-tny-msg-view.html#tny-msg-view-clear">tny_msg_view_clear</a> (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);

void <a href="libtinymail-tny-msg-view.html#tny-msg-view-set-unavailable">tny_msg_view_set_unavailable</a> (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);

<a href="libtinymail-tny-mime-part-view.html#TnyMimePartView">TnyMimePartView</a>* <a href="libtinymail-tny-msg-view.html#tny-msg-view-create-mime-part-view-for">tny_msg_view_create_mime_part_view_for</a>

(<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self,

<a href="libtinymail-tny-mime-part.html#TnyMimePart">TnyMimePart</a> *part);

<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a>* <a href="libtinymail-tny-msg-view.html#tny-msg-view-create-new-inline-viewer">tny_msg_view_create_new_inline_viewer</a>

(<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);

</pre>

</div>

<a name="id2658562"></a><h2>Object Hierarchy</h2>

GInterface

+----TnyMsgView

</pre>

</div>

<a name="id2658587"></a><h2>Prerequisites</h2>

<p>

TnyMsgView requires

<a href="libtinymail-tny-mime-part-view.html#TnyMimePartView">TnyMimePartView</a>.</p>

</div>

<a name="id2658609"></a><h2>Known Derived Interfaces</h2>

<p>

TnyMsgView is required by

<a href="libtinymail-tny-msg-window.html#TnyMsgWindow">TnyMsgWindow</a>.</p>

</div>

<a name="id2658632"></a><h2>Known Implementations</h2>

100

<p>

101

TnyMsgView is implemented by

102

<a href="TnyMozEmbedMsgView.html" title="TnyMozEmbedMsgView">TnyMozEmbedMsgView</a>, <a href="TnyGtkMsgView.html" title="TnyGtkMsgView">TnyGtkMsgView</a> and <a href="TnyGtkMsgWindow.html" title="TnyGtkMsgWindow">TnyGtkMsgWindow</a>.</p>

103

</div>

104

105

<a name="id2658669"></a><h2>Description</h2>

106

<p>

107

A type that defines a view for a <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a> implementation. The type is sometimes decorated by a

108

<a href="libtinymail-tny-msg-window.html#TnyMsgWindow"><span class="type">TnyMsgWindow</span></a> implementation.

109

</p>

110

</div>

111

112

<a name="id2658702"></a><h2>Details</h2>

113

114

115

<a name="TnyMsgView-struct"></a>TnyMsgView</h3>

116

<a class="indexterm" name="id2658725"></a><pre class="programlisting">typedef struct _TnyMsgView TnyMsgView;</pre>

117

<p>

118

119

</p>

120

</div>

121

<hr>

122

123

124

<a name="TnyMsgViewIface"></a>TnyMsgViewIface</h3>

125

<a class="indexterm" name="id2658753"></a><pre class="programlisting">typedef struct {

126

GTypeInterface parent;

127

128

TnyMsg* (*get_msg_func) (TnyMsgView *self);

129

void (*set_msg_func) (TnyMsgView *self, TnyMsg *msg);

130

void (*set_unavailable_func) (TnyMsgView *self);

131

void (*clear_func) (TnyMsgView *self);

132

TnyMimePartView* (*create_mime_part_view_for_func) (TnyMsgView *self, TnyMimePart *part);

133

TnyMsgView* (*create_new_inline_viewer_func) (TnyMsgView *self);

134

} TnyMsgViewIface;

135

</pre>

136

<p>

137

138

</p>

139

</div>

140

<hr>

141

142

143

144

<a class="indexterm" name="id2658788"></a><pre class="programlisting"><a href="libtinymail-tny-msg.html#TnyMsg">TnyMsg</a>* tny_msg_view_get_msg (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);</pre>

145

<p>

146

Get the current message of <em class="parameter"><code>self</code></em>. If <em class="parameter"><code>self</code></em> is not displaying any message,

147

NULL will be returned. Else the return value must be unreferenced after use.

148

</p>

149

<p>

150

Implementors: this method should return the mime part this view is currently

151

viewing. It must add a reference to the instance before returning it. If the

152

view isn't viewing any mime part, it must return NULL.

153

</p>

154

<p>

155

Usually this method is an alias for tny_mime_part_view_get_part of

156

<a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a></p>

157

<p>

158

159

</p>

160

161

162

<tbody>

163

<tr>

164

165

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

166

</td>

167

</tr>

168

<tr>

169

<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

170

<td> A <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a> instance or NULL

171

</td>

172

</tr>

173

</tbody>

174

</table></div>

175

</div>

176

<hr>

177

178

179

180

<a class="indexterm" name="id2658910"></a><pre class="programlisting">void tny_msg_view_set_msg (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self,

181

<a href="libtinymail-tny-msg.html#TnyMsg">TnyMsg</a> *msg);</pre>

182

<p>

183

Set the message which view <em class="parameter"><code>self</code></em> must display.

184

</p>

185

<p>

186

Implementors: this method should cause <em class="parameter"><code>self</code></em> to show <em class="parameter"><code>msg</code></em> to the user.

187

This includes showing the header (for which you can make a composition with

188

a <a href="libtinymail-tny-header-view.html#TnyHeaderView"><span class="type">TnyHeaderView</span></a>), the message body and the attachments (for which you

189

typically use the <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a> interface and implementations).

190

</p>

191

<p>

192

You can get a list of mime parts using the tny_mime_part_get_parts API of

193

the <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a> type. You can use the tny_msg_view_create_mime_part_view_for

194

API to get an instance of a <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a> that can view the mime part.

195

</p>

196

<p>

197

Usually this method is an alias or decorator for tny_mime_part_view_set_part

198

of <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a>

199

</p>

200

<p>

201

Example:

202

</p>

203

204

static void

205

tny_my_msg_view_set_msg (TnyMsgView *self, TnyMsg *msg)

206

{

207

TnyIterator *iterator;

208

TnyList *list = tny_simple_list_new ();

209

tny_msg_view_clear (self);

210

header = tny_msg_get_header (msg);

211

tny_header_view_set_header (priv->headerview, header);

212

g_object_unref (G_OBJECT (header));

213

tny_mime_part_view_set_part (TNY_MIME_PART_VIEW (self),

214

TNY_MIME_PART (msg));

215

tny_mime_part_get_parts (TNY_MIME_PART (msg), list);

216

iterator = tny_list_create_iterator (list);

217

while (!tny_iterator_is_done (iterator))

218

{

219

TnyMimePart *part = tny_iterator_get_current (iterator);

220

TnyMimePartView *mpview;

221

mpview = tny_msg_view_create_mime_part_view_for (self, part);

222

if (mpview)

223

tny_mime_part_view_set_part (mpview, part);

224

g_object_unref (G_OBJECT(part));

225

tny_iterator_next (iterator);

226

}

227

g_object_unref (G_OBJECT (iterator));

228

g_object_unref (G_OBJECT (list));

229

}

230

</pre></div>

231

<p>

232

</p>

233

<p>

234

ps. For a real and complete working example take a look at the implementation of

235

<a href="TnyGtkMsgView.html" title="TnyGtkMsgView"><span class="type">TnyGtkMsgView</span></a> in libtinymailui-gtk.</p>

236

<p>

237

238

</p>

239

240

241

<tbody>

242

<tr>

243

244

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

245

</td>

246

</tr>

247

<tr>

248

249

<td> A <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a> instace

250

</td>

251

</tr>

252

</tbody>

253

</table></div>

254

</div>

255

<hr>

256

257

258

<a name="tny-msg-view-clear"></a>tny_msg_view_clear ()</h3>

259

<a class="indexterm" name="id2659144"></a><pre class="programlisting">void tny_msg_view_clear (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);</pre>

260

<p>

261

Clear <em class="parameter"><code>self</code></em> (show nothing)

262

</p>

263

<p>

264

Implementors: this method should clear <em class="parameter"><code>self</code></em> (display nothing and clearup)</p>

265

<p>

266

267

</p>

268

269

270

271

272

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

273

</td>

274

</tr></tbody>

275

</table></div>

276

</div>

277

<hr>

278

279

280

<a name="tny-msg-view-set-unavailable"></a>tny_msg_view_set_unavailable ()</h3>

281

<a class="indexterm" name="id2659231"></a><pre class="programlisting">void tny_msg_view_set_unavailable (<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);</pre>

282

<p>

283

Set <em class="parameter"><code>self</code></em> to display that a message was unavailable

284

</p>

285

<p>

286

Implementors: this method should set <em class="parameter"><code>self</code></em> to display a message like

287

"Message unavailable" or trigger another indication that a specific message

288

isn't available.</p>

289

<p>

290

291

</p>

292

293

294

295

296

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

297

</td>

298

</tr></tbody>

299

</table></div>

300

</div>

301

<hr>

302

303

304

<a name="tny-msg-view-create-mime-part-view-for"></a>tny_msg_view_create_mime_part_view_for ()</h3>

305

<a class="indexterm" name="id2659322"></a><pre class="programlisting"><a href="libtinymail-tny-mime-part-view.html#TnyMimePartView">TnyMimePartView</a>* tny_msg_view_create_mime_part_view_for

306

(<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self,

307

<a href="libtinymail-tny-mime-part.html#TnyMimePart">TnyMimePart</a> *part);</pre>

308

<p>

309

Create a <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a> instance for viewing <em class="parameter"><code>part</code></em>. The returned instance

310

must be unreferenced after use.

311

</p>

312

<p>

313

Implementors: This method should create and return a new <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a>

314

that is suitable for displaying <em class="parameter"><code>part</code></em>.

315

</p>

316

<p>

317

Example:

318

</p>

319

320

static TnyMimePartView*

321

tny_my_html_msg_view_create_mime_part_view_for (TnyMsgView *self, TnyMimePart *part)

322

{

323

TnyMimePartView *retval = NULL;

324

g_assert (TNY_IS_MIME_PART (part));

325

if (tny_mime_part_content_type_is (part, "text/html"))

326

{

327

GtkWidget *widget = (GtkWidget *) self;

328

retval = tny_my_html_mime_part_view_new ();

329

} else

330

retval = TNY_GTK_MSG_VIEW_CLASS (parent_class)->create_mime_part_view_for_func (self, part);

331

return retval;

332

}

333

</pre></div>

334

<p>

335

</p>

336

<p>

337

ps. For a real and complete working example take a look at the implementation of

338

<a href="TnyMozEmbedMsgView.html" title="TnyMozEmbedMsgView"><span class="type">TnyMozEmbedMsgView</span></a> in libtinymailui-mozembed.</p>

339

<p>

340

341

</p>

342

343

344

<tbody>

345

<tr>

346

347

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

348

</td>

349

</tr>

350

<tr>

351

352

<td> A <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a> instance

353

</td>

354

</tr>

355

<tr>

356

<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

357

<td> A <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a> instance for viewing <em class="parameter"><code>part</code></em>

358

</td>

359

</tr>

360

</tbody>

361

</table></div>

362

</div>

363

<hr>

364

365

366

<a name="tny-msg-view-create-new-inline-viewer"></a>tny_msg_view_create_new_inline_viewer ()</h3>

367

<a class="indexterm" name="id2659522"></a><pre class="programlisting"><a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a>* tny_msg_view_create_new_inline_viewer

368

(<a href="libtinymail-tny-msg-view.html#TnyMsgView">TnyMsgView</a> *self);</pre>

369

<p>

370

Create a new <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> that can be used to display an inline message.

371

Usually it will return a new instance of the same type as <em class="parameter"><code>self</code></em>. The

372

returned instance must be unreferenced after use.

373

</p>

374

<p>

375

Implementors: This method should create and return a new <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

376

usually of the same type as <em class="parameter"><code>self</code></em>. This method will be used when a

377

<a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> needs to create a <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance for displaying inlined

378

messages (like what message/rfc822 mime parts are). For example the

379

<a href="TnyGtkMsgView.html" title="TnyGtkMsgView"><span class="type">TnyGtkMsgView</span></a> implementation will use this method to create for itself a

380

new <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance that it can embed in itself.

381

</p>

382

<p>

383

Example:

384

</p>

385

386

static TnyMsgView*

387

tny_my_html_msg_view_create_new_inline_viewer (TnyMsgView *self)

388

{

389

return tny_my_html_msg_view_new ();

390

}

391

</pre></div>

392

<p>

393

</p>

394

<p>

395

Note that if you want to pass contructor parameters, that you will have to

396

store them yourself (for example in a static global field in the .c file) and

397

repeat them in the new instance that will be created by this method.</p>

398

<p>

399

400

</p>

401

402

403

<tbody>

404

<tr>

405

406

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

407

</td>

408

</tr>

409

<tr>

410

<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

411

<td> A <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> instance

412

</td>

413

</tr>

414

</tbody>

415

</table></div>

416

</div>

417

</div>

418

419

420

<p>

421

<a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a>, <span class="type">TnyMsgMimePart</span>, <a href="libtinymail-tny-msg-window.html#TnyMsgWindow"><span class="type">TnyMsgWindow</span></a>, <a href="TnyGtkMsgView.html" title="TnyGtkMsgView"><span class="type">TnyGtkMsgView</span></a>, <a href="TnyGtkMsgWindow.html" title="TnyGtkMsgWindow"><span class="type">TnyGtkMsgWindow</span></a>

422

</p>

423

</div>

424

</div>

425

</body>

426

</html>

Older »