Communi  3.5.0
A cross-platform IRC framework written with Qt
Public Types | Static Public Member Functions | Properties | List of all members
Irc Class Reference

Miscellaneous identifiers used throughout the library.

Inherits QObject.

Public Types

Static Public Member Functions

static Q_INVOKABLE QString codeToString (int code)
 
static Q_INVOKABLE QString hostFromPrefix (const QString &prefix)
 
static Q_INVOKABLE QString identFromPrefix (const QString &prefix)
 
static Q_INVOKABLE QString nickFromPrefix (const QString &prefix)
 
static Q_INVOKABLE void registerMetaTypes ()
 
static Q_INVOKABLE QString version ()
 

Properties

bool secureSupported
 
QStringList supportedCapabilities
 
QStringList supportedSaslMechanisms
 

Member Enumeration Documentation

enum Irc::Code

The command responses and error replies as defined in RFC 1459, RFC 2812, and various IRCd specific extensions.

Enumerator
RPL_WELCOME 

1

RPL_YOURHOST 

2

RPL_CREATED 

3

RPL_MYINFO 

4

RPL_ISUPPORT 

5

RPL_SNOMASK 

8

RPL_STATMEMTOT 

9

RPL_BOUNCE 

10

RPL_STATMEM 

10

RPL_YOURCOOKIE 

14

RPL_YOURID 

42

RPL_SAVENICK 

43

RPL_ATTEMPTINGJUNC 

50

RPL_ATTEMPTINGREROUTE 

51

RPL_TRACELINK 

200

RPL_TRACECONNECTING 

201

RPL_TRACEHANDSHAKE 

202

RPL_TRACEUNKNOWN 

203

RPL_TRACEOPERATOR 

204

RPL_TRACEUSER 

205

RPL_TRACESERVER 

206

RPL_TRACESERVICE 

207

RPL_TRACENEWTYPE 

208

RPL_TRACECLASS 

209

RPL_TRACERECONNECT 

210

RPL_STATS 

210

RPL_STATSLINKINFO 

211

RPL_STATSCOMMANDS 

212

RPL_STATSCLINE 

213

RPL_STATSNLINE 

214

RPL_STATSILINE 

215

RPL_STATSKLINE 

216

RPL_STATSQLINE 

217

RPL_STATSYLINE 

218

RPL_ENDOFSTATS 

219

RPL_UMODEIS 

221

RPL_MODLIST 

222

RPL_SQLINE_NICK 

222

RPL_STATSZLINE 

225

RPL_STATSCOUNT 

226

RPL_SERVICEINFO 

231

RPL_ENDOFSERVICES 

232

RPL_SERVICE 

233

RPL_SERVLIST 

234

RPL_SERVLISTEND 

235

RPL_STATSVERBOSE 

236

RPL_STATSENGINE 

237

RPL_STATSIAUTH 

239

RPL_STATSVLINE 

240

RPL_STATSLLINE 

241

RPL_STATSUPTIME 

242

RPL_STATSOLINE 

243

RPL_STATSHLINE 

244

RPL_STATSSLINE 

245

RPL_STATSPING 

246

RPL_STATSBLINE 

247

RPL_STATSDEFINE 

248

RPL_STATSDEBUG 

249

RPL_STATSDLINE 

250

RPL_STATSCONN 

250

RPL_LUSERCLIENT 

251

RPL_LUSEROP 

252

RPL_LUSERUNKNOWN 

253

RPL_LUSERCHANNELS 

254

RPL_LUSERME 

255

RPL_ADMINME 

256

RPL_ADMINLOC1 

257

RPL_ADMINLOC2 

258

RPL_ADMINEMAIL 

259

RPL_TRACELOG 

261

RPL_TRACEPING 

262

RPL_TRACEEND 

262

RPL_TRYAGAIN 

263

RPL_LOCALUSERS 

265

RPL_GLOBALUSERS 

266

RPL_START_NETSTAT 

267

RPL_NETSTAT 

268

RPL_END_NETSTAT 

269

RPL_PRIVS 

270

RPL_SILELIST 

271

RPL_ENDOFSILELIST 

272

RPL_NOTIFY 

273

RPL_ENDNOTIFY 

274

RPL_STATSDELTA 

274

RPL_VCHANEXIST 

276

RPL_VCHANLIST 

277

RPL_VCHANHELP 

278

RPL_GLIST 

280

RPL_ENDOFGLIST 

281

RPL_ACCEPTLIST 

281

RPL_ENDOFACCEPT 

282

RPL_JUPELIST 

282

RPL_ENDOFJUPELIST 

283

RPL_FEATURE 

