src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkWidget.html

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10427:3733e2b23cf7 10428:a071d4065202
229 <p> 229 <p>
230 Constructor 230 Constructor
231 </p> 231 </p>
232 <dl> 232 <dl>
233 233
234 <dt><i>parent</i></dt> 234 <dt><i>parent</i> (QWidget)</dt>
235 <dd> 235 <dd>
236 reference to the parent widget (QWidget) 236 reference to the parent widget
237 </dd> 237 </dd>
238 </dl> 238 </dl>
239 <a NAME="IrcNetworkWidget.__autoConnect" ID="IrcNetworkWidget.__autoConnect"></a> 239 <a NAME="IrcNetworkWidget.__autoConnect" ID="IrcNetworkWidget.__autoConnect"></a>
240 <h4>IrcNetworkWidget.__autoConnect</h4> 240 <h4>IrcNetworkWidget.__autoConnect</h4>
241 <b>__autoConnect</b>(<i></i>) 241 <b>__autoConnect</b>(<i></i>)
316 <p> 316 <p>
317 Public method to add an error message. 317 Public method to add an error message.
318 </p> 318 </p>
319 <dl> 319 <dl>
320 320
321 <dt><i>msgType</i></dt> 321 <dt><i>msgType</i> (str)</dt>
322 <dd> 322 <dd>
323 txpe of the message (string) 323 txpe of the message
324 </dd> 324 </dd>
325 <dt><i>msg</i></dt> 325 <dt><i>msg</i> (str)</dt>
326 <dd> 326 <dd>
327 message to be added (string) 327 message to be added
328 </dd> 328 </dd>
329 </dl> 329 </dl>
330 <a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a> 330 <a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
331 <h4>IrcNetworkWidget.addMessage</h4> 331 <h4>IrcNetworkWidget.addMessage</h4>
332 <b>addMessage</b>(<i>msg</i>) 332 <b>addMessage</b>(<i>msg</i>)
334 <p> 334 <p>
335 Public method to add a message. 335 Public method to add a message.
336 </p> 336 </p>
337 <dl> 337 <dl>
338 338
339 <dt><i>msg</i></dt> 339 <dt><i>msg</i> (str)</dt>
340 <dd> 340 <dd>
341 message to be added (string) 341 message to be added
342 </dd> 342 </dd>
343 </dl> 343 </dl>
344 <a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a> 344 <a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
345 <h4>IrcNetworkWidget.addServerMessage</h4> 345 <h4>IrcNetworkWidget.addServerMessage</h4>
346 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>) 346 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>)
348 <p> 348 <p>
349 Public method to add a server message. 349 Public method to add a server message.
350 </p> 350 </p>
351 <dl> 351 <dl>
352 352
353 <dt><i>msgType</i></dt> 353 <dt><i>msgType</i> (str)</dt>
354 <dd> 354 <dd>
355 txpe of the message (string) 355 txpe of the message
356 </dd> 356 </dd>
357 <dt><i>msg</i></dt> 357 <dt><i>msg</i> (str)</dt>
358 <dd> 358 <dd>
359 message to be added (string) 359 message to be added
360 </dd> 360 </dd>
361 <dt><i>filterMsg</i></dt> 361 <dt><i>filterMsg</i> (bool)</dt>
362 <dd> 362 <dd>
363 flag indicating to filter the message (boolean) 363 flag indicating to filter the message
364 </dd> 364 </dd>
365 </dl> 365 </dl>
366 <a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a> 366 <a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
367 <h4>IrcNetworkWidget.autoConnect</h4> 367 <h4>IrcNetworkWidget.autoConnect</h4>
368 <b>autoConnect</b>(<i></i>) 368 <b>autoConnect</b>(<i></i>)
379 selected network. 379 selected network.
380 </p> 380 </p>
381 <dl> 381 <dl>
382 <dt>Return:</dt> 382 <dt>Return:</dt>
383 <dd> 383 <dd>
384 associated channels (list of IrcChannel) 384 associated channels
385 </dd>
386 </dl>
387 <dl>
388 <dt>Return Type:</dt>
389 <dd>
390 list of IrcChannel
385 </dd> 391 </dd>
386 </dl> 392 </dl>
387 <a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a> 393 <a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
388 <h4>IrcNetworkWidget.getNickname</h4> 394 <h4>IrcNetworkWidget.getNickname</h4>
389 <b>getNickname</b>(<i></i>) 395 <b>getNickname</b>(<i></i>)
392 Public method to get the currently selected nick name. 398 Public method to get the currently selected nick name.
393 </p> 399 </p>
394 <dl> 400 <dl>
395 <dt>Return:</dt> 401 <dt>Return:</dt>
396 <dd> 402 <dd>
397 selected nick name (string) 403 selected nick name
404 </dd>
405 </dl>
406 <dl>
407 <dt>Return Type:</dt>
408 <dd>
409 str
398 </dd> 410 </dd>
399 </dl> 411 </dl>
400 <a NAME="IrcNetworkWidget.handleAwayCommand" ID="IrcNetworkWidget.handleAwayCommand"></a> 412 <a NAME="IrcNetworkWidget.handleAwayCommand" ID="IrcNetworkWidget.handleAwayCommand"></a>
401 <h4>IrcNetworkWidget.handleAwayCommand</h4> 413 <h4>IrcNetworkWidget.handleAwayCommand</h4>
402 <b>handleAwayCommand</b>(<i>awayMessage</i>) 414 <b>handleAwayCommand</b>(<i>awayMessage</i>)
418 <p> 430 <p>
419 Public method to initialize the widget. 431 Public method to initialize the widget.
420 </p> 432 </p>
421 <dl> 433 <dl>
422 434
423 <dt><i>manager</i></dt> 435 <dt><i>manager</i> (IrcNetworkManager)</dt>
424 <dd> 436 <dd>
425 reference to the network manager (IrcNetworkManager) 437 reference to the network manager
426 </dd> 438 </dd>
427 </dl> 439 </dl>
428 <a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a> 440 <a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a>
429 <h4>IrcNetworkWidget.isConnected</h4> 441 <h4>IrcNetworkWidget.isConnected</h4>
430 <b>isConnected</b>(<i></i>) 442 <b>isConnected</b>(<i></i>)
433 Public method to check, if the network is connected. 445 Public method to check, if the network is connected.
434 </p> 446 </p>
435 <dl> 447 <dl>
436 <dt>Return:</dt> 448 <dt>Return:</dt>
437 <dd> 449 <dd>
438 flag indicating a connected network (boolean) 450 flag indicating a connected network
451 </dd>
452 </dl>
453 <dl>
454 <dt>Return Type:</dt>
455 <dd>
456 bool
439 </dd> 457 </dd>
440 </dl> 458 </dl>
441 <a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a> 459 <a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
442 <h4>IrcNetworkWidget.on_awayButton_clicked</h4> 460 <h4>IrcNetworkWidget.on_awayButton_clicked</h4>
443 <b>on_awayButton_clicked</b>(<i></i>) 461 <b>on_awayButton_clicked</b>(<i></i>)
452 <p> 470 <p>
453 Private slot to react upon changes of the channel. 471 Private slot to react upon changes of the channel.
454 </p> 472 </p>
455 <dl> 473 <dl>
456 474
457 <dt><i>txt</i></dt> 475 <dt><i>txt</i> (str)</dt>
458 <dd> 476 <dd>
459 current text of the channel combo (string) 477 current text of the channel combo
460 </dd> 478 </dd>
461 </dl> 479 </dl>
462 <a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a> 480 <a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
463 <h4>IrcNetworkWidget.on_connectButton_clicked</h4> 481 <h4>IrcNetworkWidget.on_connectButton_clicked</h4>
464 <b>on_connectButton_clicked</b>(<i></i>) 482 <b>on_connectButton_clicked</b>(<i></i>)
487 <p> 505 <p>
488 Private slot to open links in the default browser. 506 Private slot to open links in the default browser.
489 </p> 507 </p>
490 <dl> 508 <dl>
491 509
492 <dt><i>url</i></dt> 510 <dt><i>url</i> (QUrl)</dt>
493 <dd> 511 <dd>
494 URL to be opened (QUrl) 512 URL to be opened
495 </dd> 513 </dd>
496 </dl> 514 </dl>
497 <a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a> 515 <a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
498 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4> 516 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4>
499 <b>on_messages_copyAvailable</b>(<i>yes</i>) 517 <b>on_messages_copyAvailable</b>(<i>yes</i>)
502 Private slot to react to text selection/deselection of the 520 Private slot to react to text selection/deselection of the
503 messages edit. 521 messages edit.
504 </p> 522 </p>
505 <dl> 523 <dl>
506 524
507 <dt><i>yes</i></dt> 525 <dt><i>yes</i> (bool)</dt>
508 <dd> 526 <dd>
509 flag signaling the availability of selected text (boolean) 527 flag signaling the availability of selected text
510 </dd> 528 </dd>
511 </dl> 529 </dl>
512 <a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a> 530 <a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
513 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4> 531 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4>
514 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>) 532 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
516 <p> 534 <p>
517 Private slot to show the context menu of the messages pane. 535 Private slot to show the context menu of the messages pane.
518 </p> 536 </p>
519 <dl> 537 <dl>
520 538
521 <dt><i>pos</i></dt> 539 <dt><i>pos</i> (QPoint)</dt>
522 <dd> 540 <dd>
523 position the menu should be opened at (QPoint) 541 position the menu should be opened at
524 </dd> 542 </dd>
525 </dl> 543 </dl>
526 <a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a> 544 <a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
527 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4> 545 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4>
528 <b>on_networkCombo_currentIndexChanged</b>(<i>index</i>) 546 <b>on_networkCombo_currentIndexChanged</b>(<i>index</i>)
544 <p> 562 <p>
545 Private slot to use another nick name. 563 Private slot to use another nick name.
546 </p> 564 </p>
547 <dl> 565 <dl>
548 566
549 <dt><i>nick</i></dt> 567 <dt><i>nick</i> (int)</dt>
550 <dd> 568 <dd>
551 index of the selected nick name (unused) 569 index of the selected nick name (unused)
552 </dd> 570 </dd>
553 </dl> 571 </dl>
554 <a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a> 572 <a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a>
558 <p> 576 <p>
559 Public slot to set the connection state. 577 Public slot to set the connection state.
560 </p> 578 </p>
561 <dl> 579 <dl>
562 580
563 <dt><i>connected</i></dt> 581 <dt><i>connected</i> (bool)</dt>
564 <dd> 582 <dd>
565 flag indicating the connection state (boolean) 583 flag indicating the connection state
566 </dd> 584 </dd>
567 </dl> 585 </dl>
568 <a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a> 586 <a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
569 <h4>IrcNetworkWidget.setNickName</h4> 587 <h4>IrcNetworkWidget.setNickName</h4>
570 <b>setNickName</b>(<i>nick</i>) 588 <b>setNickName</b>(<i>nick</i>)
572 <p> 590 <p>
573 Public slot to set the nick name in use. 591 Public slot to set the nick name in use.
574 </p> 592 </p>
575 <dl> 593 <dl>
576 594
577 <dt><i>nick</i></dt> 595 <dt><i>nick</i> (str)</dt>
578 <dd> 596 <dd>
579 nick name in use (string) 597 nick name in use
580 </dd> 598 </dd>
581 </dl> 599 </dl>
582 <a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a> 600 <a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
583 <h4>IrcNetworkWidget.setRegistered</h4> 601 <h4>IrcNetworkWidget.setRegistered</h4>
584 <b>setRegistered</b>(<i>registered</i>) 602 <b>setRegistered</b>(<i>registered</i>)
586 <p> 604 <p>
587 Public slot to set the registered state. 605 Public slot to set the registered state.
588 </p> 606 </p>
589 <dl> 607 <dl>
590 608
591 <dt><i>registered</i></dt> 609 <dt><i>registered</i> (bool)</dt>
592 <dd> 610 <dd>
593 flag indicating the registration state (boolean) 611 flag indicating the registration state
594 </dd> 612 </dd>
595 </dl> 613 </dl>
596 <div align="right"><a href="#top">Up</a></div> 614 <div align="right"><a href="#top">Up</a></div>
597 <hr /> 615 <hr />
598 </body></html> 616 </body></html>

eric ide

mercurial