284

RPL_GLIST_HASH 

285

RPL_CHANINFO_HANDLE 

285

RPL_NEWHOSTIS 

285

RPL_CHANINFO_USERS 

286

RPL_CHKHEAD 

286

RPL_CHANINFO_CHOPS 

287

RPL_CHANUSER 

287

RPL_CHANINFO_VOICES 

288

RPL_PATCHHEAD 

288

RPL_CHANINFO_AWAY 

289

RPL_PATCHCON 

289

RPL_CHANINFO_OPERS 

290

RPL_HELPHDR 

290

RPL_DATASTR 

290

RPL_CHANINFO_BANNED 

291

RPL_HELPOP 

291

RPL_ENDOFCHECK 

291

RPL_CHANINFO_BANS 

292

RPL_HELPTLR 

292

RPL_CHANINFO_INVITE 

293

RPL_HELPHLP 

293

RPL_CHANINFO_INVITES 

294

RPL_HELPFWD 

294

RPL_CHANINFO_KICK 

295

RPL_HELPIGN 

295

RPL_CHANINFO_KICKS 

296

RPL_END_CHANINFO 

299

RPL_NONE 

300

RPL_AWAY 

301

RPL_USERHOST 

302

RPL_ISON 

303

RPL_TEXT 

304

RPL_UNAWAY 

305

RPL_NOWAWAY 

306

RPL_WHOISREGNICK 

307

RPL_SUSERHOST 

307

RPL_NOTIFYACTION 

308

RPL_WHOISADMIN 

308

RPL_NICKTRACE 

309

RPL_WHOISSADMIN 

309

RPL_WHOISHELPER 

309

RPL_WHOISSVCMSG 

310

RPL_WHOISHELPOP 

310

RPL_WHOISSERVICE 

310

RPL_WHOISUSER 

311

RPL_WHOISSERVER 

312

RPL_WHOISOPERATOR 

313

RPL_WHOWASUSER 

314

RPL_ENDOFWHO 

315

RPL_WHOISCHANOP 

316

RPL_WHOISIDLE 

317

RPL_ENDOFWHOIS 

318

RPL_WHOISCHANNELS 

319

RPL_WHOISVIRT 

320

RPL_WHOIS_HIDDEN 

320

RPL_WHOISSPECIAL 

320

RPL_LISTSTART 

321

RPL_LIST 

322

RPL_LISTEND 

323

RPL_CHANNELMODEIS 

324

RPL_UNIQOPIS 

325

RPL_CHANNELPASSIS 

325

RPL_NOCHANPASS 

326

RPL_CHPASSUNKNOWN 

327

RPL_CHANNEL_URL 

328

RPL_CREATIONTIME 

329

RPL_WHOWAS_TIME 

330

RPL_WHOISACCOUNT 

330

RPL_NOTOPIC 

331

RPL_TOPIC 

332

RPL_TOPICWHOTIME 

333

RPL_LISTUSAGE 

334

RPL_COMMANDSYNTAX 

334

RPL_LISTSYNTAX 

334

RPL_CHANPASSOK 

338

RPL_WHOISACTUALLY 

338

RPL_BADCHANPASS 

339

RPL_INVITING 

341

RPL_SUMMONING 

342

RPL_INVITED 

345

RPL_INVITELIST 

346

RPL_ENDOFINVITELIST 

347

RPL_EXCEPTLIST 

348

RPL_ENDOFEXCEPTLIST 

349

RPL_VERSION 

351

RPL_WHOREPLY 

352

RPL_NAMREPLY 

353

RPL_WHOSPCRPL 

354

RPL_NAMREPLY_ 

355

RPL_KILLDONE 

361

RPL_CLOSING 

362

RPL_CLOSEEND 

363

RPL_LINKS 

364

RPL_ENDOFLINKS 

365

RPL_ENDOFNAMES 

366

RPL_BANLIST 

367

RPL_ENDOFBANLIST 

368

RPL_ENDOFWHOWAS 

369

RPL_INFO 

371

RPL_MOTD 

372

RPL_INFOSTART 

373

RPL_ENDOFINFO 

374

RPL_MOTDSTART 

375

RPL_ENDOFMOTD 

376

RPL_KICKEXPIRED 

377

RPL_SPAM 

377

RPL_BANEXPIRED 

378

RPL_WHOISHOST 

378

RPL_KICKLINKED 

379

RPL_WHOISMODES 

379

RPL_BANLINKED 

380

RPL_YOURHELPER 

380

RPL_YOUREOPER 

381

RPL_REHASHING 

382

RPL_YOURESERVICE 

383

RPL_MYPORTIS 

384

RPL_NOTOPERANYMORE 

385

RPL_QLIST 

386

RPL_IRCOPS 

386

RPL_ENDOFQLIST 

387

RPL_ENDOFIRCOPS 

387

RPL_ALIST 

388

RPL_ENDOFALIST 

389

RPL_TIME 

391

RPL_USERSSTART 

392

RPL_USERS 

393

RPL_ENDOFUSERS 

394

RPL_NOUSERS 

395

RPL_HOSTHIDDEN 

396

ERR_UNKNOWNERROR 

400

ERR_NOSUCHNICK 

401

ERR_NOSUCHSERVER 

402

ERR_NOSUCHCHANNEL 

403

ERR_CANNOTSENDTOCHAN 

404

ERR_TOOMANYCHANNELS 

405

ERR_WASNOSUCHNICK 

406

ERR_TOOMANYTARGETS 

407

ERR_NOSUCHSERVICE 

408

ERR_NOCOLORSONCHAN 

408

ERR_NOORIGIN 

409

ERR_NORECIPIENT 

411

ERR_NOTEXTTOSEND 

412

ERR_NOTOPLEVEL 

413

ERR_WILDTOPLEVEL 

414

ERR_BADMASK 

415

ERR_TOOMANYMATCHES 

416

ERR_QUERYTOOLONG 

416

ERR_LENGTHTRUNCATED 

419

ERR_UNKNOWNCOMMAND 

421

ERR_NOMOTD 

422

ERR_NOADMININFO 

423

ERR_FILEERROR 

424

ERR_NOOPERMOTD 

425

ERR_TOOMANYAWAY 

429

ERR_EVENTNICKCHANGE 

430

ERR_NONICKNAMEGIVEN 

431

ERR_ERRONEUSNICKNAME 

432

ERR_NICKNAMEINUSE 

433

ERR_SERVICENAMEINUSE 

434

ERR_NORULES 

434

ERR_SERVICECONFUSED 

435

ERR_BANONCHAN 

435

ERR_NICKCOLLISION 

436

ERR_UNAVAILRESOURCE 

437

ERR_BANNICKCHANGE 

437

ERR_NICKTOOFAST 

438

ERR_DEAD 

438

ERR_TARGETTOOFAST 

439

ERR_SERVICESDOWN 

440

ERR_USERNOTINCHANNEL 

441

ERR_NOTONCHANNEL 

442

ERR_USERONCHANNEL 

443

ERR_NOLOGIN 

444

ERR_SUMMONDISABLED 

445

ERR_USERSDISABLED 

446

ERR_NONICKCHANGE 

447

ERR_NOTIMPLEMENTED 

449

ERR_NOTREGISTERED 

451

ERR_IDCOLLISION 

452

ERR_NICKLOST 

453

ERR_HOSTILENAME 

455

ERR_ACCEPTFULL 

456

ERR_ACCEPTEXIST 

457

ERR_ACCEPTNOT 

458

ERR_NOHIDING 

459

ERR_NOTFORHALFOPS 

460

ERR_NEEDMOREPARAMS 

461

ERR_ALREADYREGISTERED 

462

ERR_NOPERMFORHOST 

463

ERR_PASSWDMISMATCH 

464

ERR_YOUREBANNEDCREEP 

465

ERR_YOUWILLBEBANNED 

466

ERR_KEYSET 

467

ERR_INVALIDUSERNAME 

468

ERR_ONLYSERVERSCANCHANGE 

468

ERR_LINKSET 

469

ERR_LINKCHANNEL 

470

ERR_KICKEDFROMCHAN 

470

ERR_CHANNELISFULL 

471

ERR_UNKNOWNMODE 

472

ERR_INVITEONLYCHAN 

473

ERR_BANNEDFROMCHAN 

474

ERR_BADCHANNELKEY 

475

ERR_BADCHANMASK 

476

ERR_NOCHANMODES 

477

ERR_NEEDREGGEDNICK 

477

ERR_BANLISTFULL 

478

ERR_BADCHANNAME 

479

ERR_LINKFAIL 

479

ERR_NOULINE 

480

ERR_CANNOTKNOCK 

480

ERR_NOPRIVILEGES 

481

ERR_CHANOPRIVSNEEDED 

482

ERR_CANTKILLSERVER 

483

ERR_RESTRICTED 

484

ERR_ISCHANSERVICE 

484

ERR_DESYNC 

484

ERR_ATTACKDENY 

484

ERR_UNIQOPRIVSNEEDED 

485

ERR_KILLDENY 

485

ERR_CANTKICKADMIN 

485

ERR_ISREALSERVICE 

485

ERR_NONONREG 

486

ERR_HTMDISABLED 

486

ERR_ACCOUNTONLY 

486

ERR_CHANTOORECENT 

487

ERR_MSGSERVICES 

487

ERR_TSLESSCHAN 

488

ERR_VOICENEEDED 

489

ERR_SECUREONLYCHAN 

489

ERR_NOOPERHOST 

491

ERR_NOSERVICEHOST 

492

ERR_NOFEATURE 

493

ERR_BADFEATURE 

494

ERR_BADLOGTYPE 

495

ERR_BADLOGSYS 

496

ERR_BADLOGVALUE 

497

ERR_ISOPERLCHAN 

498

ERR_CHANOWNPRIVNEEDED 

499

ERR_UMODEUNKNOWNFLAG 

501

ERR_USERSDONTMATCH 

502

ERR_GHOSTEDCLIENT 

503

ERR_VWORLDWARN 

503

ERR_USERNOTONSERV 

504

ERR_SILELISTFULL 

511

ERR_TOOMANYWATCH 

512

ERR_BADPING 

513

ERR_INVALID_ERROR 

514

ERR_TOOMANYDCC 

514

ERR_BADEXPIRE 

515

ERR_DONTCHEAT 

516

ERR_DISABLED 

517

ERR_NOINVITE 

518

ERR_LONGMASK 

518

ERR_ADMONLY 

519

ERR_TOOMANYUSERS 

519

ERR_OPERONLY 

520

ERR_MASKTOOWIDE 

520

ERR_WHOTRUNC 

520

ERR_LISTSYNTAX 

521

ERR_WHOSYNTAX 

522

ERR_WHOLIMEXCEED 

523

ERR_QUARANTINED 

524

ERR_OPERSPVERIFY 

524

ERR_REMOTEPFX 

525

ERR_PFXUNROUTABLE 

526

ERR_BADHOSTMASK 

550

ERR_HOSTUNAVAIL 

551

ERR_USINGSLINE 

552

ERR_STATSSLINE 

553

RPL_LOGON 

600

RPL_LOGOFF 

601

RPL_WATCHOFF 

602

RPL_WATCHSTAT 

603

RPL_NOWON 

604

RPL_NOWOFF 

605

RPL_WATCHLIST 

606

RPL_ENDOFWATCHLIST 

607

RPL_WATCHCLEAR 

608

RPL_ISOPER 

610

RPL_ISLOCOP 

611

RPL_ISNOTOPER 

612

RPL_ENDOFISOPER 

613

RPL_DCCSTATUS 

617

RPL_DCCLIST 

618

RPL_ENDOFDCCLIST 

619

RPL_WHOWASHOST 

619

RPL_DCCINFO 

620

RPL_ENDOFO 

626

RPL_SETTINGS 

630

RPL_ENDOFSETTINGS 

631

RPL_DUMPING 

640

RPL_DUMPRPL 

641

RPL_EODUMP 

642

RPL_TRACEROUTE_HOP 

660

RPL_TRACEROUTE_START 

661

RPL_MODECHANGEWARN 

662

RPL_CHANREDIR 

663

RPL_SERVMODEIS 

664

RPL_OTHERUMODEIS 

665

RPL_ENDOF_GENERIC 

666

RPL_WHOWASDETAILS 

670

RPL_WHOISSECURE 

671

RPL_UNKNOWNMODES 

672

RPL_CANNOTSETMODES 

673

RPL_LUSERSTAFF 

678

RPL_TIMEONSERVERIS 

679

RPL_NETWORKS 

682

RPL_YOURLANGUAGEIS 

687

RPL_LANGUAGE 

688

RPL_WHOISSTAFF 

689

RPL_WHOISLANGUAGE 

690

RPL_HELPSTART 

704

RPL_HELPTXT 

705

RPL_ENDOFHELP 

706

RPL_ETRACEFULL 

708

RPL_ETRACE 

709

RPL_KNOCK 

710

RPL_KNOCKDLVR 

711

ERR_TOOMANYKNOCK 

712

ERR_CHANOPEN 

713

ERR_KNOCKONCHAN 

714

ERR_KNOCKDISABLED 

715

RPL_TARGUMODEG 

716

RPL_TARGNOTIFY 

717

RPL_UMODEGMSG 

718

RPL_ENDOFOMOTD 

722

ERR_NOPRIVS 

723

RPL_TESTMARK 

724

RPL_TESTLINE 

725

RPL_NOTESTLINE 

726

RPL_MONONLINE 

730

Since
3.4
RPL_MONOFFLINE 

731

Since
3.4
RPL_MONLIST 

732

Since
3.4
RPL_ENDOFMONLIST 

733

Since
3.4
RPL_XINFO 

771

RPL_XINFOSTART 

773

RPL_XINFOEND 

774

ERR_CANNOTDOCOMMAND 

972

ERR_CANNOTCHANGEUMODE 

973

ERR_CANNOTCHANGECHANMODE 

974

ERR_CANNOTCHANGESERVERMODE 

975

ERR_CANNOTSENDTONICK 

976

ERR_UNKNOWNSERVERMODE 

977

ERR_SERVERMODELOCK 

979

ERR_BADCHARENCODING 

980

ERR_TOOMANYLANGUAGES 

981

ERR_NOLANGUAGE 

982

ERR_TEXTTOOSHORT 

983

ERR_NUMERIC_ERR 

999

enum Irc::Color

This enum describes the (m)IRC colors.

The default values are SVG color keyword names provided by the World Wide Web Consortium

See also
IrcPalette
Enumerator
White 

The default value is "white".

Black 

The default value is "black".

Blue 

The default value is "blue".

Green 

The default value is "green".

Red 

The default value is "red".

Brown 

The default value is "brown".

Purple 

The default value is "purple".

Orange 

The default value is "orange".

Yellow 

The default value is "yellow".

LightGreen 

The default value is "lightgreen".

Cyan 

The default value is "cyan".

LightCyan 

The default value is "lightcyan".

LightBlue 

The default value is "lightblue".

Pink 

The default value is "pink".

Gray 

The default value is "gray".

LightGray 

The default value is "lightgray".

This enum describes the available model data roles.

See also
IrcBufferModel, IrcUserModel
Enumerator
UserRole 

User object (IrcUser*)

BufferRole 

Buffer object (IrcBuffer*)

ChannelRole 

Channel object (IrcChannel*)

NameRole 

Buffer/user name (QString)

PrefixRole 

Channel/user prefix (QString)

ModeRole 

User mode (QString)

TitleRole 

Channel/user prefix and name (QString)

This enum describes the available model sort methods.

See also
IrcBufferModel, IrcUserModel
Enumerator
SortByHand 

Sort by hand by calling sort()

SortByName 

Sort by name (Irc::NameRole)

SortByTitle 

Sort by title (Irc::TitleRole)

SortByActivity 

Sort by activity.

Member Function Documentation

QString Irc::codeToString ( int  code)
static

Returns the numeric code as a string or a null string if the code is unknown.

See also
Irc::Code, IrcNumericMessage::code()
QString Irc::hostFromPrefix ( const QString prefix)
static

Returns the host part of the specified prefix.

Host part of a prefix as specified in RFC 1459:

<nick> [ '!' <ident> ] [ '@' <host> ]
See also
IrcMessage::prefix, IrcMessage::host
QString Irc::identFromPrefix ( const QString prefix)
static

Returns the ident part of the specified prefix.

Ident part of a prefix as specified in RFC 1459:

<nick> [ '!' <ident> ] [ '@' <host> ]
See also
IrcMessage::prefix, IrcMessage::ident
QString Irc::nickFromPrefix ( const QString prefix)
static

Returns the nick part of the specified prefix.

Nick part of a prefix as specified in RFC 1459:

<nick> [ '!' <ident> ] [ '@' <host> ]
See also
IrcMessage::prefix, IrcMessage::nick
void Irc::registerMetaTypes ( )
static
QString Irc::version ( )
static

Returns the version number of Communi at run-time as a string (for example, "1.2.3"). This may be a different version than the version the application was compiled against.

See also
IRC_VERSION, IRC_VERSION_STR

Property Documentation

bool Irc::secureSupported
read
Since
3.5

This property holds whether SSL is supported.

The value may be false for the following reasons:

  • Qt was built without SSL support (QT_NO_SSL is defined), or
  • The platform does not support SSL (QSslSocket::supportsSsl() returns false).
Access function:
  • static bool isSecureSupported()
See also
IrcConnection::secure, QSslSocket::supportsSsl()
QStringList Irc::supportedCapabilities
read
Since
3.5

This property holds the list of supported capabilities.

These capabilities are guaranteed to be compatible with the framework. In order to easily enable all possible supported capabilities, assign Irc::supportedCapabilities to IrcNetwork::requestedCapabilities.

Access function:
See also
Capability management, IRCv3 support
QStringList Irc::supportedSaslMechanisms
read
Since
3.5

This property holds the list of supported SASL (Simple Authentication and Security Layer) mechanisms.

Access function:
See also
IrcConnection::saslMechanism, IRCv3 support